This API updates the attributes of a server.
The attributes that can be updated are the server name and the host name. Either the server name or the host name must be specified.
When "host-name-method=2(server name)", if only the server name is specified the host name will be changed to the same name as the server name. When the host name is specified, it will be changed to the specified name.
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:
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".
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 "StopLServer". | |
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. | |
lserverId | Description | Server ID |
Type | string | |
Value | No more than 32 characters. | |
[lserverName] | Description | Server name |
Type | string | |
Value | The number and types of characters that can be used for specification varies depending on the setting. | |
[hostName] | Description | Host name of the server |
Type | string | |
Value | When the OS of the managed server is Windows, specify using up to 15 characters. For other OSs, specify using up to 63 characters. |
Response
<Status code>
The API returns "200 OK" if it terminates normally.
<XML>
<?xml version="1.0" encoding="UTF-8"?> <UpdateLServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>[Message]</responseMessage> <responseStatus>[Status]</responseStatus> </UpdateLServerAttributesResponse>
<Elements>
Element name | Item | Item description |
|---|---|---|
UpdateLServerAttributesResponse | 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"?> <UpdateLServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> </UpdateLServerAttributesResponse>
