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

14.31 GetRulesetConfiguration (Obtain the Configuration Information for the Ruleset)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\GetRulesetConfiguration - Obtain the Configuration Information for the Ruleset

[Linux Manager]
/opt/FJSVcfmg/bin/GetRulesetConfiguration.sh - Obtain the Configuration Information for the Ruleset

Synopsis

[Windows Manager]

GetRulesetConfiguration -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -rulesetName ruleset name

[Linux Manager]

GetRulesetConfiguration.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -rulesetName ruleset name

Function description

This API obtains the configuration information for a ruleset.

This can be executed on both the firewall and server load balancer rulesets.

Options

-version

Specify the version ID of the L-Platform API.

-locale

Specify the language used to communicate with the L-Platform API.

-userId

Specify the user ID for executing the L-Platform API.

-password

Specify the password for the user ID for executing the L-Platform API.

-orgId

Specify the tenant name of the user for executing the L-Platform API.

-rulesetName

Specify the ruleset name.

Requirements

Permissions

User with OS administrator privilege

Location

Admin server

Example

[Windows Manager]

> GetRulesetConfiguration -version 2.0 -locale en -userId user3 -password password -orgId tenantA -rulesetName Firewall1
<?xml version="1.0" encoding="UTF-8"?>
<GetRulesetConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <ruleset>
  <desigintype>UserCustomize</desigintype>
  <name>Firewall1</name>
  <type>Firewall</type>
  <rulesetCategory>config</rulesetCategory>
  <lplatformModel>Firewall only</lplatformModel>
  <numOfMaxSegment>3</numOfMaxSegment>
  <numOfMaxVm>10</numOfMaxVm>
  <description>SLB server1</description>
  <parameters>
    <parameter>
      <description>param1 int 0-65535</description>
      <name>param_var_001</name>
      <value>400</value>
      <view>true</view>
      <summary>param1</summary>
      <syntax>INTEGER(0..65535)</syntax>
      <required>true</required>
    </parameter>
    <parameter>
      <description>param2 int 0-256</description>
      <name>param_var_002</name>
      <value>200</value>
      <view>true</view>
      <summary>param2</summary>
      <syntax>INTEGER(0..256)</syntax>
      <required>true</required>
    </parameter>
    </parameters>
  </ruleset>
  <interfaces>
    <interface>
      <name>interface1</name>
      <segmentType>SECURE</segmentType>
    </interface>
    <interface>
      <name>interface2</name>
      <segmentType>DMZ</segmentType>
    </interface>
  </interfaces>
</GetRulesetConfigurationResponse>

[Linux Manager]

# GetRulesetConfiguration.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -rulesetName Firewall1
<?xml version="1.0" encoding="UTF-8"?>
<GetRulesetConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <ruleset>
  <desigintype>UserCustomize</desigintype>
  <name>Firewall1</name>
  <type>Firewall</type>
  <rulesetCategory>config</rulesetCategory>
  <lplatformModel>Firewall only</lplatformModel>
  <numOfMaxSegment>3</numOfMaxSegment>
  <numOfMaxVm>10</numOfMaxVm>
  <description>SLB server1</description>
  <parameters>
    <parameter>
      <description>param1 int 0-65535</description>
      <name>param_var_001</name>
      <value>400</value>
      <view>true</view>
      <summary>param1</summary>
      <syntax>INTEGER(0..65535)</syntax>
      <required>true</required>
    </parameter>
    <parameter>
      <description>param2 int 0-256</description>
      <name>param_var_002</name>
      <value>200</value>
      <view>true</view>
      <summary>param2</summary>
      <syntax>INTEGER(0..256)</syntax>
      <required>true</required>
    </parameter>
    </parameters>
  </ruleset>
  <interfaces>
    <interface>
      <name>interface1</name>
      <segmentType>SECURE</segmentType>
    </interface>
    <interface>
      <name>interface2</name>
      <segmentType>DMZ</segmentType>
    </interface>
  </interfaces>
</GetRulesetConfigurationResponse>

Exit Status

This command returns the following values:

0

The command executed successfully.

non-zero

An error has occurred.