2.2.1 CreateLPlatform (Creates an L-Platform)

This API creates an L-Platform based on a template.
If the template contains servers with the same name, then each one will be suffixed with a unique number (starting from 1).

This API is executed asynchronously. During deployment the status of the L-Platform shifts to DEPLOYING, while configuring software it shifts to SETUP, and when deployment is complete, the status of the L-Platform becomes NORMAL.
Operation of an L-Platform is not possible until the status of the L-Platform has shifted to NORMAL.
Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.

Note

When a physical server is included in a template, only two APIs can be executed simultaneously, due to the limitations of the hardware that is set.
When creating 2 or more L-Platforms with physical servers, leave some time between the executions of this API.
When an L-Platform template that includes a segment specifying [Auto-Select] is specified, limit the number of CreateLPlatform APIs that are simultaneously executed so that the number of IP addresses required on all L-Platforms that will be deployed concurrently is no greater than the highest number of available IP addresses in those segments that will be selected automatically.
For example, if two segments will be selected automatically, and these segments have 5 and 4 available IP addresses respectively, up to five APIs can be executed simultaneously if one IP address per L-Platform is required.
When there are multiple servers that use VDI coordination in the target L-Platform template, it is not possible to create an L-Platform using this API.
It is not possible to specify an L-Platform template that does not have a segment or server defined.

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 "CreateLPlatform".
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.
lplatformDescriptorId	Description	L-Platform template ID.
	Type	string
	Value	No more than 32 characters.
lplatformName	Description	L-Platform name.
	Type	string
	Value	No more than 85 characters. However, linefeed codes and the following characters cannot be specified: < > & ' "
vdiUser	Description	VDI user name
	Type	string
	Value	Specify this when there is a server that uses VDI coordination in the L-Platform to be deployed, and the user of VDI differs from the one specified in "userId". If this is specified when there is no server that uses VDI coordination, it will be ignored.

Response

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

<XML>

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

Element name	Item	Item description
CreateLPlatformResponse	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
lplatformId	Description	L-Platform ID.
	Type	string
	Number of occurrences	0 or 1

Sample response

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