dellemc.openmanage.omevv_firmware_compliance_info module – Retrieve firmware compliance report.

Note

This module is part of the dellemc.openmanage collection (version 9.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.openmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.openmanage.omevv_firmware_compliance_info.

New in dellemc.openmanage 9.9.0

Synopsis 

This module allows you to retrieve firmware compliance reports of all the hosts of the cluster, a specific host of the cluster, or multiple clusters.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 3.9.6

Parameters 

Parameter	Comments
ca_path path	The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
clusters list / elements=dictionary	Cluster details to retrieve the firmware compliance report.
cluster_name string / required	Cluster name of the hosts for which the firmware compliance report should be retrieved. If servicetags or hosts is provided, then the firmware compliance report of only the specified hosts is retrieved and displayed.
hosts list / elements=string	The IP address or hostname of the hosts for which the firmware compliance reports must be retrieved.
servicetags list / elements=string	The service tag of the hosts for which the firmware compliance reports must be retrieved.
hostname string / required	IP address or hostname of the OpenManage Enterprise Modular.
port integer	OpenManage Enterprise HTTPS port. Default: `443`
timeout integer	The socket level timeout in seconds. Default: `30`
validate_certs boolean	Whether to check SSL certificate. - If `true`, the SSL certificates will be validated. - If `false`, the SSL certificates will not be validated. Choices: `false` `true` ← (default)
vcenter_password string	Password for OpenManage Enterprise Integration for VMware vCenter (OMEVV). If the password is not provided, then the environment variable `OMEVV_VCENTER_PASSWORD` is used. Example: export OMEVV_VCENTER_PASSWORD=password
vcenter_username string	Username for OpenManage Enterprise Integration for VMware vCenter (OMEVV). If the username is not provided, then the environment variable `OMEVV_VCENTER_USERNAME` is used. Example: export OMEVV_VCENTER_USERNAME=username
vcenter_uuid string	Universally Unique Identifier (UUID) of vCenter. vCenter UUID details can be retrieved using dellemc.openmanage.omevv_vcenter_info module. If UUID is not provided, then the environment variable `OMEVV_VCENTER_UUID` is used. Example: export OMEVV_VCENTER_UUID=uuid

Attributes 

Attribute	Support	Description
check_mode	Support: full	Runs task to validate without performing action on the target machine.
diff_mode	Support: full	Runs the task to report the changes that are made or the changes that must be applied.

Notes 

Note

Run this module from a system that has direct access to Dell OpenManage Enterprise.

Examples 

---
- name: Retrieve a firmware compliance report of all the clusters
  dellemc.openmanage.omevv_firmware_compliance_info:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"

- name: Retrieve a firmware compliance report of all the hosts in a specific cluster
  dellemc.openmanage.omevv_firmware_compliance_info:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    clusters:
      - cluster_name: cluster_a

- name: Retrieve a firmware compliance report of specific hosts in the cluster
  dellemc.openmanage.omevv_firmware_compliance_info:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    clusters:
      - cluster_name: cluster_a
        servicetags:
          - SVCTAG1
          - SVCTAG2
        hosts:
          - host1
          - xx.xx.xx.xx

- name: Retrieve a firmware compliance report of multiple clusters
  dellemc.openmanage.omevv_firmware_compliance_info:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    clusters:
      - cluster_name: cluster_a
      - cluster_name: cluster_b

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key

Description

firmware_compliance_info

list / elements=dictionary

Details of the compliance report.

Returned: on HTTP error

Sample: [{"cluster": "cluster_a", "complianceStatus": "NonCompliant", "hostComplianceReports": [{"complianceStatus": "WARNING", "componentCompliances": [{"baselineValue": "4303A19", "complianceStatus": "WARNING", "componentName": "Enterprise UEFI Diagnostics", "criticality": "Optional", "currentValue": "4303A15", "driftStatus": "NonCompliant", "rebootRequired": false, "sourceName": "DCIM:INSTALLED#802__Diagnostics.Embedded.1:LC.Embedded.1", "updateAction": "UPGRADE"}], "deviceModel": "PowerEdge R660xs", "hostAddress": "XX.XX.XX.XX", "hostId": 1002, "serviceTag": "SVCTAG"}]}]

msg

string

Retrive the firmware compliance report.

Returned: always

Sample: "Successfully fetched the firmware compliance report."

Authors

Abhishek Sinha(@ABHISHEK-SINHA10)

dellemc.openmanage.omevv_firmware_compliance_info module – Retrieve firmware compliance report.

Synopsis

Requirements

Parameters

Attributes

Notes

Examples

Return Values