14.21 GetLPlatformConfiguration (Gets Configuration Information for an L-Platform)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\GetLPlatformConfiguration - Gets Configuration Information for an L-Platform

[Linux Manager]
/opt/FJSVcfmg/bin/GetLPlatformConfiguration.sh - Gets Configuration Information for an L-Platform

Synopsis

[Windows Manager]

GetLPlatformConfiguration -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformId L-Platform ID

[Linux Manager]

GetLPlatformConfiguration.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformId L-Platform ID

Function description

This command gets configuration information for an L-Platform.

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.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> GetLPlatformConfiguration -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX
<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatform>
    <baseDescriptor>template-1325738ea5b</baseDescriptor>
    <creator>tenantA</creator>
    <ownerUser>user3</ownerUser>
    <description>firewall</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>Firewall</name>
        <ruleset>
          <desigintype>UserCustomize</desigintype>
          <description>rule1</description>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..256)</syntax>
              <required>true</required>
              <summary>>param1 summary</summary>
            </parameter>
            <parameter>
              <description>param2</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
              <syntax>DisplayString(SIZE(0..256))</syntax>
              <required>true</required>
             <summary>>param2 summary</summary>
            </parameter>
            <parameter>
              <description>param3</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
              <syntax>INTEGER(0..65535)</syntax>
              <required>true</required>
             <summary>>param3 summary</summary>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <slbs>
      <slb>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>SLB</name>
        <ruleset>
          <description>rule1</description>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..256)</syntax>
              <required>true</required>
              <summary>>param1 summary</summary>
            </parameter>
            <parameter>
              <description>param2</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
              <syntax>DisplayString(SIZE(0..256))</syntax>
              <required>true</required>
              <summary>>param2 summary</summary>
            </parameter>
            <parameter>
              <description>param3</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
              <syntax>INTEGER(0..65535)</syntax>
              <required>true</required>
              <summary>>param3 summary</summary>
            </parameter>
          </parameters>
        </ruleset>
        <operations>
         <operation>
          <operationId>ROR_001</operationId>
          <status>completed</status>
          <rulesetName>rule1</rulesetName>
         </operation>
        </operations>
        <operationLogExist>false</operationLogExist>
      </slb>
    </slbs>
    <networks>
      <network>
        <name>network-param-0001</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1234</resourceId>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1235</resourceId>
      </network>
    </networks>
    <lservers>
      <lserver>
        <cpuPerf>1.0</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <hostName>V8O0NW7TZV0001</hostName>
        <memorySize>2.0</memorySize>
        <numOfCpu>2</numOfCpu>
        <requestCpuPerf>1.4</requestCpuPerf>
        <requestMemorySize>2.0</requestMemorySize>
        <requestNumOfCpu>1</requestNumOfCpu>
        <sparePool>/SparePool</sparePool>
        <storagePool>/StoragePool</storagePool>
        <sysvolSize>100</sysvolSize>
        <lserverType>Physical</lserverType>
        <disks/>
        <pool>/ServerPool</pool>
        <nics>
          <nic>
            <management>0</management>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
            <nicNo>2</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
          <nic>
            <management>1</management>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
            <nicNo>1</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
        </nics>
        <lserverId>tenantA-M3PGGWCFX-S-0001</lserverId>
        <lserverName>physical1</lserverName>
        <serverType>Economy</serverType>
        <resource>
          <name>tenantA-M3PGGWCFX-S-0001</name>
        </resource>
        <snapshotExist>false</snapshotExist>
      </lserver>
      <lserver>
        <cpuPerf>1.2</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <hostName>V8O0NW7TZV0002</hostName>
        <memorySize>1.6</memorySize>
        <numOfCpu>1</numOfCpu>
        <storagePool>/StoragePool</storagePool>
        <sysvolSize>100</sysvolSize>
        <lserverType>Virtual</lserverType>
        <disks/>
        <pool>/VMHostPool</pool>
        <vmType>VMware</vmType>
        <nics>
          <nic>
            <management>0</management>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
            <nicNo>3</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
          <nic>
            <management>0</management>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
            <nicNo>2</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
          <nic>
            <management>1</management>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
            <nicNo>1</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
        </nics>
        <lserverId>tenantA-M3PGGWCFX-S-0002</lserverId>
        <lserverName>virtual1</lserverName>
        <serverType>over_commit</serverType>
        <resource>
          <name>tenantA-M3PGGWCFX-S-0002</name>
        </resource>
        <snapshotExist>true</snapshotExist>
      </lserver>
    </lservers>
    <lplatformId>tenantA-M3PGGWCFX</lplatformId>
    <lplatformName>firewall-test</lplatformName>
    <bladeLogic>true</bladeLogic>
  </lplatform>
