This API gets configuration information for a server.
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: | |
Action | Description | The name of the L-Platform API to be executed. |
Type | string | |
Value | Fixed. Specify "GetLServerConfiguration". | |
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. | |
lserverId | Description | Server 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"?> <GetLServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>[Message]</responseMessage> <responseStatus>[Status]</responseStatus> <lserver> <cpuPerf>[CPU performance]</cpuPerf> <cpuReserve>[CPU reserve performance]</cpuReserve> <cpuShare>[CPU allotment ratio]</cpuShare> <creator>[Tenant name of the person who created the server]</creator> <diskimageId>[Disk image ID]</diskimageId> <diskimageName>[Disk image name]</diskimageName> <hostName>[Host name of server]</hostName> <image> <adminUser>[Solaris 11 administrator user name]</adminUser> <cpuBit>[Number of bits for the CPU]</cpuBit> <id>[Image ID]</id> <maxCpuPerf>[Maximum CPU performance]</maxCpuPerf> <maxDiskSize>[Maximum amount of disk space]</maxDiskSize> <maxMemorySize>[Maximum amount of memory]</maxMemorySize> <maxSysvolSize>[Maximum capacity of system disk]</maxSysvolSize> <numOfMaxCpu>[Maximum number of CPUs]</numOfMaxCpu> <numOfMaxDisk>[Maximum number of disks]</numOfMaxDisk> <numOfMaxNic>[Maximum number of NICs]</numOfMaxNic> <patches> <patch> <componentName>[Component name]</componentName> <description>[Patch description]</description> <patchId>[Patch ID]</patchId> <softwareId>[Software ID]</softwareId> </patch> </patches> <relation>[Related product name]</relation> <serverApplication>[Server usage]</serverApplication> <serverCategory>[Server type]</serverCategory> <softwares> <software> <category>[Software category]</category> <license>[License information]</license> <name>[Software name]</name> <officialVersion>[Official version]</officialVersion> <patch>[Patch version number]</patch> <softwareId>[Software ID]</softwareId> <support>[Support]</support> <version>[Version]</version> </software> </softwares> <storeType>[Storage location type]</storeType> <sysvolSize>[Size of the system volume]</sysvolSize> <vdi>[Use of VDI coordination]</vdi> <vmType>[Virtual machine type]</vmType> </image> <lserverType>[Server type]</lserverType> <maxDefinableMemorySize>[Maximum amount of memory]</maxDefinableMemorySize> <memoryHotPlug>[Memory hot plug]</memoryHotPlug> <memoryReserve>[Reserved memory capacity]</memoryReserve> <memoryShare>[Memory allotment ratio]</memoryShare> <memorySize>[Memory size]</memorySize> <numOfCpu>[Number of CPUs]</numOfCpu> <pool>[Resource name of the VM pool]</pool> <priority>[Power priority]</priority> <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>[Resource name of the storage pool]</storagePool> <sysvolSize>[The size of the system volume]</sysvolSize> <disks> <disk> <attachedTo>[ID of the virtual machine to which the additional disk has been attached]</attachedTo> <creator>[Tenant name of the person who created the additional disk]</creator> <size>[Size of the additional disk]</size> <storagePool>[The resource name of the storage pool]</storagePool> <diskId>[ID of the additional disk]</diskId> <diskName>[Name of the additional disk]</diskName> <resourceName>[Name of the Existing disk]</resourceName> <shared>[The shared disk attribute]</shared> </disk> </disks> <vmType>[Virtual machine type]</vmType> <nics> <nic> <management>[Control NIC]</management> <networkId>[Network ID]</networkId> <nicgroupIndex>[NIC group index to which the server belongs]</nicgroupIndex> <nicNo>[NIC serial number]</nicNo> <privateIp>[IP addresses]</privateIp> </nic> </nics> <nicgroups> <nicgroup> <management>[Control NIC]</management> <networkId>[Network ID]</networkId> <nicgroupIndex>[NIC group index to which the server belongs]</nicgroupIndex> <privateIp>[IP address]</privateIp> </nicgroup> </nicgroups> <containerPoolManaged>[Flag to indicate whether it is managed by this product]</containerPoolManaged> <lserverId>[Server ID]</lserverId> <lserverName>[Server name]</lserverName> <requestCpuPerf>[Requested CPU performance]</requestCpuPerf> <requestMemorySize>[Requested memory capacity]</requestMemorySize> <requestNumOfCpu>[Requested number of CPUs]</requestNumOfCpu> <serverType>[Server type]</serverType> <task> <progress>[Task progress]</progress> <status>[Task status]</status> <taskId>[Task ID]</taskId> <type>[Task type]</type> </task> <vdi>[Use of VDI coordination]</vdi> <vdiConnectInfo>[VDI management server connection information]</vdiConnectInfo> <vdiPool>[VDI pool]</vdiPool> <vdiUser>[VDI user name]</vdiUser> </lserver> </GetLServerConfigurationResponse>
<Elements>
Element name | Item | Item description |
---|---|---|
GetLServerConfigurationResponse | 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 | |
lserver | Description | Set of server information. |
Type | None | |
Number of occurrences | 0 or 1 | |
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 | Reserved CPU 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). | |
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 server |
Type | string | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver element). | |
image | Description | Set of image information. |
Type | None | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver element). | |
adminUser | Description | Solaris 11 administrator user name |
Type | string | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
cpuBit | Description | Number of bits for the CPU. One of the following values: |
Type | string | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
id | Description | Image ID. |
Type | string | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
maxCpuPerf | Description | Maximum CPU performance. |
Type | decimal | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
maxDiskSize | Description | Maximum amount of disk space. |
Type | decimal | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
maxMemorySize | Description | Maximum amount of memory. |
Type | decimal | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
maxSysvolSize | Description | Maximum capacity of system disk. |
Type | decimal | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
numOfMaxCpu | Description | Maximum number of CPUs. |
Type | int | |
Number of occurrences | As many as there are image elements (0 or 1 element for each software element). | |
numOfMaxDisk | Description | Maximum number of disks. |
Type | int | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
numOfMaxNic | Description | Maximum number of NICs. |
Type | int | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
patches | Description | Element holding the response information for the patch information. |
Type | None | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
patch | Description | Set of patch information. |
Type | None | |
Number of occurrences | As many as there are patches elements (0 or more elements for each patches element). | |
componentName | Description | Component name. |
Type | string | |
Number of occurrences | As many as there are patch elements (0 or 1 element for each patch element). | |
description | Description | Patch description. |
Type | string | |
Number of occurrences | As many as there are patch elements (0 or 1 element for each patch element). | |
patchId | Description | Patch ID. |
Type | string | |
Number of occurrences | As many as there are patch elements (0 or 1 element for each patch element). | |
softwareId | Description | Software ID. |
Type | string | |
Number of occurrences | As many as there are patch elements (0 or 1 element for each patch element). | |
relation | Description | Related product name |
Type | string | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
serverApplication | Description | Server usage. One of the following values: |
Type | string | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
serverCategory | Description | Server type. The value of this item is "GENERAL", indicating a generic server. |
Type | string | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
softwares | Description | Element holding the response information for the software information. |
Type | None | |
Number of occurrences | As many as there are image elements (0 or 1 element for each image element). | |
software | Description | Set of software information. |
Type | None | |
Number of occurrences | As many as there are softwares elements (0 or more elements for each softwares element). | |
category | Description | Software category. One of the following values: |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
license | Description | License. |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
name | Description | Software name. |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
officialVersion | Description | Official version |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
patch | Description | Patch version. |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
softwareId | Description | Software ID. |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
support | Description | Support. |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
version | Description | Version number. |
Type | string | |
Number of occurrences | As many as there are software elements (0 or 1 element for each software element). | |
storeType | Description | Storage location type. This is one of the following: - Virtual Disk: Virtual storage |
Type | string | |
Number of occurrences | As many as there are image elements (0 or more elements for each image element). | |
sysvolSize | Description | The size of the system volume. |
Type | decimal | |
Number of occurrences | As many as there are image elements (0 or more elements for each image element). | |
vdi | Description | Specifies whether to use VDI coordination. |
Type | string | |
Number of occurrences | As many as there are image elements (0 or more elements for each image element). | |
vmType | Description | Virtual machine type. |
Type | string | |
Number of occurrences | As many as there are image elements (0 or more elements for each image element). | |
lserverType | Description | Server type. One of the following: |
Type | string | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver element). | |
maxDefinableMemorySize | Description | Maximum amount of memory. |
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. When memory hot plug is enabled, the maximum amount of memory that can be changed is limited to the least of the following: MAXDefinableMemorySize |
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). | |
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). | |
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). | |
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. |
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. |
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: |
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 lserver 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). | |
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). | |
resourceName | Description | The name of the existing disk. |
Type | string | |
Number of occurrences | As many as there are disk elements (0 or 1 element for each disk element). | |
shared | Description | The shared disk attribute |
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. |
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. |
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). | |
containerPoolManaged | Description | Flag indicating whether the container resource pool where the server operates is managed by this product. This is one of the following: |
Type | string | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver 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). | |
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). | |
serverType | Description | Server type. |
Type | string | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver element). | |
task | Description | Set of information about the latest backup or restoration task. |
Type | None | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver element). | |
progress | Description | Task progress rate. The units are "%". The value is a number between 0 and 100. |
Type | int | |
Number of occurrences | As many as there are task elements (0 or 1 element for each task element). | |
status | Description | Task status. One of the following values: |
Type | string | |
Number of occurrences | As many as there are task elements (0 or 1 element for each task element). | |
taskId | Description | Task ID. |
Type | string | |
Number of occurrences | As many as there are task elements (0 or 1 element for each task element). | |
type | Description | Task type. One of the following values: |
Type | string | |
Number of occurrences | As many as there are task elements (0 or 1 element for each task element). | |
vdi | Description | Specifies whether to use VDI coordination. |
Type | string | |
Number of occurrences | As many as there are lserver elements (0 or 1 element for each lserver 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). |
Sample response
<?xml version="1.0" encoding="UTF-8"?> <GetLServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> <lserver> <cpuPerf>1.4</cpuPerf> <cpuReserve>0.8</cpuReserve> <cpuShare>800</cpuShare> <creator>tenantD</creator> <diskimageId>image-13f2b6162a3</diskimageId> <diskimageName>g-vm-0002</diskimageName> <hostName>VHY43YHSWA0001</hostName> <image> <cpuBit>64</cpuBit> <id>image-13f2b6162a3</id> <maxCpuPerf>1.4</maxCpuPerf> <maxDiskSize>500.0</maxDiskSize> <maxMemorySize>2.0</maxMemorySize> <maxSysvolSize>70.0</maxSysvolSize> <numOfMaxCpu>1</numOfMaxCpu> <numOfMaxDisk>5</numOfMaxDisk> <numOfMaxNic>1</numOfMaxNic> <serverApplication>WEB</serverApplication> <serverCategory>GENERAL</serverCategory> <softwares> <software> <category>OS</category> <license/> <name>Windows Server 2008 R2 Enterprise</name> <officialVersion/> <patch/> <softwareId>SW00000007</softwareId> <support/> <version>6.1</version> </software> </softwares> <sysvolSize>70.0</sysvolSize> <vmType>VMware</vmType> </image> <lserverType>Virtual</lserverType> <memoryReserve>1.0</memoryReserve> <memoryShare>2000</memoryShare> <memorySize>2.0</memorySize> <numOfCpu>1</numOfCpu> <pool>/VMPool</pool> <priority>128</priority> <resource> <name>tenantD-HY43YHSWA-S-0001</name> </resource> <snapshotExist>false</snapshotExist> <storagePool>/StoragePool</storagePool> <sysvolSize>70.0</sysvolSize> <disks> <disk> <attachedTo>tenantD-HY43YHSWA-S-0001</attachedTo> <creator>tenantD</creator> <size>400.0</size> <storagePool>/StoragePool</storagePool> <diskId>tenantD-HY43YHSWA-D-0001</diskId> <diskName>DISK0</diskName> </disk> <disk> <attachedTo>tenantD-HY43YHSWA-S-0001</attachedTo> <creator>tenantD</creator> <size>500.0</size> <storagePool>/StoragePool</storagePool> <diskId>tenantD-HY43YHSWA-D-0002</diskId> <diskName>DISK1</diskName> </disk> </disks> <vmType>VMware</vmType> <nics> <nic> <management>1</management> <networkId>HY43YHSWA-N-360r#FWS#</networkId> <nicNo>1</nicNo> <privateIp>192.168.21.60</privateIp> </nic> </nics> <lserverId>tenantD-HY43YHSWA-S-0001</lserverId> <lserverName>AP1</lserverName> <serverType>over_commit</serverType> </lserver> </GetLServerConfigurationResponse>