PUT /cmms/<UUID>

Use the PUT 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/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.

Authentication

Authentication with user name 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
  • true. (default) Returns the job ID and job status after the job is complete.

  • false. Returns the job ID immediately. You can use GET /tasks/detail to monitor the status and progress of the job.

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.

Table 1. Modify CMM properties.
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.
  • true. Dynamic DNS is enabled
  • false. Dynamic DNS is disabled
  DNSenabled Optional Boolean Identifies whether DNS is enabled. This can be one of the following values.
  • true. DNS is enabled
  • false. DNS is disabled
  globalIPv6enabled Optional String Global IPv6 enablement
  IPversionPriority Optional String IP version priority. This can be one of the following values.
  • IPv6ThenIPv4
  • IPv4ThenIPv6
  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.
  • STATIC_ONLY
  • DHCP_ONLY
  • DHCP_THEN_STATIC
  • UNKNOWN
  IPv4enabled Optional Boolean Identifies whether IPv4 is enabled. This can be one of the following values.
  • true. IPv4 is enabled
  • false. IPv4 is disabled
  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.
  • true. IPv6 DHCP is enabled
  • false. IPv6 DHCP is disabled
  IPv6enabled Optional Boolean Identifies whether IPv6 is enabled. This can be one of the following values.
  • true. IPv6 is enabled
  • false. IPv6 is disabled
  IPv6statelessEnabled Optional Boolean Identifies whether IPv6 stateless is enabled. This can be one of the following values.
  • true. IPv6 stateless is enabled
  • false. IPv6 stateless is disabled
  IPv6staticEnabled Optional Boolean Identifies whether IPv6 static is enabled. This can be one of the following values.
  • true. IPv6 static is enabled
  • false. IPv6 static is disabled
  name Required String IP Interface name
Table 2. Modifying the power state
Attributes Required / Optional Type Description
powerState Optional String Performs a power operation on the CMM. This can be one of the following values.
  • reset. Restart the CMM.
  • virtualReseat. Simulates removing power from the bay
Table 3. Refresh the inventory
Attributes Required / Optional Type Description
refreshInventory Optional String Refreshes inventory for the CMM

Request example

The following examples show how to use the PUT method to change CMM configuration settings:
{
    "contact": "new contact",
    "hostname":"", 
    "location": { 
        "location":"new location"
    }
}
The following example refreshes inventory for the target CMM.
{
   "refreshInventory": "true" 
}
The following example restarts the CMM.
{
   "powerState":"reset"
}

Response codes

Code Description
200 OK.
400 Bad request.
401 Unauthorized.
403 Forbidden.
409 Conflict
500 Internal Server Error

Response body

None