PUT /aicc

Use the PUT method to configure Lenovo XClarity Administrator settings (such as NTP server settings, date and time settings, and services that are currently running), change the virtual appliance name, and restart or shutdown the virtual appliance.

Note: Restarting or shutting down the virtual appliance causes any outstanding jobs to be interrupted and stopped. Before calling PUT /aicc to shutdown or restart the virtual appliance, useGET /tasks to check for any outstanding jobs.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/aicc

Query parameters

None

Request body

Attributes Required / Optional Type Description
appliance Optional Object Information about the current instance of the XClarity Administrator virtual appliance
  name Optional String Name of the virtual appliance
  runlevel Optional Integer Appliance run level. This can be one of the following values.
  • 0. Shut down
  • 6. Restart
date Optional Object Information about the current date and time on XClarity Administrator
  parts Optional Array Current date and time
    yyyy Optional Integer Year
    mm Optional Integer Month
    dd Optional Integer Day
    hours Optional Integer Hour
    mins Optional Integer Minute
    secs Optional Integer Second
  time_format Optional String Time format. This can be one of the following values.
  • 12. (default). 12-hour clock

  • 24. 24-hour clock

  timezone_id Optional String Time zone ID
ntp Optional Object Information about the NTP server that is associated with XClarity Administrator
  servers Optional Array of objects List of NTP servers
    server Required String IP address or hostname of the NTP server
    sync Required Boolean Indicates whether XClarity Administrator synchronizes with the NTP server specified with the server attribute.
    version Optional Integer Version of the NTP server. This can be one of the following values.
  • 1. No key authentication is required.

  • 3. NTPv3 is used, and key authentication is required. You must specify the authentication key and index for the NTP server for M-MD5 or SHA1 or both using the v3_key, v3_key_type, and v3_key_index parameters.

    v3_key Optional String Authentication key. This can be one of the following values.
  • For the M-MD5 key, specify an ASCII string.

  • For the SHA1 key, specify a 40-character ASCII string, including only 0–9 and a-f.

Note: The key index and authentication key must match the key ID and password values set on the NTP server. See the documentation for your NTP server for information about setting the key ID and key index.
    v3_key_index Optional String Authentication key index
Note: The key index and authentication key must match the key ID and password values set on the NTP server. See the documentation for your NTP server for information about setting the key ID and password.
    v3_key_type Optional String Authentication key-type. This can be one of the following values.
  • M. M-MD5 authentication.

  • SHA1. SHA1 authentication

preferredDisplayName Optional String Property to use to displayed the device names in the user interface. This can be one of the following values.
  • byDefault. Displays the value that is provided by XClarity Administrator.

  • userDefinedName

  • dnsHostname

  • hostname

  • ipv4Address

  • serialNumber

If the selected property is not applicable or is applicable but there is no value available for a device, then byDefault is used.

preferredSortGridState Optional Boolean Indicates whether to sort the inventory and groups data using the value set for the preferredDisplayName attribute. This can be one of the following values.
  • true. Sorts the inventory and groups data alphabetically using the preferredDisplayName attribute.

  • false. Sorts alphabetically using byDefault.

services Optional Array List of the XClarity Administrator services
  id Optional String Service ID

To obtain the service IDs, use GET /aicc.

  state Optional Integer Current state of the service. This can be one of the following values.
  • 191. Restart the service.
vaSettings Optional Object Cryptographic and certificate settings for this XClarity Administrator instance.
  certificate Optional String Apache server certificate readiness. This can be one of the following values.
  • ready

  • not available. The OS deployment role is not enabled for any XClarity Administrator network interfaces ( see Configuring network access).

  • NA. (default) The certificate is not generated.

  cryptographicMode Optional String Cryptographic mode. This can be one of the following values.
  • COMP. (default) This mode is compatible with older firmware versions, browsers, and other network clients that do not implement strict security standards that are required for compliance with NIST SP 800-131A.

  • NIST. This mode is designed to comply with the NIST SP 800-131A standard.

  • NA.

For more information about these settings, see Configuring cryptography settings.

  tlsMode Optional String Minimum TLS protocol version to use for client connections. This can be one of the following values.
  • tls1.0. (default) TLS v1.0 and later can be used

  • tls1.2. TLS v1.2 and later can be used

  • NA

For more information about these settings, see Configuring cryptography settings.

Request example

The following example sets an NTPv1 server.

{
    "ntp": {
        "servers": [{
            "server": "1.1.1.2",
            "version": 1
        }]
    }
}

The following example sets an NTPv3 server using both M-MD5 and SHA1 authentication:

{
   "ntp": {
      "servers": [{
         "server": "time-a.nist.gov",
         "version": 3
         "v3_key": "123456789012345678901234567890abcdefabcd",
         "v3_key_index": 3,
         "v3_key_type": "M",
      },
      {
         "server": "us.pool.ntp.org",
         "version": 3,
         "v3_key": "123456789012345678901234567890abcdefabcd"
         "v3_key_index": 1,
         "v3_key_type": "SHA1",
      }]
   }
}

The following example synchronizes XClarity Administrator with the NTP server.

{
    "ntp": {
        "servers": [{
            "server": "time-a.nist.gov",
            "sync": "true"
        }]
    }
}
The following example sets the clock setting and time zone.
{
    "date": {
        "time_format": "24",
        "timezone_id": "America/ New_York"
    }
}
The following example sets the date and time.
{
    "date": {
        "parts": {
            "yyyy": 2014,
            "dd": 7,
            "mm": 5,
            "hours": 2,
            "mins": 10,
            "secs": 24
        }
    }
}
The following example restarts network services.
{
    "services": [{
        "id": "network",
        "state": 191
    }]
}
The following example shuts down the virtual appliance.
{
    "appliance": {
        "runlevel": 0
    }
}
The following example restarts the virtual appliance.
{
    "appliance": {
        "runlevel": 6
    }
}
The following example changes the virtual appliance name.
{
    "appliance": {
        "name" : "myAppliance" 
    }
}
The following example displays the device names and sorts tables in the web interface using the IPv6 address of the device.
{
    "preferredDisplayName": "ipv6Address".
   "preferredSortGridState": true
}

Response codes

Code Description
200 OK
400 Bad request

Response body

None