This API adds an NIC to a server.
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.
This API can only be executed when the server virtualization software on the server is VMware, Hyper-V, RHEL-KVM, or OVM for SPARC.
If the target server has snapshots, NIC addition cannot be done.
It cannot be used in the following cases:
The target server is a server for which modification configurations or deletion cannot be performed.
For the servers for which configuration modification and deletion cannot be performed, refer to "8.3.18 L-Platform Reconfiguration" in the "User's Guide for Tenant Administrators CE".
Note
When NIC is added, the automatic setting of Internet Protocol address on guest OS is not done.
Log in guest OS after adding NIC, and set IP address displayed in detailed information of L-Server to guest OS manually.
Confirm added NIC can be correctly communicated with the external instrument after IP address is set.
When two or more NIC is added, it is recommended to add it one by one.
If the target server is an OVM for SPARC server, only the management information for this product is added or deleted. The actual NIC of the VM guest is not added or deleted.
Add or delete the actual NICs with the server virtualization software.
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 "CreateNic". | |
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 | |
lserverId | Description | Server ID |
Type | string | |
Value | No more than 32 characters | |
networkId | Description | Network ID connecting the added NIC |
Type | string | |
Value | No more than 32 characters | |
[ipAddress] | Description | IP address assigned to the added NIC. |
Type | string | |
Value | None |
Response
<Status code>
The API returns "200 OK" if it terminates normally.
<XML>
<?xml version="1.0" encoding="UTF-8"?> <CreateNicResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>[Message]</responseMessage> <responseStatus>[Status]</responseStatus> </CreateNicResponse>
<Elements>
Element name | Item | Item description |
|---|---|---|
CreateNicResponse | 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. |
Type | string | |
Number of occurrences | 1 |
Sample response
<?xml version="1.0" encoding="UTF-8"?> <CreateNicResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> </CreateNicResponse>
