GET /cmms/`{uuid_list}`

Use this method retrieve the properties for one or more specific CMMs.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/cmms/{uuid_list}

where {uuid_list} is one or more UUIDs, separated by a comma, of the CMMs to be retrieved. To obtain the CMM UUIDs, use the GET /cmms method.

Query parameters

Parameters	Required / Optional	Description
excludeAttributes=`{attributes}`	Optional	Returns 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}`	Optional	Returns 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

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.
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

Attributes			Type	Description
accessState			String	Access state of the chassis. This can be one of the following values. Online Offline Partial Pending Unknown
backedBy			String	Indicates whether the data is from a real or demo server. This can be one of the following values. real. The inventory describes real hardware. demo. The inventory describes demo (mock) hardware. proxy. A proxy is temporarily serving to provide the inventory.
cmmDisplayName			String	Display name provided by the CMM
cmmHealthState			String	Health summary that corresponds to the highest event severity of all the devices. This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
dataHandle			Long	Time stamp of the last status update
description			String	Description that was provided by the CMM
dnsHostnames			Array of strings	List of DNS hostnames
domainName			String	User-defined domain name
errorFields			Array of objects that contain `{string, errorCode}`	Error code. This can be one of the following values. FETCH_SUCCESS FETCH_FAILED NO_CONNECTOR FATAL_EXCEPTION NETWORK_FAIL
excludedHealthState			String	Highest severity alert with exclusions. This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
firmware			Array	CMM firmware details
	build		String	Firmware build
	date		String	Firmware date
	name		String	Firmware name
	role		String	Firmware role
	status		String	Firmware status
	type		String	Firmware type
	version		String	Firmware version
FRU			String	CMM FRU part number
fruSerialNumber			String	CMM FRU serial number
hostConfig			Array	Information about host configuration
	DDNSenabled		Boolean	Identifies whether dynamic DNS enabled. This can be one of the following values. true. Dynamic DNS is enabled. false. Dynamic DNS is disabled.
	DNSenabled		Boolean	Identifies whether DNS enabled. This can be one of the following values. true. DNS is enabled. false. DNS is disabled.
	IPversionPriority		String	IP version priority. This can be one of the following values. IPv6ThenIPv4 IPv4ThenIPv6
	priIPv4userDNSserver		String	Primary user assigned IPv4 DNS server
	priIPv6userDNSserver		String	Primary user assigned IPv6 DNS server
	secIPv4userDNSserver		String	Secondary user assigned IPv4 DNS server
	secIPv6userDNSserver		String	Secondary user assigned IPv6 DNS server
	terIPv4userDNSserver		String	Tertiary user assigned IPv4 DNS server
	terIPv6userDNSserver		String	Ternary user assigned IPv6 DNS server
hostname			String	User-defined hostname
ipInterfaces			Array	Information about the CMM IP interfaces
	IPv4assignments		Array	Information about IPV4 assignments
		address	String	IP address
		gateway	String	Gateway
		id	Integer	IPv4 assignment ID
		subnet	String	Subnet mask
		type	String	IPv4 assignment type. This can be one of the following values. INUSE CONFIGURED ALIAS UNKNOWN
	IPv4DHCPmode		String	IPv4 assignment method. This can be one of the following values. STATIC_ONLY DHCP_ONLY DHCP_THEN_STATIC UNKNOWN
	IPv4enabled		Boolean	Identifies whether IPv4 is enabled. This can be one of the following values. true. IPv4 is enabled. false. IPv4 is disabled.
	IPv6assignments		Array	Information about IPV6 assignments
		address	String	IPv6 address
		gateway	String	Gateway
		id	Integer	IPv6 assignment ID
		prefix	Integer	IPv6 prefix
		scope	String	IPv6 assignment scope. This can be one of the following values. Global LinkLocal Unknown
		source	String	IPv6 assignment source. This can be one of the following values. DHCP Statelesss Static Other Unknown
		type	String	IPv6 assignment type. This can be one of the following values. INUSE CONFIGURED ALIAS UNKNOWN
	IPv6DHCPenabled		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		Boolean	Identifies whether IPv6 is enabled. This can be one of the following values. true. IPv6 is enabled. false. IPv6 is disabled.
	IPv6statelessEnabled		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		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.
	label		String	Label
	name		String	Name
ipv4Addresses			Array of strings	List of IPv4 addresses
ipv6Addresses			Array of strings	List of IPv6 addresses
leds			Object	Information about CMM LEDs
	color		String	LED color. This can be one of the following values. Red Amber Yellow Green Blue Unknown
	location		String	LED location. This can be one of the following values. Front panel Lightpath Card Planar FRU Rear Panel Unknown
	name		String	LED name
	state		String	LED state. This can be one of the following values. Off On Blinking Unknown
macAddresses			Array of strings	List of MAC addresses
machineType			String	CMM machine type
manufacturer			String	Manufacturer
manufacturerId			String	Manufacturer ID
mgmtProcIPaddress			String	IP address used by the Lenovo XClarity Administrator to manage this resource
model			String	CMM model
name			String	Name that is displayed in the user interface for this device The value of this attribute is determined by preferredDisplayName attribute in the GET /aicc method. For example, if the preferredDisplayName attribute is set to hostname, then the value for this name attribute is the same as the hostname attribute in the GET /aicc method.
overallHealthState			String	Highest severity of all alerts. This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
parent			Object
	uri		String	Parent URI
	uuid		String	Parent UUID
partNumber			String	CMM part number
powerAllocation			Object
	maximumAllocatedPower		Long	Maximum power that is allocated
	minimumAllocatedPower		Long	Minimum power that is allocated
productID			String	CMM product ID
role			String	Role of the CMM. This can be one of the following values. primary backup
serialNumber			String	CMM serial number
slots			Integer	CMM primary slot
type			String	Resource type. This value is always CMM
uri			String	URI
userDefinedName			String	User-defined name for the device
userDescription			String	Description that was defined by the user
uuid			String	UUID

The following example is returned if the request is successful.

{
   "cmmList": [{
   "accessState": "Online",
   "backedBy": "real",
   "cmmDisplayName": "SN#Y010BG494063",
   "cmmHealthState": "Non-Critical",
   "dataHandle": 1548164031434,
   "description": "Chassis Management Module 2",
   "dnsHostnames": ["betacmm12.labs.lenovo.com","fd55:faaf:e1ab:2021:42f2:e9ff:febf:4e54"],
   "domainName": "labs.lenovo.com",
   "errorFields": [],
   "excludedHealthState": "Warning",
   "firmware": [{
      "build": "1AON24A",
      "date": "2018-09-18T04:00:00Z",
      "name": "CMM firmware",
      "role": "",
      "status": "",
      "type": "CMM firmware",
      "version": "2.0.0"
   }],
   "FRU": "00FG678",
   "fruSerialNumber": "Y010BG494063",
   "hostConfig": [],
   "hostname": "betacmm12",
   "ipInterfaces": [{
      "IPv4assignments": [{
      "address": "10.243.2.118",
      "gateway": "10.243.0.1",
      "id": 2,
      "subnet": "255.255.224.0",
      "type": "INUSE"
      }],
      "IPv4DHCPmode": "STATIC_ONLY",
      "IPv4enabled": true,
      "IPv6assignments": [{
      "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"
      },
      ...,
      {
      "address": "fe80:0:0:0:42f2:e9ff:febf:4e54",
      "gateway": "0:0:0:0:0:0:0:0",
      "id": 1,
      "prefix": 64,
      "scope": "LinkLocal",
      "source": "Other",
      "type": "INUSE"
      }],
      "IPv6DHCPenabled": true,
      "IPv6enabled": true,
      "IPv6statelessEnabled": true,
      "IPv6staticEnabled": false,
      "label": "External",
      "name": "eth0"
   }],
   "ipv4Addresses": ["10.243.2.118"],
   "ipv6Addresses": ["fe80:0:0:0:42f2:e9ff:febf:4e54","fd55:faaf:e1ab:2021:42f2:e9ff:febf:4e54"],
   "leds": [{
      "name": "FAULT",
    "state": "Off",
    "color": "Amber",
      "location": "FrontPanel"
   }],
   "macAddresses": ["40:F2:E9:BF:4E:54"],
   "machineType": "",
   "manufacturer": "LNVO",
   "manufacturerId": "19046",
   "mgmtProcIPaddress": "10.243.2.118",
   "model": "",
   "name": "SN#Y010BG494063",
   "overallHealthState": "Warning",
   "parent": {
      "uri": "chassis/78FB1DD279994B95BDBC4F75F063D241",
      "uuid": "78FB1DD279994B95BDBC4F75F063D241"
   },
   "partNumber": "00KH719",
   "powerAllocation": {
      "maximumAllocatedPower": 20,
      "minimumAllocatedPower": 20
   },
   "productId": "1032",
   "role": "primary",
   "serialNumber": "",
   "slots": [2],
   "type": "CMM",
   "uri": "cmm/FD98426A35C711E4972EE04173533818",
   "userDefinedName": "SN#Y010BG494063",
   "userDescription": "",
   "uuid": "FD98426A35C711E4972EE04173533818" 
}

Give documentation feedback

GET /cmms/{uuid_list}

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​