</GetLPlatformConfigurationResponse>

[Linux Manager]

# GetLPlatformConfiguration.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX
<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatform>
    <baseDescriptor>template-1325738ea5b</baseDescriptor>
    <creator>tenantA</creator>
    <ownerUser>user3</ownerUser>
    <description>firewall</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>Firewall</name>
        <ruleset>
          <desigintype>UserCustomize</desigintype>
          <description>rule1</description>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..256)</syntax>
              <required>true</required>
              <summary>>param1 summary</summary>
            </parameter>
            <parameter>
              <description>param2</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
              <syntax>DisplayString(SIZE(0..256))</syntax>
              <required>true</required>
              <summary>>param2 summary</summary>
            </parameter>
            <parameter>
              <description>param3</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
              <syntax>INTEGER(0..65535)</syntax>
              <required>true</required>
             <summary>>param3 summary</summary>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <slbs>
      <slb>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>SLB</name>
        <ruleset>
          <description>rule1</description>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..256)</syntax>
              <required>true</required>
              <summary>>param1 summary</summary>
            </parameter>
            <parameter>
              <description>param2</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
              <syntax>DisplayString(SIZE(0..256))</syntax>
              <required>true</required>
              <summary>>param2 summary</summary>
            </parameter>
            <parameter>
              <description>param3</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
              <syntax>INTEGER(0..65535)</syntax>
              <required>true</required>
              <summary>>param3 summary</summary>
            </parameter>
          </parameters>
        </ruleset>
        <operations>
         <operation>
          <operationId>ROR_001</operationId>
          <status>completed</status>
          <rulesetName>rule1</rulesetName>
         </operation>
        </operations>
      </slb>
    </slbs>
    <networks>
      <network>
        <name>network-param-0001</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1234</resourceId>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1234</resourceId>
      </network>
    </networks>
    <lservers>
      <lserver>
        <cpuPerf>1.0</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <hostName>V8O0NW7TZV0001</hostName>
        <memorySize>2.0</memorySize>
        <numOfCpu>2</numOfCpu>
        <requestCpuPerf>1.4</requestCpuPerf>
        <requestMemorySize>2.0</requestMemorySize>
        <requestNumOfCpu>1</requestNumOfCpu>
        <sparePool>/SparePool</sparePool>
        <storagePool>/StoragePool</storagePool>
        <sysvolSize>100</sysvolSize>
        <lserverType>Physical</lserverType>
        <disks/>
        <pool>/ServerPool</pool>
        <nics>
          <nic>
            <management>0</management>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
            <nicNo>2</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
          <nic>
            <management>1</management>
            <networkId>M3PGGWCFX-N-1ot2#FWS#</networkId>
            <nicNo>1</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
        </nics>
        <lserverId>tenantA-M3PGGWCFX-S-0001</lserverId>
        <lserverName>physical1</lserverName>
        <serverType>Economy</serverType>
        <resource>
          <name>tenantA-M3PGGWCFX-S-0001</name>
        </resource>
        <snapshotExist>false</snapshotExist>
      </lserver>
      <lserver>
        <cpuPerf>1.2</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <hostName>V8O0NW7TZV0002</hostName>
        <memorySize>1.6</memorySize>
        <numOfCpu>1</numOfCpu>
        <storagePool>/StoragePool</storagePool>
        <sysvolSize>100</sysvolSize>
        <lserverType>Virtual</lserverType>
        <disks/>
        <pool>/VMHostPool</pool>
        <vmType>VMware</vmType>
        <nics>
          <nic>
            <management>0</management>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
            <nicNo>3</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
          <nic>
            <management>0</management>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
            <nicNo>2</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
          <nic>
            <management>1</management>
            <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
            <nicNo>1</nicNo>
            <privateIp>192.xxx.xxx.xxx</privateIp>
          </nic>
        </nics>
        <lserverId>tenantA-M3PGGWCFX-S-0002</lserverId>
        <lserverName>virtual1</lserverName>
        <serverType>over_commit</serverType>
        <resource>
          <name>tenantA-M3PGGWCFX-S-0002</name>
        </resource>
        <snapshotExist>true</snapshotExist>
      </lserver>
    </lservers>
    <lplatformId>tenantA-M3PGGWCFX</lplatformId>
    <lplatformName>firewall-test</lplatformName>
    <bladeLogic>true</bladeLogic>
  </lplatform>
</GetLPlatformConfigurationResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.