GET /inventory/cmc/ManagementConsole

Returns the inventory details about all the management consoles that are connected to CMC.

Important: The versions v1 and v2 have the same response syntax. The information explained in this document uses the latest version v2. The same information also applies to v1. To use version v1 of this API, replace v2 by v1.

Resource Information

Response formats	JSON
Requires authentication?	Yes
Rate limited?	All API calls are automatically rate limited to a maximum of 10 calls per second.

Request Syntax

• For all management consoles: GET /v2/inventory/cmc/ManagementConsole
• For a particular management console: GET /v2/inventory/cmc/ManagementConsole/{uuid}

URI Request Parameters

The request uses the following URI parameters:

Parameter	Required?	Description
uuid	Optional	The universally unique identifier (UUID) for a management console. If you do not specify the UUID, details of all the management consoles are displayed.

Notes:

• If you have enabled the attribute masking feature, the values of the resource attributes will be masked in the API response.
• Attribute Masking is available with HMC V1040 and later.

Request headers

Authenticate the API by completing the following steps:

1. Set your client ID value in the X-CMC-Client-Id header in every request.
2. Set the client secret value in the X-CMC-Client-Secret header in every request.

To form the CMC API full URL, append the relative path of the endpoint you want to use to the Base URL. 

Example: https://<portal-url>/api/public/v2/inventory/cmc/ManagementConsole/{uuid}

Request body

This request does not have a request body.

Response Syntax and Description

To review the response schema and for information about the parameters, see Response schema and parameter description for /inventory/cmc/ManagementConsole.

Errors

The following errors are the common errors for this API:

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

Sample Request

Review the following examples to understand how the API request and response work.

Sample request for all management consoles

GET /api/public/v2/inventory/cmc/ManagementConsole/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx HTTP/1.1

Host: xxxxxxxxxxxx.powercmc.com

x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Sample request for a particular management console

GET /api/public/v2/inventory/cmc/ManagementConsole/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx HTTP/1.1

Host: xxxxxxxxxxxx.powercmc.com

x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Sample Response

The following response is a sample response for a particular management console.

 {

  "HMCs": [

    {

      "MTMS": {

        "SerialNumber": "xxxxxxx",

        "MachineType": "V357",

        "Model": "f6d"

      },

      "ManagedSystems": [

        {

          "MTMS": {

            "MachineType": "9009",

            "Model": "22A",

            "SerialNumber": "xxxxxxx"

          },

          "Link": "/api/public/v2/inventory/cmc/ManagedSystem/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",

          "Name": "xxxxxxxx",

          "State": "operating",

          "UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

        }

      ],

      "Name": "xxxxxxxx",

      "MemoryConfiguration": {

        "TotalMemory": 15.64,

        "TotalSwapMemory": 4

      },

      "ProcessorConfiguration": {

        "Processors": 4,

        "ModelName": "Intel(R) Xeon(R) Gold 6242R CPU @ 3.10GHz",

        "Architecture": "x86_64"

      },

      "State": "Active",

      "Tags": [

        {

          "Name": "Test"

        }

      ],

      "UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",

      "UVMID": "xxxx:xxxx:xxxx:xxxx",

      "VersionInfo": {

        "BuildLevel": "2303271530",

        "Maintenance": "0",

        "Minor": "0",

        "Release": "2",

        "Version": "10",

        "ServicePackName": "1040"

      },

      "NetworkInterfaces": [

        {

          "InterfaceName": "eth2",

          "NetworkAddress": "xxx.xxx.xxx.xxx"

        }

      ]

    }

  ]

}