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

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

This API gets configuration information for an L-Platform.

Note

For physical servers, the number of CPUs, operating frequency, and memory size displayed are those specified by the user during the L-Platform subscription or when importing a server as part of an L-Platform reconfiguration.
For physical servers imported to the L-Platform, only the values at the time these servers are imported will be displayed.
For this reason, even if the number of CPUs, operating frequency, and memory size are changed, the displayed values will not change.


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 "GetLPlatformConfiguration".

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.

lplatformId

Description

L-Platform ID.

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"?>
<GetLPlatformConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lplatform>
    <baseDescriptor>[Template ID from which the L-Platform was created]</baseDescriptor>
    <bladeLogic>[Flag to indicate configuration changes/returns depending on whether BladeLogic exists]</bladeLogic>
    <connector>[Connection destination]</connector>
    <creator>[The tenant name of the person who created the L-Platform]</creator>
    <description>[L-Platform description]</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>[Interface name]</name>
            <networkId>[Network ID]</networkId>
          </interface>
        </interfaces>
        <name>[Firewall name]</name>
        <serialNo>[Serial  number]</serialNo>
        <ruleset>
          <description>[Ruleset description]</description>
          <designtype>[UI type]</designtype>
          <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>
          <name>[Ruleset name]</name>
          <parameters>
            <parameter>
              <description>[Parameter information description]</description>
              <name>[Parameter information 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>
         <parametergroups>
            <parametergroup>
               <name>[Parameter group name]</name>
               <id>[Parameter group ID]</id>
               <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>
        </ruleset>
      </firewall>
    </firewalls>
    <ownerUser>[The user ID of the person who owns the L-Platform]</ownerUser>
    <slbs>
      <slb>
        <interfaces>
          <interface>
            <name>[Interface name]</name>
            <networkId>[Network ID]</networkId>
          </interface>
        </interfaces>
        <name>[Server load balancer name]</name>
        <operationLogExist>[This flag indicates whether there are operation logs that have not been acquired]</operationLogExist>
        <operations>
         <operation>
          <operationId>[Operation ID]</operationId>
          <rulesetName>[Ruleset name]</rulesetName>
          <status>[Operation status]</status>
         </operation>
        </operations>
        <ruleset>
          <description>[Ruleset description]</description>
          <name>[Ruleset name]</name>
          <parameters>
            <parameter>
              <description>[Parameter information description]</description>
              <name>[Parameter information 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>
        </ruleset>
        <targetservers>
           <targetserver>
             <lserverId>[Distribution target server ID]</lserverId>
             <nicNo>[Distribution target NIC number]</nicNo>
             <nicgroupIndex>[Distribution target NIC group index]</nicgroupIndex>
             <parameterName>[Name of the parameter used to select distribution targets]</parameterName>
             <status>[Distribution target deployment status]</status>
           </targetserver>
        </targetservers>
      </slb>
    </slbs>
    <publicips>
       <publicip>
          <address>[IP address]</address>
       </publicip>
    </publicips>
    <networks>
      <network>
        <name>[Network name]</name>
        <networkCategory>[Network type]</networkCategory>
        <networkId>[Network ID]</networkId>
        <numOfMaxVm>[Maximum number of VMs]</numOfMaxVm>
        <resourceId>[Network resource ID]</resourceId>
        <segmentType>[Segment type information]</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <cpuPerf>[CPU performance]</cpuPerf>
        <cpuReserve>[CPU reserve performance]</cpuReserve>
        <cpuShare>[CPU allotment ratio]</cpuShare>
        <creator>[The tenant name of the person who created the server]</creator>
        <containerPoolManaged>[Flag to indicate whether it is managed by this product]</containerPoolManaged>
        <diskimageId>[Disk image ID]</diskimageId>
        <diskimageName>[Disk image name]</diskimageName>
        <hostName>[Host name of the server]</hostName>
        <lserverType>[Server type]</lserverType>
        <maxDefinableMemorySize>[Maximum amount of memory]</maxDefinableMemorySize>
        <memoryHotPlug>[Memory hot plug]</memoryHotPlug>
        <memoryReserve>[Reserved memory capacity]</memoryReserve>
        <memorySize>[Amount of memory]</memorySize>
        <memoryShare>[Memory allotment ratio]</memoryShare>
        <numOfCpu>[Number of CPUs]</numOfCpu>
        <pool>[The resource name of the VM pool]</pool>
        <priority>[Power priority]</priority>
        <requestCpuPerf>[Requested CPU performance]</requestCpuPerf>
        <requestMemorySize>[Requested memory capacity]</requestMemorySize>
        <requestNumOfCpu>[Requested number of CPUs]</requestNumOfCpu>
        <resource>
          <name>[L-Server name]</name>
        </resource>
        <snapshotExist>[Flag to indicate whether a snapshot is on the server]</snapshotExist>
        <sparePool>[The resource name of the spare pool]</sparePool>
        <storagePool>[The resource name of the storage pool]</storagePool>
        <sysvolSize>[The size of the system volume]</sysvolSize>
        <disks>
          <disk>
            <attachedTo>[The ID of the virtual machine to which the additional disk has been attached]</attachedTo>
            <creator>[The tenant name of the person who created the additional disk]</creator>
            <resourceName>[Name of the Existing disk]</resourceName>
            <size>[The size of the additional disk]</size>
            <storagePool>[The resource name of the storage pool]</storagePool>
            <diskId>[The ID of the additional disk]</diskId>
            <diskName>[The name of the additional disk]</diskName>
          </disk>
        </disks>
        <vmType>[Virtual machine type]</vmType>
        <nics>
          <nic>
            <management>[Control NIC]</management>
            <networkId>[Network ID]</networkId>
            <nicgroupIndex>[The NIC group index to which the server belongs]</nicgroupIndex>
            <nicNo>[NIC serial number]</nicNo>
            <privateIp>[IP address]</privateIp>
          </nic>
        </nics>
        <nicgroups>
          <nicgroup>
            <management>[Control NIC]</management>
            <networkId>[Network ID]</networkId>
            <nicgroupIndex>[NIC group index]</nicgroupIndex>
            <privateIp>[IP address]</privateIp>
          </nicgroup>
        </nicgroups>
        <lserverId>[Server ID]</lserverId>
        <lserverName>[Server name]</lserverName>
        <serverType>[Server type]</serverType>
        <vdi>[Use of VDI coordination]</vdi>
        <vdiConnectInfo>[VDI management server connection information]</vdiConnectInfo>
        <vdiPool>[VDI pool]</vdiPool>
        <vdiUser>[VDI user name]</vdiUser>
      </lserver>
    </lservers>
    <lplatformId>[L-Platform ID]</lplatformId>
    <lplatformName>[L-Platform name]</lplatformName>
  </lplatform>
</GetLPlatformConfigurationResponse>

<Elements>

Element name

Item

Item description

GetLPlatformConfigurationResponse

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

lplatform

Description

Element holding the response information for the L-Platform information.

Type

None

Number of occurrences

0 or 1

baseDescriptor

Description

Template ID from which the L-Platform was created.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

bladeLogic

Description

Either of the following flags can be specified to indicate whether reconfiguration or return can be performed in case there are any Solaris Zone or OVM for SPARC servers:
- true: The L-Platform does not have Solaris Zone or OVM for SPARC servers, or reconfiguration or return can be performed even if the L-Platform has Solaris Zone or OVM for SPARC servers.
- false: The L-Platform has Solaris Zone or OVM for SPARC servers, and reconfiguration or return cannot be performed.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

connector

Description

Connection destination. One of the following values:
- none: No connection
- intranet: Intranet
- internet: Internet
- both : Both Internet and intranet

This element will be displayed only if a simple configuration firewall has been set.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

creator

Description

The tenant name of the person who created the L-Platform.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

description

Description

L-Platform description.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

firewalls

Description

Element holding the response information for the firewall information.

Type

None

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

firewall

Description

Set of firewall information.

Type

None

Number of occurrences

As many as there are firewalls elements (0 or more elements for each firewalls element).

interfaces

Description

Element holding the response information for the interface information

Type

None

Number of occurrences

As many as there are firewall elements (0 or 1 element for each firewall element).

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).

networkId

Description

Network ID.

Type

string

Number of occurrences

As many as there are interface elements (0 or 1 element for each interface element).

name

Description

Firewall name.

Type

string

Number of occurrences

As many as there are firewall elements (0 or 1 element for each firewall element).

serialNo

Description

Serial number. This element will be displayed if a simple configuration has been used.

Type

int

Number of occurrences

As many as there are firewall elements (0 or 1 element for each firewall element).

ruleset

Description

Firewall ruleset.

Type

None

Number of occurrences

As many as there are firewall elements (0 or 1 element for each firewall 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).

designtype

Description

UI type. 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).

