PUT /cmms/{uuid}
Use this method to modify properties , perform a power operation, or refresh inventory for a specific CMM.
The request body differs depending on the action that you want to perform. You can use this PUT method to perform the following management actions.
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/{job_list} 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 created and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.
Authentication
Authentication with username and password is required.
Request URL
PUT https://{management_server_IP}/cmms/{uuid}
where {uuid} is the UUID of the CMM. To obtain the CMM UUID, use the GET /cmms method.
Query parameters
| Attributes | Required / Optional | Description |
|---|---|---|
| synchronous={value} | Optional | When modifying attributes, indicates when the job ID is returned
Note This query parameter applies only when one or more property parameters are specified in the request body. |
Request body
You can specify attributes from one of the following tables in each request.
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| domainName | Optional | String | Domain name | ||
| hostConfig | Optional | Array | |||
| DDNSenabled | Optional | Boolean | Identifies whether Dynamic DNS is enabled. This can be one of the following values.
| ||
| DNSenabled | Optional | Boolean | Identifies whether DNS is enabled. This can be one of the following values.
| ||
| globalIPv6enabled | Optional | String | Global IPv6 enablement | ||
| IPversionPriority | Optional | String | IP version priority. This can be one of the following values.
| ||
| priIPv4userDNSserver | Optional | String | Primary user assigned IPv4 DNS server | ||
| priIPv6userDNSserver | Optional | String | Primary user assigned IPv6 DNS server | ||
| secIPv4userDNSserver | Optional | String | Secondary user assigned IPv4 DNS server | ||
| secIPv6userDNSserver | Optional | String | Secondary user assigned IPv6 DNS server | ||
| terIPv4userDNSserver | Optional | String | Ternary user assigned IPv4 DNS server | ||
| terIPv6userDNSserver | Optional | String | Ternary user assigned IPv6 DNS server | ||
| hostname | Optional | String | Hostname | ||
| ipInterfaces | Optional | Array | Information about the CMM IP addresses | ||
| IPv4assignments | Optional | Array | Information about IPv4 assignments | ||
| address | Optional | String | IPv4 address | ||
| gateway | Optional | String | IPv4 gateway | ||
| id | Required | Integer | IPv4 assignment ID | ||
| subnet | Optional | String | IPv4 subnet mask | ||
| IPv4DHCPmode | Optional | String | IP address assignment method. This can be one of the following values.
| ||
| IPv4enabled | Optional | Boolean | Identifies whether IPv4 is enabled. This can be one of the following values.
| ||
| IPv6assignments | Optional | Array | Information about IPv6 assignments | ||
| address | Optional | String | IPv6 address | ||
| gateway | Optional | String | IPv6 gateway | ||
| id | Required | Integer | IPv6 assignment ID | ||
| prefix | Optional | Integer | IPv6 prefix | ||
| IPv6DHCPenabled | Optional | Boolean | Identifies whether IPv6 DHCP 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.
| ||
| 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.
| ||
| name | Required | String | IP Interface name | ||
The following examples show how to use the PUT method to change CMM configuration settings:
{
"contact": "new contact",
"hostname":"",
"location": {
"location":"new location"
}
}
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| powerState | Optional | String | Performs a power operation on the CMM. This can be one of the following values.
| ||
The following example restarts the CMM.
{
"powerState":"reset"
}
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| refreshInventory | Optional | String | Refreshes inventory for the CMM | ||
The following example refreshes inventory for the target CMM.
{
"refreshInventory": "true"
}
Response codes
| 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. |
| 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. |
Response body
None
Give documentation feedback