14.2.17 UpdateFirewallConfiguration (Modify Firewall Configuration)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\UpdateFirewallConfiguration - Modify Firewall Configuration

[Linux Manager]
/opt/FJSVcfmg/bin/UpdateFirewallConfiguration.sh - Modify Firewall Configuration

Synopsis

[Windows Manager]

UpdateFirewallConfiguration -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformId L-Platform_ID -xml path_to_the_XML_file

[Linux Manager]

UpdateFirewallConfiguration.sh -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformId L-Platform_ID -xml path_to_the_XML_file

Function description

This command modifies the firewall configuration.

This command is executed asynchronously. After the command is successfully executed, the status of the L-Platform changes to Reconfiguring (RECONFIG_ING) during the execution of the operation, and changes back to Operating Normally (NORMAL) when the operation is completed.
When the status of an L-Platform is Reconfiguring, the L-Platform cannot be operated. Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.

Note

This command does not enable you to change the settings for a firewall that does not use a ruleset.

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.

-lplatformId: Specify the L-Platform ID.

-xml

Specify the path to the XML file that defines firewall setting changes.

<<XML>>

<firewall>
  <ruleset>
   <parameters>
     <parameter>
      <name>[parameter name]</name>
      <value>[value of the parameters]</value>
     </parameter>
     ...
   </parameters>
  </ruleset>
</firewall>

Tag name	Type	Range	Description	Mandatory	Content
firewall	-	-	Specify the firewall.	N	-
ruleset	-	-	Specify the firewall ruleset.	N	-
parameters	-	-	Specify the ruleset parameters.	N	-
parameter	-	1 or more	Specify the number of parameters.	N	-
name	ASCII string	1 byte or more	Specify the name of the parameters performing the operations.	Y	Specify the name of the parameter in the target ruleset that was obtained by GetLPlatformConfiguration.
value	ASCII string	0 byte or more	Specify the value of the parameters performing the operations.	O	-

The symbols in the "Mandatory" column have the following meaning:
Y: If the tag is specified, be sure to specify a value. (Mandatory)
O: The value can be omitted. (Optional)
N: There is no need to set a value. (Unnecessary) Only the tag itself is specified.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> UpdateFirewallConfiguration -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -xml C:\sample.xml
<?xml version="1.0" encoding="UTF-8"?>
<UpdateFirewallConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</UpdateFirewallConfigurationResponse>

[Linux Manager]

# UpdateFirewallConfiguration.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -xml /XML/sample.xml
<?xml version="1.0" encoding="UTF-8"?>
<UpdateFirewallConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</UpdateFirewallConfigurationResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.