deviceModel

Description

Network device model.

Type

string

Number of occurrences

As many as there are ruleset elements (0 or 1 element for each ruleset 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 ruleset elements (0 or 1 element for each ruleset 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 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).

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 information 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

Parameter display flag.

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 of the ruleset.

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).

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).

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).

parameters

Description

Element holding the response information for the parameter information of the ruleset.

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 information 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

Parameter display flag.

Type

string

Number of occurrences

As many as there are parameter elements (0 or 1 element for each parameter element).

ownerUser

Description

The user ID of the person who owns the L-Platform.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

slbs

Description

Element holding the response information for the server load balancer.

Type

None

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

slb

Description

Set of server load balancer information.

Type

None

Number of occurrences

As many as there are slbs elements (0 or more elements for each slbs element).

interfaces

Description

Element holding the response information for the interface information.

Type

None

Number of occurrences

As many as there are slb elements (0 or 1 element for each slb element).

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).

networkId

Description

Network ID

Type

string

Number of occurrences

As many as there are interface elements (0 or 1 element for each interface element).

name

Description

Server load balancer name

Type

string

Number of occurrences

As many as there are slb elements (0 or 1 element for each slb element).

operationLogExist

Description

This flag indicates whether there are operation logs that have not been acquired. It will be one of the following:
- true: There are operation logs that have not been acquired.
- false: There are no operation logs that have not been acquired.

