Top
ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)
ServerView

15.14.2 For Scripts of Operation Ruleset

Create a parameter file for scripts of an operation ruleset at the following location:

[Windows Manager]
Installation_folder\SVROR\Manager\etc\scripts\vendor_name\unit_name or model_name\operations\ruleset_name\default_param.prm

[Linux Manager]
/etc/opt/FJSVrcvmr/scripts/vendor_name/unit_name or model_name/operations/ruleset_name/default_param.prm


The changeable XML definition to be used by the ruleset script for operations is shown below.

<?xml version="1.0" encoding="utf-8"?>
<RulesetParameter>
  <Ruleset name="Ruleset_name"> type="SLB" category="operation" action="Ruleset_action">
    <Tenant>Tenant Name</Tenant>
    <RulesetDescription>Ruleset Description</RulesetDescription>
  </Ruleset>
  <Parameters>
    <Parameter name="Parameter Variable1" label="Parameter Variable Display Name1" view="display existence">
      <Syntax>Syntax</Syntax>
      <Value>Parameter Value1</Value>
      <ParameterDescription>Parameter Description1</ParameterDescription>
    </Parameter>
    <Parameter name="Parameter Variable2" label="Parameter Variable Display Name2" view="display existence">
      <Syntax>Syntax</Syntax>
      <Value>Parameter Value2</Value>
      <ParameterDescription>Parameter Description2</ParameterDescription>
    </Parameter>
    ...
  </Parameters>
</RulesetParameter>
Table 15.24 List of Specified XML Items for Parameter Information to be Handed Over to Scripts of Operation Ruleset

Element Name

Description

Remarks (Possible Values, Examples)

Ruleset name

(Ruleset name)

Name of the ruleset

Specify a character string up to 32 characters.

Ruleset type

(type)

The type of network devices for which the ruleset can be used

Specify the network device type, "SLB".

Ruleset category

(category)

Ruleset category

Specify "operation" for the ruleset category.

Ruleset action

(action)

Action of the operation ruleset

Changes available user privileges according to the action of the operation ruleset.

Specify the action of the operation ruleset.

Specify one of following items.

  • show

    Operation rulesets with display processes (*1)

  • operate

    Operation rulesets with operational processes (*2)

Tenant name

(Tenant)

The name of the tenant for which the ruleset can be used

(optional)

Specify a character string up to 32 characters.

If left blank, the ruleset can be used for all tenants.

Ruleset Description

(RulesetDescription)

Ruleset description

Specify a character string up to 256 characters.

Parameter Information

(Parameters)

Collection of parameter information (optional)

Specify one or more Parameter elements.

Parameter Variable Name

(Parameter name)

Parameter variable name

Specify the parameter variable name described in script.

Parameter Variable Display Name

(Parameter label)

Parameter variable display name

Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-").

Display Existence

(Parameter view)

Existence of parameter variable values

Specify display existence in order to operate parameter variable values.

  • true

    displayed

  • false

    not displayed

Syntax

(Syntax)

Parameter variable format

Specify the format of the parameter variable.

  • INTEGER(0..255)

    An integer
    Specify the value range in the format (minimum..maximum).

  • DisplayString(SIZE(0..256))

    Character string
    Specify the maximum and minimum number of characters using SIZE.

    For DisplayString(SELECT("AA"|"BB"|"CC")), select the character string from SELECT.

  • Physical Address

    MAC address
    Specify the address in MAC address format.

  • IpAddress

    IP address
    Specify the address in IPv4 address format or IPv6 address format.

  • DisplayString(SELECT IPADDRESS SLB SERVER())

    The IP addresses of the target servers for server load balancing will be listed and become selectable.

    When this format is specified, specification of parameter values (Value) is disabled.

Parameter Values

(Value)

Parameter values

Specify the values omitted from the parameter variables.

When no values are omitted, this element is not specified.

Parameter Description

(ParameterDescription)

Parameter description

Specify the meanings of parameter variables, the format of specified values, and the scope description.

Specify a character string up to 256 characters.

*1: Refers to the rulesets which only display information. This type of ruleset can be used by infrastructure monitors.

*2: Refers to the rulesets which operate network devices. This type of ruleset cannot be used by infrastructure monitors. If the ruleset performs one or more operations on network devices, it is a ruleset with operational processes.