GET /compliancePolicies

Use the GET method to export a firmware-update compliance policy or retrieve basic or detailed information for a specified compliance policy or all policies. The basic information includes the name, last modified, and description. The detailed information includes the target versions and information about the firmware-update packages.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/compliancePolicies

Query parameters

Parameters Required / Optional Description
basic_full=<type> Optional Returns the specified type of information. This can be one of the following values.
  • basic. Returns basic information for the compliance policy.
  • full. Returns detailed information for the compliance policy.
exportDownload=<file_name> Optional Downloads the specified compliance policy as a .zip file to your local system
policyname_all=<policy_name> Optional Returns information about the specified compliance policy. If the value is empty, information is returned for all compliance policies.
refresh=<Boolean> Optional Indicates whether to refresh the compliance-policy data before returning the results. This can be one of the following values.
  • true. Refreshes the compliance-policy data .
  • false. (default) Does not refresh the compliance policy data.
The following example refreshes the compliance-policy data and then returns basic information about all compliance policies.
GET https://<management_server_IP>/compliancePolicies?basic_full=basic
&policyname_all=&refresh=false

Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
409 Conflict
500 Internal server error

Response body

Table 1. Basic information for compliance policies.
Attributes Type Description
policies Array Information about the compliance policy
  description String Compliance policy description
  id String Compliance policy ID
  inUse Boolean Identifies whether the compliance policy is in use. This can be one of the following values.
  • true. The compliance policy is in use.
  • false. The compliance policy is not in use.
  filterType String Filter type. This can be one of the following values.
  • all. All supported machine types

  • managed. Only managed machine types.

  lastAction String Last action that was performed on the compliance policy. This can be one of the following values.
  • Predefined. The compliance policy is predefined.

  • Created by <user_name>. The user-defined compliance policy was created by the specified user.

  • Edited by <user_name>. The user-defined compliance policy was edited by the specified user.

  lastEdited String Timestamp of the last change to the compliance policy
  lastModified String Timestamp of the last change to the compliance policy
  name String Compliance policy name
  updateRule String Internal use only
  userDefined String Identifies whether the compliance policy is user-defined. This can be one of the following values.
  • yes. The compliance policy is user-defined.
  • no. The compliance policy is predefined.
Table 2. Detailed information for compliance policies.
Attributes Type Description
policies Array Information about the compliance policy
  description String Compliance policy description
  details Array Array
    baseVersion String For CMMs or switches, this is the fix ID of the package. For servers, the following is returned.
xxxx_utl_uxsp_xxxxxx-1.00_xxxx_32-64
    build String Firmware update build number
    components Array Information about each component in the firmware update package
      isDefault String Specifies if the component update is the default component (the latest component update). If so, yes is returned.
      isGA String Identifies that the component update is the GA level version of the update. If the component update is the GA level, yes is returned.
      name String Component name
      packageExistence String Indicates whether the update exists in the firmware-updates repository. This can be one of the following values.
  • yes. Update package exists.
  • no. Update package does not exist.
      releaseDate String Release date of the component update
      targetVersion String Firmware level that is considered to be the baseline for the specified system type
      type String For CMMs or switches, this attribute is empty. For servers, specifies the type of package. One of the following values is returned.
  • IMM
  • IMM-Backup
  • UEFI
  • UEFI-Backup
    id String System type used to identify the CMM. Internal use only
    isDefault String Indicates if the update package is the default package (the latest package). This can be one of the following values.
  • yes. This is the default update package

  • no. This is not the default update package

    isGA String Identifies that the package is the GA level version of the update
    isUXSP String Indicates if this update package is an UpdateXpress System Pack (UXSP). This can be one of the following values.
  • yes. This is a UXSP.

  • no. This is not a UXSP.

    name String Compliance policy name
    packageExistence String Indicates whether the update package exists in the firmware-updates repository. This can be one of the following values.
  • yes. Update package exists.
  • no. Update package does not exist.
    releaseDate String For CMMs or switches, the release date of the update package. If so, yes is returned.