Operation is not possible if this is "true".

Type

string

Number of occurrences

As many as there are slb elements (0 or 1 element for each slb element).

operations

Description

Element holding the response information for the operation information.

Type

None

Number of occurrences

As many as there are slb elements (0 or 1 element for each slb element).

operation

Description

Set of operation information.

Type

None

Number of occurrences

As many as there are operations elements (0 or more elements for each operations element).

operationId

Description

Operation ID.
Specify when executing GetOperationResult.

Type

string

Number of occurrences

As many as there are operation elements (0 or 1 element for each operation element).

rulesetName

Description

Ruleset name

Type

string

Number of occurrences

As many as there are operation elements (0 or 1 element for each operation element).

status

Description

Operation status

Type

string

Number of occurrences

As many as there are operation elements (0 or 1 element for each operation element).

ruleset

Description

Server load balancer ruleset

Type

None

Number of occurrences

As many as there are slb elements (0 or 1 element for each slb 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).

name

Description

Ruleset name

Type

string

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 parameter information of the ruleset.

Type

None

Number of occurrences

As many as there are ruleset elements (0 or 1 element for each ruleset element).

parameter

Description

Set of parameter information of the ruleset.

Type

None

Number of occurrences

As many as there are parameters elements (0 or more elements for each parameters element).

description

Description

Parameter information 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).

targetservers

Description

Distribution target list.

Type

None

Number of occurrences

As many as there are slb elements (0 or 1 element for each slb element).

targetserver

Description

Distribution target server information.

Type

None

Number of occurrences

As many as there are targetservers elements (0 or more elements for each targetservers element).

lserverId

Description

Distribution target server ID.

Type

string

Number of occurrences

As many as there are targetserver elements (0 or 1 element for each targetserver element).

nicNo

Description

Distribution target NIC number.
The NIC group index will not be displayed if the NIC number is.

