ServerView Resource Orchestrator Cloud Edition V3.2.0 Reference Guide (API)

2.1.4 GetRulesetConfiguration (Obtain the Configuration Information for the Ruleset)

This API obtains the configuration information for a ruleset.
This API can be executed on both the firewall and server load balancer rulesets.

Request parameters

Parameter name	Item	Item description
Version	Description	The version ID of the L-Platform API
	Type	string
	Value	Fixed. Specify "2.0".
Locale	Description	The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639.
	Type	string
	Value	Select one of the following: - en: English - zh: Chinese
Action	Description	The name of the L-Platform API to be executed
	Type	string
	Value	Fixed. Specify "GetRulesetConfiguration".
userId	Description	The user ID of the user that executes the L-Platform API
	Type	string
	Value	No more than 31 characters
orgId	Description	The tenant name of the user that executes the L-Platform API
	Type	string
	Value	No more than 32 characters
rulesetName	Description	Ruleset name
	Type	string
	Value	No more than 32 characters

Response

<Status code>

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<GetRulesetConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <interfaces>
    <interface>
      <name>[Interface name]</name>
      <segmentType>[Segment identifier]</segmentType>
    </interface>
  </interfaces>
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <ruleset>
    <description>[Ruleset description]</description>
    <designtype>[UI type]</designtype>
    <lplatformModel>[L-Platform model]</lplatformModel>
    <name>[Ruleset name]</name>
    <numOfMaxSegment>[Maximum number of segments]</numOfMaxSegment>
    <numOfMaxVm>[Maximum number of virtual machines]</numOfMaxVm>
    <parameters>
      <parameter>
        <description>[Parameter description]</description>
        <name>[Parameter name]</name>
        <required>[Flag indicating whether value is required]</required>
        <summary>[Parameter summary]</summary>
        <syntax>[Parameter syntax]</syntax>
        <value>[Parameter value]</value>
        <view>[Show or hide parameter]</view>
      </parameter>
    </parameters>
    <parametergroups>
      <parametergroup>
         <id>[Parameter group ID]</id>
         <name>[Parameter group name]</name>
         <parameters>
           <parameter>
             <description>[Parameter description]</description>
             <name>[Parameter name]</name>
             <required>[Flag indicating whether value is required]</required>
             <summary>[Parameter summary]</summary>
             <syntax>[Parameter syntax]</syntax>
             <value>[Parameter value]</value>
             <view>[Parameter display flag]</view>
           </parameter>
       </parameters>
      </parametergroup>
    </parametergroups>
    <rulesetCategory>[Ruleset type]</rulesetCategory>
    <type>[Network device type]</type>
  </ruleset>
  <configurations>
    <deviceModel>[Network device model]</deviceModel>
    <maxAccessRuleSetting>[Maximum number of access rules that can be handled by the ruleset]</maxAccessRuleSetting>
    <maxProvision>[Maximum number of firewalls that can be deployed to a network device according to the ruleset]</maxProvision>
  </configurations>
</GetRulesetConfigurationResponse>

<Elements>

Element name	Item	Item description
GetRulesetConfigurationResponse	Description	Element holding the response information
	Type	None
	Number of occurrences	1
interfaces	Description	Element holding the response information for the interface information
	Type	None
	Number of occurrences	0 or 1
interface	Description	Set of interface information
	Type	None
	Number of occurrences	As many as there are interfaces elements (0 or more elements for each interfaces element).
name	Description	Interface name
	Type	string
	Number of occurrences	As many as there are interface elements (0 or 1 element for each interface element).
segmentType	Description	Segment identifier
	Type	string
	Number of occurrences	As many as there are interface elements (0 or 1 element for each interface element).
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 15 Messages Starting with PAPI" in the "Messages" for message details.
	Type	string
	Number of occurrences	1
responseStatus	Description	Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.
	Type	string
	Number of occurrences	1
ruleset	Description	Set of server load balancer ruleset information
	Type	None
	Number of occurrences	0 or 1
description	Description	Ruleset description
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
designtype	Description	UI type. Specify one of the following: - UserCustomize: User customization - Simple: Simple configuration
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
lplatformModel	Description	L-Platform model. Select one of the following: - "Firewall+SLB": Firewall and server load balancer - "Firewall only": Firewall only - "SLB only": Server load balancer only
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
name	Description	Ruleset name
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
numOfMaxSegment	Description	Maximum number of segments
	Type	int
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
numOfMaxVm	Description	Maximum number of virtual machines
	Type	int
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
parameters	Description	Element holding the response information for the ruleset parameter information
	Type	None
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
parameter	Description	Set of ruleset parameter information
	Type	None
	Number of occurrences	As many as there are parameters elements (0 or more elements for each parameters element).
description	Description	Parameter description
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
name	Description	Parameter information name
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
required	Description	Specify whether parameter values must be specified using one of the following: - true: required - false: optional
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
summary	Description	Parameter summary
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
syntax	Description	Parameter syntax
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
value	Description	Parameter value
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
view	Description	Show or hide parameter
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
parametergroups	Description	Element holding the response information for the parameter group information
	Type	None
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
parametergroup	Description	Set of parameter group information
	Type	None
	Number of occurrences	As many as there are parametergroups elements (0 or more elements for each parametergroups element).
id	Description	Parameter group ID
	Type	string
	Number of occurrences	As many as there are parametergroup elements (0 or 1 element for each parametergroup element).
name	Description	Parameter group name
	Type	string
	Number of occurrences	As many as there are parametergroup elements (0 or 1 element for each parametergroup element).
parameters	Description	Element holding the response information for the parameter information
	Type	None
	Number of occurrences	As many as there are parametergroup elements (0 or 1 element for each parametergroup element).
parameter	Description	Set of parameter information
	Type	None
	Number of occurrences	As many as there are parameters elements (0 or more elements for each parameters element).
description	Description	Parameter description
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
name	Description	Parameter name
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
required	Description	Specify whether parameter values must be specified, using one of the following: - true : required - false : optional
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
summary	Description	Parameter summary
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
syntax	Description	Parameter syntax
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
value	Description	Parameter value
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
view	Description	Parameter display flag
	Type	string
	Number of occurrences	As many as there are parameter elements (0 or 1 element for each parameter element).
rulesetCategory	Description	Ruleset type Select one of the following: - config: Ruleset for configuration - operation: Ruleset for operation
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
type	Description	Network device type. Select one of the following: - Firewall: Firewall - SLB: Server load balancer
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).
configurations	Description	Device definition information. This element will only be displayed if the user interface type is "Simple configuration".
	Type	None
	Number of occurrences	0 or 1
deviceModel	Description	Network device model
	Type	string
	Number of occurrences	As many as there are configurations elements (0 or 1 element for each configurations element).
maxAccessRuleSetting	Description	Maximum number of access rules that can be handled by the ruleset
	Type	int
	Number of occurrences	As many as there are configurations elements (0 or 1 element for each configurations element).
maxProvision	Description	Maximum number of firewalls that can be deployed to a network device according to the ruleset
	Type	int
	Number of occurrences	As many as there are configurations elements (0 or 1 element for each configurations element).

Sample response

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