GET /compliancePolicies/persistedResult

Use this method to return the persisted compare result for servers to which a compliance policy is assigned.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/compliancePolicies/persistedResult

Query parameters

If all query parameters are empty or null, all the persisted compliance result are returned.

Parameters	Required / Optional	Description
complexid=`{uuid}`	Optional	Returns the persisted compliance results for only scalable complexes
uuid=`{uuid}`	Optional	Returns the persisted results for only the device specified by the UUID and resource type
type=`{device_type}`	Optional	When the uuid query parameter is specified, this query parameter is used to indicate the resource type. CHASSIS CMM IOSwitch. Flex switch RACKSWITCH. RackSwitch switch SERVER. STORAGE. Rack storage device

The following example returns the persisted compliance results for only scalable complexes.

GET https://192.0.2.0/compliancePolicies/persistedResult?complexid=C156CA72D6E811E48F0F6EAE8B4BDB07

The following example returns the persisted results for only the device specified by the UUID and resource type.

GET https://192.0.2.0/compliancePolicies/persistedResult?type=SERVER&uuid=41C8528EDC3E11E6B757C80D4FC25D9F

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
all					Array
	chassis				String	Chassis UUID
	cmms					Compliance policy information for each CMM
		deviceCompliant			Boolean	Identifies whether the CMM is compliant. This can be one of the following values. yes. The CMM is compliant. no. The CMM is not compliant.
		message			Array	Error message that is returned if an error occurs
		policyName			String	Firmware-compliance policy that is associated with the CMM
		supported			Boolean	Identifies whether the CMM is supported. This can be one of the following values. true. The CMM is supported. false. The CMM is not supported.
		targetFirmware			Array	Information about firmware
			build		String	Update build
			category		String	Update category
			compliant		String	Indicates whether the CMM firmware is compliant with the policy. This can be one of the following values. yes. Compliant. no. Not compliant. DoNotUpdate. Do not update this component.
			componentID		String	For a CMM, this is the CMM UUID
			componentName		String	Name of the CMM
			date		String	Update date
			fixid		String	Update- ID
			installedFirmware		Array of objects	Information about each firmware that is installed on the component
				build	String	Firmware build level
				date	String	Firmware date
				name	String	Firmware name
				versionList	Array of strings	List of versions that were installed
			level		String	Update level
			packageExistence		String	Identifies whether the update package exists in the firmware-updates repository. This can be one of the following values. yes. The update package exists. no. The update package does not exist.
			reason		String	Explanation for the result of the compliance check
			versionList		Strings	Update package version
		uuid			String	CMM UUID
	racklist				Object	If there are racks managed, and you queried for all persisted compliance results, return those results
		deviceCompliant			Boolean	Identifies whether the CMM is compliant. This can be one of the following values. yes. The CMM is compliant. no. The CMM is not compliant.
		message			Array	Error message that is returned if an error occurs
		policyName			String	Firmware-compliance policy that is associated with the CMM
		supported			Boolean	Identifies whether the CMM is supported. This can be one of the following values. true. The CMM is supported. false. The CMM is not supported.
		targetFirmware			Array	Information about firmware
			category		String	Update category
			build		String	Update build
			compliant		String	Indicates whether the CMM firmware is compliant with the policy. This can be one of the following values. yes. Compliant. no. Not compliant. DoNotUpdate. Do not update this component.
			componentID		String	For a CMM, this is the CMM UUID
			componentName		String	Name of the CMM
			date		String	Update date
			fixid		String	Update- ID
			installedFirmware		Array of objects	Information about each firmware that is installed on the component
				build	String	Firmware build level
				date	String	Firmware date
				name	String	Firmware name
				versionList	Array of strings	List of versions that were installed
			level		String	Update level
			packageExistence		String	Identifies whether the update package exists in the firmware-updates repository. This can be one of the following values. yes. The update package exists. no. The update package does not exist.
			reason		String	Explanation for the result of the compliance check
			versionList		Strings	Update package version
		uuid			String	CMM UUID.
	rackswitchlist				Object	Compliance policy information for each managed RackSwitch switch
		deviceCompliant			String	Identifies whether the RackSwitch switch is compliant. This can be one of the following values. yes. The switch is compliant. no. The switch is not compliant.
		message			Array	Error message if an error occurs for this RackSwitch switch
		policyName			String	Firmware-compliance policy that is associated with the RackSwitch switch
		supported			String	Identifies whether the RackSwitch switch is supported. This can be one of the following values. true. The RackSwitch switch is supported. false. The RackSwitch switch is not supported.
		targetFirmware			Array	Information about firmware
			build		String	Update build
			category		String	Type of firmware update
			compliant		String	Indicates whether the RackSwitch switch firmware is compliant with the firmware-compliance policy. This can be one of the following values. yes. Compliant. no. Not compliant. DoNotUpdate. Do not update this component.
			componentID		String	RackSwitch switch UUID
			componentName		String	RackSwitch switch name
			date		String	Update date
			fixid		String	Update ID
			installedFirmware		Array of objects	Information about each firmware that is installed on the component
				build	String	Firmware build level
				date	String	Firmware date
				name	String	Firmware name
				versionList	Array of strings	List of versions that were installed
			level		String	Update level
			packageExistence		String	Identifies whether the update package exists in the firmware-updates repository. This can be one of the following values. yes. The update package exists. no. The update package does not exist.
			reason		String	Explanation for the result of the compliance check
			versionList		Array of string	Update package version
		uuid			String	RackSwitch switch UUID
	storagelist				Object	Compliance policy information for each managed storage device
		deviceCompliant			String	Identifies whether the storage device is compliant. This can be one of the following values. yes. The storage device is compliant. no. The storage device is not compliant.
		message			String	Error message if an error occurs for this storage device
		policyName			String	Firmware-compliance policy that is associated with the storage device
		supported			String	Identifies whether the storage device is supported. This can be one of the following values. true. The storage device is supported. false. The storage device is not supported.
		targetFirmware			Array	Information about firmware
			build		String	Update build
			category		String	Type of firmware update
			compliant		String	Indicates whether the storage device firmware is compliant with the firmware-compliance policy. This can be one of the following values. yes. Compliant. no. Not compliant. DoNotUpdate. Do not update this component.
			componentID		String	Storage device UUID
			componentName		String	Storage device name
			date		String	Update date
			fixid		String	Update ID
			installedFirmware		Array of objects	Information about each firmware that is installed on the component
				build	String	Firmware build level
				date	String	Firmware date
				name	String	Firmware name
				versionList	Array of strings	List of versions that were installed
			level		String	Update level
			packageExistence		String	Identifies whether the update package exists in the firmware-updates repository. This can be one of the following values. yes. The update package exists. no. The update package does not exist.
			reason		String	Explanation for the result of the compliance check
			versionList		Array of strings	Update package version
		uuid			String	Storage device UUID
	switches				Object	Compliance policy information for each Flex System switch
		deviceCompliant			String	Identifies whether the switch is compliant. This can be one of the following values. yes. The Flex System switch is compliant. no. The Flex System switch is not compliant.
		message			Array	Error message if an error occurs for this Flex System switch
		policyName			String	Firmware-compliance policy that is associated with the Flex System switch
		supported			String	Identifies whether the Flex System switch is supported. This can be one of the following values. true. The Flex System switch is supported. false. The Flex System switch is not supported.
		targetFirmware			Array	Information about firmware
			build		String	Update build
			category		String	Type of firmware update, such as IMM2, UEFI, Network, and ServeRAID
			compliant		String	Indicates whether the Flex System switch firmware is compliant with the policy. This can be one of the following values. yes. Compliant. no. Not compliant. DoNotUpdate. Do not update this component.
			componentID		String	For a Flex System switch, this is the switch UUID
			componentName		String	Flex System switch name
			date		String	Update date
			fixid		String	Update ID
			installedFirmware		Array of objects	Information about each firmware that is installed on the component
				build	String	Firmware build level
				date	String	Firmware date
				name	String	Firmware name
				versionList	Array of strings	List of versions that were installed
			level		String	Update level
			packageExistence		String	Identifies whether the update package exists in the firmware-updates repository. This can be one of the following values. yes. The update package exists. no. The update package does not exist.
			reason		String	Explanation for the result of the compliance check
			versionList		Strings	Update package version
		uuid			String	Flex System switch UUID
	xITEs				Object	Compliance policy information for each server
		message			Array	Error message that is returned if an error occurs
		deviceCompliant			Boolean	Identifies whether the server is compliant. This can be one of the following values. yes. The server is compliant. no. The server is not compliant.
		policyName			String	Firmware-compliance policy that is associated with the server
		supported			Boolean	Identifies whether the server is supported. This can be one of the following values. true. The server is supported. false. The server is not supported.
		targetFirmware			Array	Information about firmware
			build		String	Update build
			category		String	Update category
			compliant		String	Indicates whether the server firmware is compliant with the policy. This can be one of the following values. yes. no.
			componentID		String	For servers, this is returned as server UUID:component name
			componentName		String	Component name
			date		String	Update date
			fixid		String	Update ID
			level		String	Update level
			installedFirmware		Array of objects	Information about each firmware that is installed on the component
				build	String	Firmware build level
				date	String	Firmware date
				name	String	Firmware name
				versionList	Array of strings	List of versions that were installed
			packageExistence		String	Identifies whether the update package exists in the firmware-updates repository. This can be one of the following values. yes. The update package exists. no. The update package does not exist.
			reason		String	Explanation for the result of the compliance check
			versionList		Strings	Update package version
		uuid			String	Server UUID
	message				Array	Error message that is returned if an error occurs

