Use this method to modify node properties or perform management actions on a specific the server or Flex System storage node.
This method starts a job that runs in the background
to perform the operation. The response header includes a URI in the
form /tasks/{task_id} (for example, /tasks/12
) that represents the job that is created to perform this request.
You can use GET /tasks/detail to
monitor the status and progress of the job. If a job was not successfully
started, refer to the response code and response body for details.
Authentication with user name and password is required.
PUT https://{management_server_IP}/nodes/{uuid}
where {uuid} is the UUID of the node to be retrieved. To obtain the node UUID, use the GET /nodes method.
Parameters | Required / Optional | Description |
---|---|---|
synchronous={Boolean} | Optional | When modifying attributes,
indicates when the job ID is returned
If the powerState=bootToF1 request attribute is specified, indicates when the job ID is returned.
Note: This query parameter applies only when a node-properties
attribute or powerState=bootToF1 attribute is specified in the request body.
|
PUT https://192.0.2.0/nodes/6ED2CB368C594C66C2BB066D5A306138?synchronous=true
You can specify attributes from one of the following tables in each request.
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
cmmDisplayName | Optional | String | Chassis name | ||
contact | Optional | String | The chassis contact information | ||
hostname | Optional | String | Hostname | ||
ipInterfaces | Optional | Array | Information about the CMM IP addresses | ||
name | Required | String | IP Interface name | ||
IPv4enabled | Optional | Boolean | Identifies whether IPv4 is enabled. This can
be one of the following values.
|
||
IPv6enabled | Optional | Boolean | Identifies whether IPv6 is enabled. This can
be one of the following values.
|
||
IPv4DHCPmode | Optional | String | IPv4 address assignment method. This can be
one of the following values.
|
||
IPv6DHCPenabled | Optional | Boolean | Identifies whether IPv6 DHCP is enabled. This
can be one of the following values.
|
||
IPv6statelessEnabled | Optional | Boolean | Identifies whether IPv6 stateless is enabled.
This can be one of the following values.
|
||
IPv6staticEnabled | Optional | Boolean | Identifies whether IPv6 static is enabled. This
can be one of the following values.
|
||
IPv4assignments | Optional | Array | Information about IPv4 assignments | ||
id | Required | Integer | IPv4 assignment ID | ||
subnet | Optional | String | IPv4 subnet mask | ||
gateway | Optional | String | IPv4 gateway | ||
address | Optional | String | IPv4 address | ||
IPv6assignments | Optional | Array | Information about IPv6 assignments | ||
id | Required | Integer | IPv6 assignment ID | ||
prefix | Optional | Integer | IPv6 prefix | ||
gateway | Optional | String | IPv6 gateway | ||
address | Optional | String | IPv6 address | ||
location | Optional | String | (Flex System compute nodes only) Location in
the chassis Important: Changes made to the location of
the server or storage device using this API method are not reflected
in the rack view.
|
||
location | Optional | Object | (Rack and tower servers only) Information about
the location in the rack Important: Changes made to the
location of the server using this API method are not reflected in
the rack view.
|
||
location | Optional | String | Location of the server | ||
rack | Optional | String | Rack | ||
room | Optional | String | Room | ||
lowestRackUnit | Optional | Integer | LRU | ||
name | Optional | String | Server name | ||
userDescription | Optional | String | The server description |
{
"contact": "new contact",
"hostname":"",
"location": {
"location":"new location"
}
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
powerState | Optional | String | Performs a power operation on the device. This
can be one of the following values:
If you specify this attribute, this method
starts a job that runs in the background to perform the operation. The response header includes a URI in the form
/tasks/{task_id} (for example,
/tasks/12 ) that represents the job that is created to perform this request.
You can use GET /tasks/detail to
monitor the status and progress of the job. If a job was not successfully
started, refer to the response code and response body for details.Attention: A
successful response indicates that the request was successfully transmitted
and accepted by the management server. It does not indicate that the
operation that is associated with the job was successful.
|
{
"powerState": "powerCycleSoft"
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
securityDescriptor | Required | Object | Information about the authentication enablement and support the associated stored credentials for a managed device | ||
managedAuthEnabled | Optional | Boolean | Indicates whether the device uses managed authentication. This
can be one of the following values.
|
||
publicAccess | Optional | Boolean | Indicates whether the resource can be accessed by all role
groups. This can be one of the following values.
|
||
roleGroups | Optional | Array of strings | List of role groups that are permitted to view and manage this device | ||
storedCredentials | Required if managedAuthEnabled is set to true | Object | Information about the stored credential that is associated with this device, if applicable. | ||
id | Required if managedAuthEnabled is set to true | String | ID of the stored credential to associated with the device |
{
"securityDescriptor" : {
"managedAuthEnabled" : true,
"storedCredential": {
"id":"249721...",
}
}
}
{
"securityDescriptor": {
"managedAuthEnabled" : false,
}
}
{
"securityDescriptor": {
"publicAccess": false,
"roleGroups": ["sales-os-admin","corp_fw_admin"]
}
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
refreshInventory | Optional | String | Refreshes inventory for the device. If you specify this attribute, this method
starts a job that runs in the background to perform the operation. The response header includes a URI in the form
/tasks/{task_id} (for example,
/tasks/12 ) that represents the job that is created to perform this request.
You can use GET /tasks/detail to
monitor the status and progress of the job. If a job was not successfully
started, refer to the response code and response body for details.Attention: A
successful response indicates that the request was successfully transmitted
and accepted by the management server. It does not indicate that the
operation that is associated with the job was successful.
|
{
"refreshInventory": "true"
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
bootOrder | Optional | Array | Boot order settings | ||
bootOrderList | Required | Array | |||
currentBootOrderDevices | Required | Array of strings | List of potential boot devices Tip: To obtain the boot-order device
values, use in GET /nodes method.
|
||
bootType | Optional | String | Boot type of the boot order setting. This can
be one of the following values.
|
{
"bootOrder": {
"bootOrderList": [{
"currentBootOrderDevices": [
"HardDrive 0",
"CDROM 0",
"Hard Drive 1"
],
"bootType": "BootOrder"
}]
}
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
nist | Optional | Object | Information about NIST | ||
currentValue | Required | String | Cryptography mode that is set. This can be one
of the following values.
|
||
tlsVersion | Optional | Object | Information about the SSL or TLS protocol | ||
currentValue | Required | String | SSL or TLS protocol and version that is set.
This can be one of the following values.
|
{
"nist": {
"currentValue": "Compatibility"
}
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
encapsulationMode | Optional | String | Encapsulation mode. This can be one of the following
values.
|
{
"encapsulationMode": "encapsulationLite
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
leds | Optional | Object | State of the location LED. | ||
name | Required | String | Description of the LED (for example, Faultor Power. To obtain the names of LEDs for a specific server, use the GET /nodes/{uuid_list} method. |
||
state | Required | String | State of LED. This can be one of the following
values.
To obtain the current state of the LED, use the GET /nodes/{uuid_list} method. Note: Location
LED on ThinkServer servers can be on or off. Blinking is not supported.
|
{
"leds":[{
"name":"Information",
"state":"on"
}]
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
selLog | Optional | String | Clears the SEL log for the device. This value
is always cleared. If you specify this attribute, this method
starts a job that runs in the background to perform the operation. The response header includes a URI in the form
/tasks/{task_id} (for example,
/tasks/12 ) that represents the job that is created to perform this request.
You can use GET /tasks/detail to
monitor the status and progress of the job. If a job was not successfully
started, refer to the response code and response body for details.Attention: A
successful response indicates that the request was successfully transmitted
and accepted by the management server. It does not indicate that the
operation that is associated with the job was successful.
|
{
"selLog": "cleared"
}
Attributes | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
assetTag | Required | String | (ThinkSystem rack servers only) Name or Tag that represents the server or other physical enclosure |
{
"assetTag": "Server_1"
}
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
The response body provides information about the success or failure of the request. The attributes in the response body differ depending on the specified request attributes.
The following example is returned when the "refreshInventory": "true" is specified in the request body to refresh the device inventory.
{
"statusCode": 200,
"statusDescription": "The request completed successfully.",
"messages": [{
"explanation": "refreshInventory request for target 6ED2CB368C594C66C2BB066D5A306138 has
completed successfully.",
"id": "FQXDM0200",
"recovery": "",
"recoveryUrl": "",
"text": "The request completed successfully."
}]
}