2.3.5 CreateLServer (Creates a New Server)

This API creates a server within an L-Platform. The user must always specify the ID of the disk image that is used as the initial content required for the startup disk. The request message is encoded using UTF-8.

This API is executed asynchronously. After the API is successfully executed, the status of the L-Platform changes to Reconfiguring (RECONFIG_ING) during the execution of the operation, and changes back to Operating Normally (NORMAL) when the operation is completed. When the status of an L-Platform is Reconfiguring, the L-Platform cannot be operated. Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.

It cannot be used in the following cases:

When specifying an image for which use of VDI coordination is enabled

Note

When creating a physical server, only two APIs can be executed simultaneously, due to the limitations of the hardware that is set.
When creating more than two physical servers, leave some time between the executions of this API.

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 "CreateLServer".
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.
lserverName	Description	Server name
	Type	string
	Value	No more than 85 characters. However, linefeed codes and the following characters cannot be specified: < > & ' "
serverType	Description	Server type
	Type	string
	Value	No more than 32 characters.
[lserverType]	Description	Server type
	Type	string
	Value	This parameter does not need to be specified.
diskImageId	Description	Disk image ID
	Type	string
	Value	No more than 32 characters.
controlNetworkId	Description	The ID of the network connected to the control NIC.
	Type	string
	Value	If a physical server is to be created, the network ID of the management LAN must be specified. When specifying the IP address of the control NIC, specify the network ID using the following format: controlNetworkId=network_id'xxx:xxx:xxx:xxx
[networkId]	Description	The ID of a network other than the control NIC.
	Type	string
	Value	If there are multiple NICs, specify the network ID using the following format: networkId=network_1''network_2 When specifying the IP address, specify the network ID using the following format: networkId=network_1'xxx:xxx:xxx:xxx''network_2'xxx:xxx:xxx:xxx
[pool]	Description	The resource name of the VM pool or server pool.
	Type	string
	Value	If a tenant pool is to be used, the full path name must be used to specify the pool name. This must be specified when using RHEL-KVM. Example: /tenantA/pool
[storagePool]	Description	The resource name of the storage pool.
	Type	string
	Value	If a tenant pool is to be used, the full path name must be used to specify the pool name. This must be specified when using RHEL-KVM. Example: /tenantA/pool
[cpuPerf]	Description	CPU performance. The value must be specified in GHz, up to one decimal place. Specify a value that is no less than 0.1 and no more than the maximum value specified by the image (or no more than 99999.9 if the maximum value has not been specified). If OVM for SPARC is used, then the value specified for this parameter will be ignored, and the value of the CPU performance of the deployed VM host will be used instead.
	Type	decimal
	Value	0.1 to 99999.9
[numOfCpu]	Description	Number of CPUs
	Type	int
	Value	1 or more. The maximum value is the value that has been specified for each image (or the maximum value for the INT type if no value has been specified).
[cpuReserve]	Description	Reserved CPU performance. Specify a value that is no less than 0.0 and no more than the maximum value specified by either cpuPerf or the image (or no more than 99999.9 if neither of these have been specified).
	Type	decimal
	Value	0.0 to 99999.9.
[cpuShare]	Description	CPU allotment ratio. [When VM type is VMware] CPU Shares. [When VM type is Hyper-V] CPU Weight. For physical servers, this will be ignored even if specified.
	Type	int
	Value	1 to 1000000. [When VM type is VMware] 1 to 1000000. [When VM type is Hyper-V] 1 to 10000.
[memorySize]	Description	Amount of memory. The value must be specified in GB, up to one decimal place. Specify a value that is no less than 0.1 and no more than the maximum value specified by the image (or no more than 99999.9 if the maximum value has not been specified).
	Type	decimal
	Value	0.1 to 99999.9
[memoryReserve]	Description	Reserved memory capacity. Specify a value that is no less than 0.0 and no more than the maximum value specified by either memorySize or the image (or no more than 99999.9 if neither of these have been specified). [When VM type is VMware] Reserved memory capacity. Specify a value that is no less than 0.0 and no more than the maximum value specified by either memorySize or the image (or no more than 99999.9 if neither of these have been specified). [When VM type is Hyper-V] Reserved memory capacity. Specify a value that is no less than 0.1 and no more than the maximum value specified by either memorySize or the image (or no more than 99999.9 if neither of these have been specified). For physical servers, this will be ignored even if specified.
	Type	decimal
	Value	0.0 to 99999.9. [When VM type is VMware] 0.0 to 99999.9. [When VM type is Hyper-V] 0.1 to 99999.9.
[memoryShare]	Description	Memory allotment ratio. [When VM type is VMware] Memory Shares. [When VM type is Hyper-V] Memory Weight. For physical servers, this will be ignored even if specified.
	Type	int
	Value	0 to 1000000. [When VM type is VMware] 0 to 1000000. [When VM type is Hyper-V] 0 to 10000.
[macAddress]	Description	Address set resource name of the MAC address. This value can be specified for RHEL-Xen. When this value is omitted, the default value specified in the setup file will be used. For other than RHEL-Xen, this value will be ignored even if specified.
	Type	string
	Value	No more than 32 characters. However, linefeed codes and the following characters cannot be specified: < > & ' "
[priority]	Description	Priority startup levels when performing batch power supply controls. These values will be started up from small servers. When omitted, the value is set to 128.
	Type	int
	Value	1 to 256
[diskResourceId]	Description	Resource ID of the disk to be used as the system disk. This parameter can only be specified if creating an RHEL-KVM or OVM for SPARC server. However, even if the server is an RHEL-KVM server, this parameter cannot be specified if the storage location type for the image specified in diskImageId is "Virtual Disk". This parameter can be specified when a storage pool is also specified, even on servers with RHEL-KVM. If you specify this parameter and a storage pool, then the storage pool must have the disk.
	Type	int
	Value	0 or 1

Response

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<CreateLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lserverId>[Server ID]</lserverId>
</CreateLServerResponse>

Element name	Item	Item description
CreateLServerResponse	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
lserverId	Description	Server ID
	Type	string
	Number of occurrences	0 or 1

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<CreateLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lserverId>LSERVER000001</lserverId>
</CreateLServerResponse>