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

15.14.1 For Scripts of Automatic Configuration Rulesets

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

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

<?xml version="1.0" encoding="utf-8"?>
<RulesetParameter>
  <Ruleset name="Ruleset_name" type="Ruleset_type" category="config">
    <Tenant>Tenant Name</Tenant>
    <LplatformModel>L-Platform_model</LplatformModel>
    <SelectDeviceType>Configurable_device_type</SelectDeviceType>
    <MaxSegment>Maximum Segment Number</Maxsegment>
      <MaxServer>Maximum Server Number</MaxServer>
    <RulesetDescription>Ruleset Description</RulesetDescription>
  </Ruleset>
  <LNetworkDeviceInterfaces>
    <LNetworkDeviceInterface name="Network Identifier Parameter Name 1">
      <SegmentType>Segment Type Name1</SegmentType>
      <NetworkResourceId>Network Resource ID1</NetworkResourceId>
    </LNetworkDeviceInterface>
    <LNetworkDeviceInterface name="Network Identifier Parameter Name 2">
      <SegmentType>Segment Type Name2</SegmentType>
      <NetworkResourceId>Network Resource ID2</NetworkResourceId>
    </LNetworkDeviceInterface>
    ...
  </LNetworkDeviceInterfaces>
  <Parameters>
    <Parameter name="Parameter Variable 1" segmentlabel="Segment name" serverlabel="Server name" label="Parameter Variable Display Name 1" view="display existence">
      <Syntax>Syntax</Syntax>
      <Value>Parameter Value1</Value>
      <ParameterDescription>Parameter Description1</ParameterDescription>
    </Parameter>
    <Parameter name="Parameter Variable 2" segmentlabel="Segment name" serverlabel="Server name" label="Parameter Variable Display Name 2" view="display existence">
      <Syntax>Syntax</Syntax>
      <Value>Parameter Value2</Value>
      <ParameterDescription>Parameter Description2</ParameterDescription>
    </Parameter>
    ...
  </Parameters>
</RulesetParameter>
Table 15.23 List of Specified XML Items for Parameter Information to be Handed Over to Scripts of Automatic Configuration 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

(optional)

Specify the network device type.

Specify one of the following:

  • Firewall

  • SLB

If left blank, "Firewall" is specified.

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 category

(category)

Ruleset category

(optional)

Specify "config" for the ruleset category.

When omitted, "config" is specified.

L-Platform model

(LplatformModel)

L-Platform model

Specify the model of the L-Platform realized by the ruleset.

(optional)

Specify the model of the L-Platform.

Specify one of following items.

  • 1

    L-Platform with Firewall only

  • 2

    L-Platform with SLB only

  • 3

    L-Platform with Firewall and SLB

If left blank, "1" is set.

Configurable device type

(SelectDeviceType)

The type of network devices which can be automatically configured by the ruleset

(optional)

Specify the network device type.

Specify one of following items.

  • 1

    Firewall

  • 2

    SLB

  • 3

    Firewall+SLB

If left blank, "1" is set.

Maximum Segment Number

(MaxSegment)

The maximum number of segments which can be used with a ruleset

When configuring systems involving multiple hierarchy models, this maximum segment number is the upper limit of multiple hierarchy models.
When the ruleset is used for network resources or SLB, specification is not necessary.

Specify an integer between 1 and 99.

When you specify an integer between 11 and 99, specify an integer between 1 and 10 for maximum server number.

Maximum Server Number

(MaxServer)

The maximum number of servers which can be set for server specific configuration for one segment unit for ruleset.

The total of the maximum number of servers and the maximum number of segments is the upper limit of the number of servers that can be created using an L-Platform.
When the ruleset is used for network resources, specification is not necessary.

Specify an integer between 1 and 99.

When you specify an integer between 11 and 99 for maximum segment number, specify an integer between 1 and 10.

Ruleset Description

(RulesetDescription)

Ruleset description

Specify a character string up to 256 characters.

Network Identifier Parameter Information

(LNetworkDeviceInterfaces)

Collection of network identifier parameter information

Specify one or more LNetworkDeviceInterface elements.

Network Identifier Parameter Name

(LNetworkDeviceInterface name)

Network identifier parameter name for the virtual interface of the network device

When the ruleset is used for network resources, specification is not necessary.

Specify the parameter variable name described in script.

Segment Type Name

(SegmentType)

Name specifying segment types for rulesets (DMZ or Intranet)

When configuring a multiple hierarchy model using an L-Platform, only segments with this segment type name can be created.
When the ruleset is used for network resources, specification is not necessary.

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

Network Resource ID

(NetworkResourceId)

Network resource ID for network identifier parameter

When the ruleset is used for network resources, specification is not necessary.

-

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.

Display name of the segment with parameter variables enabled

(Parameter segmentlabel)

Display name of the segment with parameter variables enabled

For parameters not related to segments, specification is not necessary.

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

Display name of the server with parameter variables enabled

(Parameter serverlabel)

Display name of the server with parameter variables enabled

For parameters not related to servers, specification is not necessary.

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

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("SegA"|"SegB"|"SegC"))

    Specify the name of the segment type (SegmentType) for SegA, SegB, and SegC.

    For the segments specified in SegA, SegB, and SegC, the IP addresses of the servers which can be server load balancing targets will be listed and become selectable.

    If SegA, SegB, and SegC are not specified, it will be assumed that all segments on the L-Platform have been specified.

    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.