2.2.2 CreateNetwork (Add Network Segment to L-Platform)

This API adds a network segment to an L-Platform.
The network segment being added must be registered beforehand.

An automatically selected segment is added when resourceId is omitted.
Specify networkCategory when resourceId is not specified. A segmentType can be omitted.
Do not specify networkCategory and segmentType when resourceId is specified.

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 user ID of the user that executes the L-Platform API.
	Type	string
	Value	Fixed. Specify "CreateNetwork ".
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	ID of the L-Platform to which the network is to be added.
	Type	string
	Value	No more than 32 characters.
[resourceId]	Description	Resource ID of the network to be added.
	Type	string
	Value	No more than 31 characters. Specify this if a networkCategory has not been specified.
numOfMaxNic	Description	Maximum number of NICs.
	Type	string
	Value	Specify the maximum number of NICs that can be added to a network segment. Do not specify a value more than the maximum number of NICs in a segment (the default value is 30), if possible. Refer to "8.5.10 Settings for the Maximum Number of Connections for the L-Platform Template" in the "Operation Guide CE" for information on the maximum number of NICs in a segment.
[networkCategory]	Description	Network type. A network segment of the specified network type is added.
	Type	string
	Value	Specify one of the following: - MANAGEMENT: Management segment - BUSINESS: Business segment Specify this if a resourceId has not been specified.
[segmentType]	Description	Segment identifier information. A network segment of the matching network resource is added.
	Type	string
	Value	No more than 32 characters. If the resourceId parameter is omitted, this parameter can be specified.
[name]	Description	Network name. Specify a name to be set for the network.
	Type	string
	Value	No more than 20 characters. If this parameter is omitted, the following name will be specified. - If resourceId is specified: A network resource name - If networkCategory is specified: AUTOX (X: A serial number starting from 1)

Response

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

<XML>

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

Element name	Item	Item description
CreateNetworkResponse	Description	Element holding the response information.
	Type	None
	Number of occurrences	1
networkId	Description	Added network ID.
	Type	string
	Number of occurrences	1
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chaper 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

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<CreateNetworkResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <networkId>ARHLFXHB3-N-1348104767303</networkId>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CreateNetworkResponse>