Skip to main content

GET /cmms

Use this method retrieve the properties for all CMMs.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/cmms

Query parameters​

ParametersRequired / OptionalDescription
excludeAttributes={attributes}OptionalReturns a response that excludes the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note
  • When the includeAttributes query parameter is specified, the excludeAttributes query parameter is ignored.
  • The response is filtered based on attribute name, not the attribute value.
  • Base attributes cannot be excluded.
includeAttributes=<attributes}OptionalReturns a response that includes the base attributes and the specified attributes for each resource. You can specify one or more attributes that are listed in the response body, separated by a comma.
Note
  • The response is filtered based on attribute name, not the attribute value.
  • If this attribute is not specified, all attributes are returned by default.

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
403ForbiddenThe 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.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
cmmListArrayList of CMMs
 See GET /cmms/{uuid_list}ObjectDetailed information for each CMM
The following example is returned if the request is successful.
{
"cmmList": [{
   "accessState": "Online",
   "backedBy": "real",
   "cmmDisplayName": "SN#Y033BG24B009",
   "cmmHealthState": "Non-Critical",
   "dataHandle": 1442012140925,
   "description": "Chassis Management Module",
   "dnsHostnames": ["demoblue1.labs.lenovo.com"],
   "domainName": "labs.lenovo.com",
   "errorFields": [],
   "excludedHealthState": "Warning",
   
   "firmware": [{
      "build": "2PET27F",
      "date": "2015-04-08T04:00:00Z",
      "name": "CMM firmware",
      "role": "",
      "status": "",
      "type": "CMM firmware",
      "version": "2.5.3"
   }],
   "FRU": "68Y7032",
   "fruSerialNumber": "Y033BG24B009",
   "hostConfig": [{
      "DDNSenabled": false,
      "DNSenabled": true,
      "IPversionPriority": "IPv4ThenIPv6",
      "priIPv4userDNSserver": "10.240.0.10"
      "priIPv6userDNSserver": "0:0:0:0:0:0:0:0",
      "secIPv4userDNSserver": "10.240.0.11",
      "secIPv6userDNSserver": "0:0:0:0:0:0:0:0",
      "terIPv4userDNSserver": "0.0.0.0",
      "terIPv6userDNSserver": "0:0:0:0:0:0:0:0",
   }],
   "hostname": "demoblue1",
   "ipInterfaces": [{
      "IPv4assignments": [{
         "address": "10.240.70.134",
         "gateway": "10.240.70.1",
         "id": 2,
         "subnet": "255.255.254.0",
         "type": "CONFIGURED"
      },
      {
         "address": "10.240.70.134",
         "gateway": "10.240.70.1",
         "id": 2,
         "subnet": "255.255.254.0",
         "type": "INUSE"
      }],
      "IPv4DHCPmode": "STATIC_ONLY",
      "IPv4enabled": true,
      "IPv6assignments": [{
         "address": "fe80:0:0:0:5ef3:fcff:fe25:ea57",
         "gateway": "0:0:0:0:0:0:0:0",
         "id": 1,
         "prefix": 64,
         "scope": "LinkLocal",
         "source": "Other",
         "type": "INUSE"
      },
      {
         "address": "0:0:0:0:0:0:0:0",
         "gateway": "0:0:0:0:0:0:0:0",
         "id": 2,
         "prefix": 0,
         "scope": "Global",
         "source": "Static",
         "type": "CONFIGURED"
      }],
      "IPv6DHCPenabled": false,
      "IPv6enabled": true,
      "IPv6statelessEnabled": true,
      "IPv6staticEnabled": false
      "label": "External",
      "name": "eth0",
   }],
   "ipv4Addresses": ["10.240.70.134"],
   "ipv6Addresses": ["fe80:0:0:0:5ef3:fcff:fe25:ea57"],
   "leds": [{
      "color": "Blue",
      "location": "FrontPanel",
      "name": "Location",
      "state": "Off"
   },
   {
      "color": "Amber",
      "location": "FrontPanel",
      "name": "FAULT",
      "state": "On"
   },
   {
      "color": "Amber",
      "location": "FrontPanel",
      "name": "Information",
      "state": "On"
   }],
   "macAddresses": ["5C:F3:FC:25:EA:57"],
   "machineType": "",
   "mgmtProcIPaddress": "10.240.70.134",
   "model": "",
   "name": "SN#Y033BG24B009",
   "overallHealthState": "Warning",
   "parent": {
      "uri": "chassis/AB582DD17E604572A4679E24BE2938DE",
      "uuid": "AB582DD17E604572A4679E24BE2938DE"
   },
   "partNumber": "00D7179",
   "powerAllocation": {
      "maximumAllocatedPower": 20,
      "minimumAllocatedPower": 20
   },
   "productId": "432",
   "role": "primary",
   "serialNumber": "",
   "slots": [1],
   "type": "CMM",
   "uri": "cmm/2A14E8448B5B11E1B942C430BE6956C4"
   "userDefinedName": "CMM1",
   "userDescription": "",
   "uuid": "2A14E8448B5B11E1B942C430BE6956C4",
}]
}