On this page
dellemc.openmanage.ome_firmware_baseline – Create a firmware baseline on OpenManage Enterprise
Note
This plugin is part of the dellemc.openmanage collection (version 3.0.0).
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
Synopsis
- This module creates a baseline on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7.5
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
baseline_description
string
|
Description for the baseline being created.
|
|
baseline_name
string / required
|
Name for the baseline being created.
|
|
catalog_name
string
|
Name of the catalog associated with the baseline.
|
|
device_group_names
list / elements=string
|
List of group names.
device_group_names is mutually exclusive with device_ids and device_service_tags.
|
|
device_ids
list / elements=integer
|
List of device ids.
device_ids is mutually exclusive with device_service_tags and device_group_names.
|
|
device_service_tags
list / elements=string
|
List of service tags.
device_service_tags is mutually exclusive with device_ids and device_group_names.
|
|
downgrade_enabled
boolean
|
|
Indicates if a downgrade is allowed or not.
|
hostname
string / required
|
Target IP address or hostname.
|
|
is_64_bit
boolean
|
|
Indicate if 64 bit is supported.
|
password
string / required
|
Target user password.
|
|
port
integer
|
Default:
443
|
Target HTTPS port.
|
username
string / required
|
Target username.
|
Notes
Note
- Run this module from a system that has direct access to DellEMC OpenManage Enterprise.
- This module does not support
check_mode
.
Examples
---
- 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
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
baseline_status
dictionary
|
success |
Details of the baseline status.
Sample:
{'CatalogId': 123, 'Description': 'BASELINE DESCRIPTION', 'DeviceComplianceReports': [], 'DowngradeEnabled': True, 'Id': 0, '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': 0}
|
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.'}}
|
msg
string
|
always |
Overall status of the firmware baseline creation.
Sample:
Successfully created task for creating Baseline
|
Authors
- Jagadeesh N V(@jagadeeshnv)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/ome_firmware_baseline_module.html