14.23 GetLPlatformDescriptorConfiguration (Gets Template Configuration Information)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\GetLPlatformDescriptorConfiguration - Gets Template Configuration Information

[Linux Manager]
/opt/FJSVcfmg/bin/GetLPlatformDescriptorConfiguration.sh - Gets Template Configuration Information

Synopsis

[Windows Manager]

GetLPlatformDescriptorConfiguration -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformDescriptorId L-Platform template ID

[Linux Manager]

GetLPlatformDescriptorConfiguration.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformDescriptorId L-Platform template ID

Function description

This command gets configuration information for the template.

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.

-lplatformDescriptorId: Specify the L-Platform template ID.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> GetLPlatformDescriptorConfiguration -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformDescriptorId template-138141e01cc
<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformDescriptorConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptor>
    <creatorName>user3</creatorName>
    <description>firewall</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>Firewall</name>
        <ruleset>
          <desigintype>UserCustomize</desigintype>
          <description>rule1</description>
          <name>rule1</name>
          <lplatformModel>Firewall+SLB</lplatformModel>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..255)</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..255))</syntax>
              <required>true</required>
              <summary>>param2 summary</summary>
            </parameter>
            <parameter>
              <description>param3 desc</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>1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>SLB</name>
        <ruleset>
          <description>rule1 description</description>
          <name>rule1</name>
          <lplatformModel>Firewall+SLB</lplatformModel>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..255)</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..255))</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>
      </slb>
    </slbs>
    <registrant>tpladm1</registrant>
    <networks>
      <network>
        <name>network-param-0001</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>1ot2#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1234</resourceId>
        <segmentType>DMZ</segmentType>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1235</resourceId>
        <segmentType>SECURE</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <creator>cfmgadm</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <sparePool/>
        <storagePool>/StoragePool</storagePool>
        <pool>/VMHostPool</pool>
        <disks>
          <disk>
            <diskNo>1</diskNo>
            <size>30.0</size>
            <storagePool>/StoragePool</storagePool>
            <contained>false</contained>
          </disk>
        </disks>
        <nics>
          <nic>
            <management>1</management>
            <networkId>1ot2#FWS#</networkId>
            <nicNo>1</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot2#FWS#</networkId>
            <nicNo>2</nicNo>
          </nic>
        </nics>
        <lserverName>server1</lserverName>
        <lserverNo>0</lserverNo>
        <serverType>Economy</serverType>
      </lserver>
      <lserver>
        <creator>cfmgadm</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <sparePool/>
        <storagePool>/StoragePool</storagePool>
        <pool>/VMHostPool</pool>
        <nics>
          <nic>
            <management>1</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>1</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>2</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>3</nicNo>
          </nic>
        </nics>
        <lserverName>vserevr-1</lserverName>
        <lserverNo>1</lserverNo>
        <serverType>over_commit</serverType>
      </lserver>
    </lservers>
    <lplatformdescriptorId>template-1325738ea5b</lplatformdescriptorId>
    <lplatformdescriptorName>firewall-test</lplatformdescriptorName>
  </lplatformdescriptor>
</GetLPlatformDescriptorConfigurationResponse>

[Linux Manager]

# GetLPlatformDescriptorConfiguration.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformDescriptorId template-138141e01cc
<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformDescriptorConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptor>
    <creatorName>user3</creatorName>
    <description>firewall</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>Firewall</name>
        <ruleset>
          <desigintype>UserCustomize</desigintype>
          <description>rule1</description>
          <name>rule1</name>
          <lplatformModel>Firewall+SLB</lplatformModel>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..255)</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..255))</syntax>
              <required>true</required>
              <summary>>param2 summary</summary>
            </parameter>
            <parameter>
              <description>param3 desc</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>1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>SLB</name>
        <ruleset>
         <description>rule1 description</description>
          <name>rule1</name>
          <lplatformModel>Firewall+SLB</lplatformModel>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(0..255)</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..255))</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>
      </slb>
    </slbs>
    <registrant>tpladm1</registrant>
    <networks>
      <network>
        <name>network-param-0001</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>1ot2#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1236</resourceId>
        <segmentType>DMZ</segmentType>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1237</resourceId>
        <segmentType>SECURE</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <creator>cfmgadm</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <sparePool/>
        <storagePool>/StoragePool</storagePool>
        <pool>/VMHostPool</pool>
        <disks>
          <disk>
            <diskNo>1</diskNo>
            <size>30.0</size>
            <storagePool>/StoragePool</storagePool>
            <contained>false</contained>
          </disk>
        </disks>
        <nics>
          <nic>
            <management>1</management>
            <networkId>1ot2#FWS#</networkId>
            <nicNo>1</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot2#FWS#</networkId>
            <nicNo>2</nicNo>
          </nic>
        </nics>
        <lserverName>server1</lserverName>
        <lserverNo>0</lserverNo>
        <serverType>Economy</serverType>
      </lserver>
      <lserver>
        <creator>cfmgadm</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <sparePool/>
        <storagePool>/StoragePool</storagePool>
        <pool>/VMHostPool</pool>
        <nics>
          <nic>
            <management>1</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>1</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>2</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>3</nicNo>
          </nic>
        </nics>
        <lserverName>vserevr-1</lserverName>
        <lserverNo>1</lserverNo>
        <serverType>over_commit</serverType>
      </lserver>
    </lservers>
    <lplatformdescriptorId>template-1325738ea5b</lplatformdescriptorId>
    <lplatformdescriptorName>firewall-test</lplatformdescriptorName>
  </lplatformdescriptor>
</GetLPlatformDescriptorConfigurationResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.