Type

int

Number of occurrences

As many as there are targetserver elements (0 or 1 element for each targetserver element).

nicgroupIndex

Description

Distribution target NIC group index.
The NIC number will not be displayed if the NIC group index is.

Type

int

Number of occurrences

As many as there are targetserver elements (0 or 1 element for each targetserver element).

parameterName

Description

Name of the parameter used to select distribution targets.

Type

string

Number of occurrences

As many as there are targetserver elements (0 or 1 element for each targetserver element).

status

Description

Deployment status of the distribution target:
- DEPLOYING: Deploying
- NORMAL: Deployment completed
- UNDEPLOYING: Undeploying

Type

string

Number of occurrences

As many as there are targetserver elements (0 or 1 element for each targetserver element).

publicips

Description

Element holding the response information for the global IP address.

Type

None

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

publicip

Description

Set of global IP address information.

Type

None

Number of occurrences

As many as there are publicips elements (0 or more elements for each publicips element).

address

Description

IP address

Type

string

Number of occurrences

As many as there are publicip elements (0 or 1 element for each publicip element).

networks

Description

Element holding the response information for the network information.

Type

None

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

network

Description

Set of network information

Type

None

Number of occurrences

As many as there are networks elements (0 or more elements for each networks element).

name

Description

Network name.

Type

string

Number of occurrences

As many as there are network elements (0 or 1 element for each network element).

networkCategory

Description

Network type. For manager LAN, the value is "MANAGEMENT". For business LAN, the value is "BUSINESS". If the network has not been registered, the value is an empty string.

Type

string

Number of occurrences

As many as there are network elements (0 or 1 element for each network element).

networkId

Description

Network ID.

Type

string

Number of occurrences

As many as there are network elements (0 or 1 element for each network element).

numOfMaxVm

Description

Maximum number of VMs

Type

int

Number of occurrences

As many as there are network elements (0 or 1 element for each network element).

resourceId

Description

Network resource ID.

Type

string

Number of occurrences

As many as there are network elements (0 or 1 element for each network element).

segmentType

Description

Segment type information

Type

string

Number of occurrences

As many as there are network elements (0 or 1 element for each network element).

lservers

Description

Element holding the response information for the server information.

Type

None

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

lserver

Description

Set of server information.

Type

None

Number of occurrences

As many as there are lservers elements (0 or more elements for each lservers element).

cpuPerf

Description

CPU performance

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

cpuReserve

Description

CPU reserve performance

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

cpuShare

Description

CPU allotment ratio

Type

int

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

creator

Description

The tenant name of the person who created the server

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

containerPoolManaged

Description

Flag indicating whether the container resource pool where the server operates is managed by this product. This is one of the following:
- true: Managed
- false: Not managed

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

diskimageId

Description

Disk image ID.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

diskimageName

Description

Disk image name.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

hostName

Description

Host name of the server.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

lseverType

Description

Server type. One of the following:
- "Physical": Physical server.
- "Virtual": Virtual server.

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

maxDefinableMemorySize

Description

Maximum amount of memory.
It indicates the maximum amount of memory that can be allocated for memory hot plug-enabled KVM servers.

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

memoryHotPlug

Description

Memory hot plug. If it is enabled on a KVM server, the memory size can be changed without powering off.
- true: enabled
- false: disabled

When memory hot plug is enabled, the maximum amount of memory that can be changed is limited to the least of the following:

MAXDefinableMemorySize
"Maximum memory" of the image information
Physical memory size of the VM host

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

memoryReserve

Description

Reserved memory capacity.

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

memorySize

Description

Amount of memory.

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

memoryShare

Description

Memory allotment ratio.

Type

int

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

numOfCpu

Description

Number of CPUs.

Type

int.

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

pool

Description

The resource name of the VM pool.
This will only be output if the server type is a virtual server.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

priority

Description

Priority startup levels are set to between 1 and 256 when performing batch power supply controls.
These values will be started up from small servers.
However, servers with a startup priority level of '0' are not eligible for batch power supply operations.

Type

int

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

