Try SpotterRetrieves baseline compliance details on OpenManage Enterprise
| "added in version" 2.0.0 of dellemc.openmanage"
Authors: Sajna Shetty(@Sajna-Shetty)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to retrieve firmware compliance for a list of devices, or against a specified baseline on OpenManage Enterprise.
---
- name: Retrieves device based compliance report for specified device IDs
dellemc.openmanage.ome_firmware_baseline_compliance_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_ids:
- 11111
- 22222
- name: Retrieves device based compliance report for specified service Tags
dellemc.openmanage.ome_firmware_baseline_compliance_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_service_tags:
- MXL1234
- MXL4567
- name: Retrieves device based compliance report for specified group names
dellemc.openmanage.ome_firmware_baseline_compliance_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_group_names:
- "group1"
- "group2"
- name: Retrieves device compliance report for a specified baseline
dellemc.openmanage.ome_firmware_baseline_compliance_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "baseline_name"
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
device_ids:
description:
- A list of unique identifier for device based compliance report.
- Either I(device_ids), I(device_service_tags) or I(device_group_names) is required
to generate device based compliance report.
- I(device_ids) is mutually exclusive with I(device_service_tags), I(device_group_names)
and I(baseline_name).
- Devices without reports are ignored.
elements: int
type: list
baseline_name:
description:
- Name of the baseline, for which the device compliance report is generated.
- This option is mandatory for generating baseline based device compliance report.
- I(baseline_name) is mutually exclusive with I(device_ids), I(device_service_tags)
and I(device_group_names).
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
device_group_names:
description:
- A list of group names for device based compliance report.
- Either I(device_ids), I(device_service_tags) or I(device_group_names) is required
to generate device based compliance report.
- I(device_group_names) is mutually exclusive with I(device_ids), I(device_service_tags)
and I(baseline_name).
- Devices without reports are ignored.
elements: str
type: list
device_service_tags:
description:
- A list of service tags for device based compliance report.
- Either I(device_ids), I(device_service_tags) or I(device_group_names) is required
to generate device based compliance report.
- I(device_service_tags) is mutually exclusive with I(device_ids), I(device_group_names)
and I(baseline_name).
- Devices without reports are ignored.
elements: str
type: list
baseline_compliance_info:
description: Details of the baseline compliance report.
returned: success
sample:
- CatalogId: 53
ComplianceSummary:
ComplianceStatus: CRITICAL
NumberOfCritical: 2
NumberOfDowngrade: 0
NumberOfNormal: 0
NumberOfWarning: 0
Description: ''
DeviceComplianceReports:
- ComplianceStatus: CRITICAL
ComponentComplianceReports:
- ComplianceDependencies: []
ComplianceStatus: DOWNGRADE
Criticality: Ok
CurrentVersion: OSC_1.1
Id: 1258
ImpactAssessment: ''
Name: OS COLLECTOR 2.1
Path: FOLDER04118304M/2/Diagnostics_Application_JCCH7_WN64_4.0_A00_01.EXE
PrerequisiteInfo: ''
RebootRequired: false
SourceName: DCIM:INSTALLED#802__OSCollector.Embedded.1
TargetIdentifier: '101734'
UniqueIdentifier: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
UpdateAction: DOWNGRADE
Uri: http://www.dell.com/support/home/us/en/19/Drivers/DriversDetails?driverId=XXXXX
Version: '4.0'
- ComplianceDependencies: []
ComplianceStatus: CRITICAL
Criticality: Recommended
CurrentVersion: DN02
Id: 1259
ImpactAssessment: ''
Name: TOSHIBA AL14SE 1.8 TB 2.5 12Gb 10K 512n SAS HDD Drive
Path: FOLDER04086111M/1/SAS-Drive_Firmware_VDGFM_WN64_DN03_A00.EXE
PrerequisiteInfo: ''
RebootRequired: true
SourceName: DCIM:INSTALLED#304_C_Disk.Bay.1:Enclosure.Internal.0-1:RAID.Integrated.1-1
TargetIdentifier: '103730'
UniqueIdentifier: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
UpdateAction: UPGRADE
Uri: http://www.dell.com/support/home/us/en/19/Drivers/DriversDetails?driverId=XXXXX
Version: DN03
DeviceId: 11603
DeviceModel: PowerEdge R630
DeviceName: null
DeviceTypeId: 1000
DeviceTypeName: CPGCGS
FirmwareStatus: Non-Compliant
Id: 194
RebootRequired: true
ServiceTag: MXL1234
DowngradeEnabled: true
Id: 53
Is64Bit: false
LastRun: '2019-09-27 05:08:16.301'
Name: baseline1
RepositoryId: 43
RepositoryName: catalog2
RepositoryType: CIFS
Targets:
- Id: 11603
Type:
Id: 1000
Name: DEVICE
TaskId: 11710
TaskStatusId: 0
type: dict
error_info:
description: Details of http error.
returned: on http error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to retrieve baseline list either because the device ID(s)
entered are invalid
Resolution: Make sure the entered device ID(s) are valid and retry the operation.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
msg:
description: Overall baseline compliance report status.
returned: on error
sample: Failed to fetch the compliance baseline information.
type: str