The following example is returned if the request is successful.

{
   "all": [
   {
      "chassis": "FBEF740B178F4EFAA846E7225EE256DC",
      "cmms": [{
         "deviceCompliant": ""."message": [],
         "policyName": "",
         "supported": "true",
         "targetFirmware": [],
         "uuid": "387E51D69EC311E0A4C8E87E4D6C0479"
      }]
      "switches": [{
         "deviceCompliant": "no",
         "message": [],
         "policyName": "DEFAULT-2015-04-25",
         "supported": "true",
         "targetFirmware": [{
            "build": "0802",
            "category": "Switches",
            "compliant": "no",
            "componentID": "1B33D6C57ECB04C14567A897DC604900",
            "componentName": "IO Module 02",
            "date": "2015-04-22",
            "fixid": "lnvgy_fw_scsw_si4093-8.2.1.0_anyos_noarch",
            "installedFirmware": [{ 
               "build": "",
               "date": "2014-05-20", 
               "name": "Boot ROM", 
               "versionList": ["7.8.3.15"]
            },
            { 
               "build": "",
               "date": "2014-05-20", 
               "name": "Main Application 1", 
               "versionList": ["7.8.3.15"]
            },
            { 
               "build": "" ,
               "name": "Main Application 2", 
               "date": "2014-05-20", 
               "versionList": ["7.8.3.15"] 
            }],
            "level": "higher",
            "packageExistence": "yes",
            "reason": "The installed version is down level than the version defined in compliance policy.",
            "versionList": ["8.2.1.0"]
         }],
         "uuid": "1B33D6C57ECB04C14567A897DC604900"
      }],
      "xITEs": [{
         "deviceCompliant": "",
         "message": [],
         "policyName": "",
         "supported": "true",
         "targetFirmware": [],
         "uuid": "69BDF8912E5211E4998B40F2E99033F0"
      }]
   }
   {   
      "racklist": [{
         "policyName": "",
         "endpointCompliant": "",
         "targetFirmware": [],
         "message": [],
         "uuid": "200B8108289D11E3878E000AF725674C"
      }]
   },
   {
      "complexlist": []
   },
   {
      "rackswitchlist": []
   },
   {
      "storagelist": []
   }]
}

Give documentation feedback

GET /compliancePolicies/persistedResult

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​