requestCpuPerf

Description

Requested CPU performance.

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

requestMemorySize

Description

Requested memory capacity

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

requestNumOfCpu

Description

Requested number of CPUs.

Type

int

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

resource

Description

Set of information displayed in the [Resources] tab.

Type

None

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

name

Description

L-Server name

Type

string

Number of occurrences

As many as there are resource elements (0 or 1 element for each resource element).

snapshotExist

Description

Flag indicating whether a snapshot exists on the server. This is one of the following:
- true: Snapshot exists
- false: Snapshot does not exist

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

sparePool

Description

The resource name of the spare pool.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

storagePool

Description

The resource name of the storage pool.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

sysvolSize

Description

The size of the system volume.

Type

decimal

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

disks

Description

Element holding the response information for the additional disk information.

Type

None

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

disk

Description

Set of additional disk information.

Type

None

Number of occurrences

As many as there are disks elements (0 or more elements for each disks element).

attachedTo

Description

The ID of the virtual machine to which the additional disk has been attached.

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

creator

Description

The tenant name of the person who created the additional disk.

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

resourceName

Description

The name of the existing disk.
This element will be displayed for existing disks only.

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

size

Description

The size of the additional disk. Specify this value in GB.

Type

decimal

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

storagePool

Description

The resource name of the storage pool.

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

diskId

Description

The ID of the additional disk.

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

diskName

Description

The name of the additional disk.

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

vmType

Description

Virtual machine type.
Refer to "15.2.2 Virtual L-Server Templates" in the "Reference Guide (Command/XML) CE" for details.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

nics

Description

Element holding the response information for the NIC information.

Type

None

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

nic

Description

Set of NIC information.

Type

None

Number of occurrences

As many as there are nics elements (0 or more elements for each nics element).

management

Description

Control NIC. The value is "1" if the NIC is a control NIC. Otherwise, the value is "0".

Type

int

Number of occurrences

As many as there are nic elements (0 or 1 element for each nic element).

networkId

Description

Network ID

Type

string

Number of occurrences

As many as there are nic elements (0 or 1 element for each nic element).

nicgroupIndex

Description

The NIC group index to which the server belongs.
This will not be displayed if the server is not included in the NIC group.

Type

int

Number of occurrences

As many as there are nic elements (0 or 1 element for each nic element).

nicNo

Description

NIC serial number

Type

int

Number of occurrences

As many as there are nic elements (0 or 1 element for each nic element).

privateIp

Description

IP address

Type

string

Number of occurrences

As many as there are nic elements (0 or 1 element for each nic element).

nicgroups

Description

Element holding the response information for the NIC information.

Type

None

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

nicgroup

Description

Set of NIC information.

Type

None

Number of occurrences

As many as there are nicgroups elements (0 or more elements for each nicgroups element).

management

Description

Control NIC. The value is "1" if the NIC is a control NIC. Otherwise, the value is "0".

Type

int

Number of occurrences

As many as there are nicgroup elements (0 or 1 element for each nicgroup element).

networkId

Description

Network ID

Type

string

Number of occurrences

As many as there are nicgroup elements (0 or 1 element for each nicgroup element).

nicgroupIndex

Description

NIC group index.

Type

int

Number of occurrences

As many as there are nicgroup elements (0 or 1 element for each nicgroup element).

privateIp

Description

IP address

Type

string

Number of occurrences

As many as there are nicgroup elements (0 or 1 element for each nicgroup element).

lserverId

Description

Server ID.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

lserverName

Description

Server name.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

serverType

Description

Server type.

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

vdi

Description

Specifies whether to use VDI coordination.
- true: Use VDI coordination
When the VDI coordination is not used, this tag is not displayed.

Type

string

Number of occurrences

As many as there are lserver elements (0 or more elements for each image element).

vdiConnectInfo

Description

VDI management server connection information

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

vdiPool

Description

VDI pool

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

vdiUser

Description

VDI user name

Type

string

Number of occurrences

As many as there are lserver elements (0 or 1 element for each lserver element).

lplatformId

Description

