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

2.1.6 ListFirewallRuleset (Obtain a List of Firewall Rulesets)

This API obtains a list of firewall 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 "ListFirewallRuleset ".
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

Response

<Status code>

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListFirewallRulesetResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <rulesets>
    <ruleset>
      <description>[Ruleset description]</description>
      <lplatformModel>[L-Platform model]</lplatformModel>
      <name>[Ruleset name]</name>
      <numOfMaxSegment>[Maximum number of segments]</numOfMaxSegment>
      <numOfMaxVm>[Maximum number of virtual machines]</numOfMaxVm>
      <rulesetCategory>[Ruleset type]</rulesetCategory>
      <type>[Network device type]</type>
    </ruleset>
  </rulesets>
</ListFirewallRulesetResponse>

<Elements>

Element name	Item	Item description
ListFirewallRulesetResponse	Description	Element holding the response information
	Type	None
	Number of occurrences	1
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
rulesets	Description	Element holding the response information for the firewall ruleset information
	Type	None
	Number of occurrences	0 or 1
ruleset	Description	Set of firewall ruleset information
	Type	None
	Number of occurrences	As many as there are rulesets elements (0 or more elements for each rulesets element).
description	Description	Ruleset description
	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
	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).
rulesetCategory	Description	Ruleset type
	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. This is the following value: - Firewall: Firewall
	Type	string
	Number of occurrences	As many as there are ruleset elements (0 or 1 element for each ruleset element).

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListFirewallRulesetResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <rulesets>
    <ruleset>
      <description>3 tier firewall system(scope is within 3 tiers) that used Simple UI</description>
      <lplatformModel>Firewall+SLB</lplatformModel>
      <name>Simple_FW_setting_for_NS</name>
      <numOfMaxSegment>3</numOfMaxSegment>
      <numOfMaxVm>10</numOfMaxVm>
      <rulesetCategory>config</rulesetCategory>
      <type>Firewall</type>
    </ruleset>
    <ruleset>
      <description>Operation to display logs for Simple UI.</description>
      <name>Simple_log_display_for_NS</name>
      <rulesetCategory>operation</rulesetCategory>
      <type>Firewall</type>
    </ruleset>
  </rulesets>
</ListFirewallRulesetResponse>