Note
This plugin is part of the dellemc.openmanage collection (version 3.6.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.
To use it in a playbook, specify: dellemc.openmanage.ome_firmware_baseline.
New in version 2.0.0: of dellemc.openmanage
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| baseline_description string | Description for the baseline being created. | |
| baseline_id integer added in 3.4.0 of dellemc.openmanage | ID of the existing baseline. This option is mutually exclusive with baseline_name. | |
| baseline_name string | Name of the the baseline. This option is mutually exclusive with baseline_id. | |
| catalog_name string | Name of the catalog to be associated with the baseline. | |
| device_group_names list / elements=string | List of group names. This option is mutually exclusive with device_ids and device_service_tags. | |
| device_ids list / elements=integer | List of device IDs. This option is mutually exclusive with device_service_tags and device_group_names. | |
| device_service_tags list / elements=string | List of device service tags. This option is mutually exclusive with device_ids and device_group_names. | |
| downgrade_enabled boolean |
| Indicates whether firmware downgrade is allowed for the devices in the baseline. This value will be set to True by default, if not provided during baseline creation. |
| hostname string / required | OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. | |
| is_64_bit boolean |
| Indicates if the repository contains 64-bit DUPs. This value will be set to True by default, if not provided during baseline creation. |
| job_wait boolean added in 3.4.0 of dellemc.openmanage |
| Provides the option to wait for job completion. This option is applicable when state is present. |
| job_wait_timeout integer added in 3.4.0 of dellemc.openmanage | Default: 600 | The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is True. |
| new_baseline_name string added in 3.4.0 of dellemc.openmanage | New name of the baseline. | |
| password string / required | OpenManage Enterprise or OpenManage Enterprise Modular password. | |
| port integer | Default: 443 | OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. |
| state string added in 3.4.0 of dellemc.openmanage |
| present creates or modifies a baseline.absent deletes an existing baseline. |
| username string / required | OpenManage Enterprise or OpenManage Enterprise Modular username. |
Note
check_mode.---
- name: Create baseline for device IDs
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
device_ids:
- 1010
- 2020
- name: Create baseline for servicetags
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
device_service_tags:
- "SVCTAG1"
- "SVCTAG2"
- name: Create baseline for device groups without job tracking
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
device_group_names:
- "Group1"
- "Group2"
job_wait: no
- name: Modify an existing baseline
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
baseline_name: "existing_baseline_name"
new_baseline_name: "new_baseline_name"
baseline_description: "new baseline_description"
catalog_name: "catalog_other"
device_group_names:
- "Group3"
- "Group4"
- "Group5"
downgrade_enabled: no
is_64_bit: yes
- name: Delete a baseline
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
state: absent
baseline_name: "baseline_name"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| baseline_id integer | When state is absent
| ID of the deleted baseline. Sample: 10123 |
| baseline_status dictionary | success | Details of the baseline status. Sample: {'CatalogId': 123, 'Description': 'BASELINE DESCRIPTION', 'DeviceComplianceReports': [], 'DowngradeEnabled': True, 'Id': 23, 'Is64Bit': True, 'Name': 'my_baseline', 'RepositoryId': 123, 'RepositoryName': 'catalog123', 'RepositoryType': 'HTTP', 'Targets': [{'Id': 10083, 'Type': {'Id': 1000, 'Name': 'DEVICE'}}, {'Id': 10076, 'Type': {'Id': 1000, 'Name': 'DEVICE'}}], 'TaskId': 11235, 'TaskStatusId': 2060} |
| error_info dictionary | on http error | Details of 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.'}} |
| job_id integer | When baseline job is in running state | Job ID of the baseline task. Sample: 10123 |
| msg string | always | Overall status of the firmware baseline operation. Sample: Successfully created the firmware baseline. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_firmware_baseline_module.html