L-Platform ID.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).

lplatformName

Description

L-Platform name.

Type

string

Number of occurrences

As many as there are lplatform elements (0 or 1 element for each lplatform element).


Sample response

<?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>
    <bladeLogic>true</bladeLogic>
    <connector>none</connector>
    <creator>tenantA</creator>
    <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>
          <description>rule1</description>
          <designtype>UserCustomize</designtype>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <required>true</required>
              <summary>Parameter 1 summary</summary>
              <syntax>INTEGER(0..256)</syntax>
              <value>200</value>
              <view>false</view>
            </parameter>
            <parameter>
              <description>param2</description>
              <name>param_var_002</name>
              <required>true</required>
              <summary>Parameter 2 summary</summary>
              <syntax>DisplayString(SIZE(0..256))</syntax>
              <value/>
              <view>true</view>
            </parameter>
            <parameter>
              <description>param3</description>
              <name>param_var_003</name>
              <required>true</required>
              <summary>Parameter 3 summary</summary>
              <syntax>INTEGER(0..65535)</syntax>
              <value>400</value>
              <view>true</view>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <ownerUser>user3</ownerUser>
    <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>
        <operationLogExist>false</operationLogExist>
        <operations>
         <operation>
          <operationId>ROR_001</operationId>
          <rulesetName>rule1</rulesetName>
          <status>completed</status>
         </operation>
        </operations>
        <ruleset>
          <description>rule1</description>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>param1</description>
              <name>param_var_001</name>
              <required>true</required>
              <summary>Parameter 1 summary</summary>
              <syntax>INTEGER(0..256)</syntax>
              <value>200</value>
              <view>false</view>
            </parameter>
            <parameter>
              <description>param2</description>
              <name>param_var_002</name>
              <required>true</required>
              <summary>Parameter 2 summary</summary>
              <syntax>DisplayString(SIZE(0..256))</syntax>
              <value/>
              <view>true</view>
            </parameter>
            <parameter>
              <description>param3</description>
              <name>param_var_003</name>
              <required>true</required>
              <summary>Parameter 3 summary</summary>
              <syntax>INTEGER(0..65535)</syntax>
              <value>400</value>
              <view>true</view>
            </parameter>
          </parameters>
        </ruleset>
      </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>
        <segmentType>DMZ</segmentType>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>M3PGGWCFX-N-1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <resourceId>mngsrv_1235</resourceId>
        <segmentType>Intranet</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <cpuPerf>1.0</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <hostName>V8O0NW7TZV0001</hostName>
        <lserverType>Physical</lserverType>
        <memorySize>2.0</memorySize>
        <numOfCpu>2</numOfCpu>
        <pool>/ServerPool</pool>
        <priority>128</priority>
        <requestCpuPerf>1.4</requestCpuPerf>
        <requestMemorySize>2.0</requestMemorySize>
        <requestNumOfCpu>1</requestNumOfCpu>
        <resource>
          <name>tenantA-M3PGGWCFX-S-0001</name>
        </resource>
        <snapshotExist>false</snapshotExist>
        <sparePool>/SparePool</sparePool>
        <storagePool>/StoragePool</storagePool>
        <sysvolSize>100</sysvolSize>
        <disks/>
        <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>
      </lserver>
      <lserver>
        <cpuPerf>1.2</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <hostName>V8O0NW7TZV0002</hostName>
        <lserverType>Virtual</lserverType>
        <memorySize>1.6</memorySize>
        <numOfCpu>1</numOfCpu>
        <pool>/VMHostPool</pool>
        <priority>128</priority>
        <resource>
          <name>tenantA-M3PGGWCFX-S-0002</name>
        </resource>
        <snapshotExist>true</snapshotExist>
        <storagePool>/StoragePool</storagePool>
        <sysvolSize>100</sysvolSize>
        <disks/>
        <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>
      </lserver>
    </lservers>
    <lplatformId>tenantA-M3PGGWCFX</lplatformId>
    <lplatformName>firewall-test</lplatformName>
  </lplatform>
</GetLPlatformConfigurationResponse>