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

2.1.9 ListServerType (Gets a List of L-Server Templates)

This API gets a list of the server image types in the virtual data center.

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

Response

<Status code>

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListServerTypeResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <servertypes>
    <servertype>
      <comment>[Comment]</comment>
      <cpu>
        <cpuArch>[CPU architecture]</cpuArch>
        <cpuPerf>[CPU performance]</cpuPerf>
        <cpuReserve>[CPU reserve performance]</cpuReserve>
        <cpuShare>[CPU allotment ratio]</cpuShare>
        <numOfCpu>[Number of CPUs]</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>[Disk index]</diskIndex>
          <diskSize>[Disk capacity]</diskSize>
        </disk>
      </disks>
      <id>[ID]</id>
      <label>[Label]</label>
      <memory>
        <memoryReserve>[Reserved memory capacity]</memoryReserve>
        <memoryShare>[Memory allotment ratio]</memoryShare>
        <memorySize>[Memory size]</memorySize>
      </memory>
      <name>[L-Server template name]</name>
      <nics>
        <numOfNIC>[Number of NICs]</numOfNIC>
      </nics>
      <serverPolicy>
        <aliveMonitoring>[Heartbeat]</aliveMonitoring>
        <positioning>[Operation positioning]</positioning>
        <redundancy>[Redundancy]</redundancy>
        <repurpose>[Server automatically released when power is off]</repurpose>
      </serverPolicy>
      <lserverType>[Server type]</lserverType>
      <vmType>[Virtual machine type]</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>

<Elements>

Element name	Item	Item description
ListServerTypeResponse	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
servertypes	Description	Element holding the response information for the server type information
	Type	None
	Number of occurrences	0 or 1
servertype	Description	Set of server type information
	Type	None
	Number of occurrences	As many as there are servertypes elements (0 or more elements for each servertypes element).
comment	Description	Comment
	Type	string
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
cpu	Description	Set of CPU information
	Type	None
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
cpuArch	Description	CPU architecture. One of the following values: - IA: IA - SPARC: SPARC
	Type	string
	Number of occurrences	As many as there are cpu elements (0 or 1 element for each cpu element).
cpuPerf	Description	CPU performance
	Type	decimal
	Number of occurrences	As many as there are cpu elements (0 or 1 element for each cpu element).
cpuReserve	Description	CPU reserve performance
	Type	decimal
	Number of occurrences	As many as there are cpu elements (0 or 1 element for each cpu element).
cpuShare	Description	CPU allotment ratio
	Type	int
	Number of occurrences	As many as there are cpu elements (0 or 1 element for each cpu element).
numOfCpu	Description	Number of CPUs
	Type	int
	Number of occurrences	As many as there are cpu elements (0 or 1 element for each cpu element).
disks	Description	Element holding the response information for the disk information.
	Type	None
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
disk	Description	Set of disk information
	Type	None
	Number of occurrences	As many as there are disks elements (0 or more elements for each disks element).
diskIndex	Description	Disk index
	Type	int
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
diskSize	Description	Disk capacity
	Type	decimal
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
id	Description	Servertype ID
	Type	string
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
label	Description	Label
	Type	string
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
lservertype	Description	Server type. One of the following values: - Physical: Physical server - Virtual: Virtual server
	Type	string
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
memory	Description	Set of memory information
	Type	None
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
memoryReserve	Description	Reserved memory capacity
	Type	decimal
	Number of occurrences	As many as there are memory elements (0 or 1 element for each memory element).
memoryShare	Description	Memory allotment ratio
	Type	int
	Number of occurrences	As many as there are memory elements (0 or 1 element for each memory element).
memorySize	Description	Memory size
	Type	decimal
	Number of occurrences	As many as there are memory elements (0 or 1 element for each memory element).
name	Description	L-Server template name
	Type	string
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
nics	Description	Set of NIC information
	Type	None
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
numOfNIC	Description	Number of NICs
	Type	int
	Number of occurrences	As many as there are nics elements (0 or 1 element for each nics element).
serverPolicy	Description	Set of server policy information
	Type	None
	Number of occurrences	As many as there are servertype elements (0 or 1 element for each servertype element).
aliveMonitoring	Description	Heartbeat. One of the following values: - true: valid - false: invalid
	Type	string
	Number of occurrences	As many as there are serverPolicy elements (0 or 1 element for each serverPolicy element).
positioning	Description	Operation positioning. One of the following values: - Fixed: The position is fixed - AttachAtBoot: The position can be varied at boot time - Flexible: The position can be varied during operations
	Type	string
	Number of occurrences	As many as there are serverPolicy elements (0 or 1 element for each serverPolicy element).
redundancy	Description	Redundancy
	Type	string
	Number of occurrences	As many as there are serverPolicy elements (0 or 1 element for each serverPolicy element).
repurpose	Description	Server automatically released when power is off. Select one of the following: - true: Automatically release - false: Do not release
	Type	string
	Number of occurrences	As many as there are serverPolicy elements (0 or 1 element for each serverPolicy 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 servertype elements (0 or 1 element for each servertype element).

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListServerTypeResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <servertypes>
    <servertype>
      <comment>comment1</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>2.6</cpuPerf>
        <cpuReserve>0.0</cpuReserve>
        <cpuShare>1000</cpuShare>
        <numOfCpu>4</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>template-0001</id>
      <label>vmware-template-1</label>
      <lserverType>Virtual</lserverType>
      <memory>
        <memoryReserve>8</memoryReserve>
        <memoryShare>81920</memoryShare>
        <memorySize>8</memorySize>
      </memory>
      <name>High_Performance</name>
      <nics>
        <numOfNIC>1</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>Fixed</positioning>
        <redundancy>None</redundancy>
        <repurpose>true</repurpose>
      </serverPolicy>
      <vmType>VMware</vmType>
    </servertype>
    <servertype>
      <comment>comment2</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>2.0</cpuPerf>
        <numOfCpu>2</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>template-0002</id>
      <label>physical-template-2</label>
      <lserverType>Physical</lserverType>
      <memory>
        <memorySize>4</memorySize>
      </memory>
      <name>Middle_Spec</name>
      <nics>
        <numOfNIC>1</numOfNIC>
      </nics>
      <serverPolicy>
        <aliveMonitoring>false</aliveMonitoring>
        <positioning>Fixed</positioning>
        <redundancy>HA</redundancy>
        <repurpose>false</repurpose>
      </serverPolicy>
    </servertype>
  </servertypes>
</ListServerTypeResponse>