For servers, this attribute is empty.

    rule String  
    systemType String Type of device for which the policy applies
    version String Firmware update version
  id String Compliance policy ID
  inUse Boolean Identifies whether the compliance policy is in use. This can be one of the following values.
  • true. The compliance policy is in use.
  • false. The compliance policy is not in use.
  filterType String Filter type. This can be one of the following values.
  • all. All supported machine types

  • managed. Only managed machine types.

  lastAction String Last action that was performed on the compliance policy. This can be one of the following values.
  • Predefined. The compliance policy is predefined.

  • Created by <user_name>. The user-defined compliance policy was created by the specified user.

  • Edited by <user_name>. The user-defined compliance policy was edited by the specified user.

  lastEdited String Timestamp of the last change to the compliance policy
  lastModified String Timestamp of the last change to the compliance policy
  name String Compliance policy name
  updateRule String Internal use only
  userDefined String Identifies whether the compliance policy is user-defined. This can be one of the following values.
  • yes. The compliance policy is user-defined.
  • no. The compliance policy is predefined.

Response example

This example response shows basic information about all compliance policies.
{
   "policies":[{
      "description":"DEV ONLY",
      "id":"1427930734934",
      "inUse":"true",
      "filterType":"all"
      "lastAction":"Predefined",
      "lastEdited":"2015-04-01 16:25:34",
      "lastModified":"2015-04-01 16:25:34",
      "name":"DEFAULT-2015-04-01",
      "updateRule":"",
      "userDefined":"no"
   },
   ...,
   {"updateRule":"",
      "description":"ddddd",
      "id":"1428397839104",
      "inUse":"false",
      "filterType":"managed"
      "lastAction":"Created by ADMIN",
      "lastEdited":"2015-04-07 05:10:39",
      "lastModified":"This policy was created by ADMIN on 2015-04-07 05:10:39",
      "name":"aaaa",
      "updateRule":"",
      "userDefined":"yes"
   }]
}
This example response shows detailed information about a specific compliance policy.
{
   "policies": [{
      "description": "Production firmware for CMM and Switches and Storage",
      "details": [{
         "baseVersion": "xxxx_utl_uxsp_xxxxxx-1.00_xxxx_32-64",
         "build": "",
         "components": [{
            "build": "1AOO76I",
            "isDefault": "yes",
            "isGA": "yes",
            "name": "Integrated Management Module 2 (IMM2) Update (Standby)",
            "packageExistence": "yes",
            "releaseDate": "2016-11-03",
            "targetVersion": "ibm_fw_imm2_1aoo76i-6.00_anyos_noarch",
            "type": "IMM-Backup",
            "version": "6.00"
         },
         ...,
         {
            "build": "",
            "isDefault": "yes",
            "isGA": "yes",
            "name": "Online Qlogic NetXtreme II Firmware Utility",
            "packageExistence": "yes",
            "releaseDate": "2015-04-27",
            "targetVersion": "qlgc_fw_nic_7.12b.4.2e_linux_32-64",
            "type": "",
            "version": "7.12b.4.2e"
         }],
         "id": "2585",
         "isDefault": "yes",
         "isGA": "yes",
         "isUXSP": "yes",
         "packageExistence": "yes",
         "name": "IBM Flex System x220 Compute Node-2585",
         "releaseDate": "",
         "rule": "alertIfDownlevel",
         "systemType": "2585",
         "version": ""
      },
      ...,
      {
         "baseVersion": "xxxx_utl_uxsp_xxxxxx-1.00_xxxx_32-64",
         "build": "",
         "category": "RACKSWITCH",
         "components": [{
            "build": "0804",
            "isDefault": "yes",
            "isGA": "yes",
            "name": "ENOS",
            "packageExistence": "yes",
            "releaseDate": "2016-12-01",
            "targetVersion": "lnvgy_fw_torsw_g8264cs-8.4.3.0_anyos_noarch",
            "type": "",
            "version": "8.4.3"
         }],
         "id": "7159DFX,7159DRX,7159HCK,7159HCM",
         "isDefault": "Default",
         "isGA": "yes",
         "isUXSP": "yes",
         "name": "Lenovo RackSwitch G8264CS-7159",
         "packageExistence": "yes",
         "releaseDate": "2016-12-01",
         "rule": "alertIfDownlevel",
         "systemType": "7159",
         "version": "",
      }],
      "filterType":"all"
      "id": "1490168216664",
      "inUse": "true",
      "lastAction":"Predefined",
      "lastEdited":"2017-03-22 03:00:00",
      "lastModified": "2017-03-22 03:00:00",
      "name": "DEFAULT-CMM-switches-storage-2017-03-22",
      "updateRule": "",
      "userDefined":"no"
   }]
}