dellemc.openmanage.ome_firmware_baseline_info module – Retrieves baseline details from OpenManage Enterprise

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

New in dellemc.openmanage 2.0.0

Synopsis

  • This module retrieves the list and details of all the baselines on OpenManage Enterprise.

Requirements

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

  • python >= 3.9.6

Parameters

Parameter

Comments

baseline_name

string

Name of the baseline.If baseline_name is not provided, all the available firmware baselines are returned.

ca_path

path

added in dellemc.openmanage 5.0.0

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

hostname

string / required

OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.

password

string

OpenManage Enterprise or OpenManage Enterprise Modular password.

If the password is not provided, then the environment variable OME_PASSWORD is used.

Example: export OME_PASSWORD=password

port

integer

OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.

Default: 443

timeout

integer

added in dellemc.openmanage 5.0.0

The socket level timeout in seconds.

Default: 30

username

string

OpenManage Enterprise or OpenManage Enterprise Modular username.

If the username is not provided, then the environment variable OME_USERNAME is used.

Example: export OME_USERNAME=username

validate_certs

boolean

added in dellemc.openmanage 5.0.0

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is false by default.

Choices:

  • false

  • true ← (default)

x_auth_token

string

added in dellemc.openmanage 9.3.0

Authentication token.

If the x_auth_token is not provided, then the environment variable OME_X_AUTH_TOKEN is used.

Example: export OME_X_AUTH_TOKEN=x_auth_token

Notes

Note

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

  • This module supports check_mode.

Examples

---
- name: Retrieve details of all the available firmware baselines
  dellemc.openmanage.ome_firmware_baseline_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve details of a specific firmware baseline identified by its baseline name
  dellemc.openmanage.ome_firmware_baseline_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "baseline_name"

Return Values

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

Key

Description

baseline_info

dictionary

Details of the baselines.

Returned: success

Sample: {"@odata.id": "/api/UpdateService/Baselines(239)", "@odata.type": "#UpdateService.Baselines", "CatalogId": 22, "ComplianceSummary": {"ComplianceStatus": "CRITICAL", "NumberOfCritical": 1, "NumberOfDowngrade": 0, "NumberOfNormal": 0, "NumberOfWarning": 0}, "Description": "baseline_description", "DeviceComplianceReports@odata.navigationLink": "/api/UpdateService/Baselines(239)/DeviceComplianceReports", "DowngradeEnabled": true, "Id": 239, "Is64Bit": true, "LastRun": "2020-05-22 16:42:40.307", "Name": "baseline_name", "RepositoryId": 12, "RepositoryName": "HTTP DELL", "RepositoryType": "DELL_ONLINE", "Targets": [{"Id": 10342, "Type": {"Id": 1000, "Name": "DEVICE"}}], "TaskId": 41415, "TaskStatusId": 2060}

msg

string

Overall baseline information.

Returned: on error

Sample: "Successfully fetched firmware baseline information."

Authors

  • Sajna Shetty(@Sajna-Shetty)