Try SpotterCreate, modify, or delete a firmware baseline on OpenManage Enterprise or OpenManage Enterprise Modular
| "added in version" 2.0.0 of dellemc.openmanage"
Authors: Jagadeesh N V(@jagadeeshnv), Kritika Bhateja (@Kritika-Bhateja-03)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to create, modify, or delete a firmware baseline on OpenManage Enterprise or OpenManage Enterprise Modular.
---
- name: Create baseline for device IDs
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
device_ids:
- 1010
- 2020
- name: Create baseline for device IDs with no reboot required
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
filter_no_reboot_required: true
device_ids:
- 1010
- 2020
- name: Create baseline for servicetags
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
device_service_tags:
- "SVCTAG1"
- "SVCTAG2"
- name: Create baseline for servicetags with no reboot required
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
filter_no_reboot_required: true
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"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "baseline_name"
baseline_description: "baseline_description"
catalog_name: "catalog_name"
device_group_names:
- "Group1"
- "Group2"
job_wait: false
- name: Modify an existing baseline
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
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: false
is_64_bit: true
- name: Modify no reboot filter in existing baseline
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
baseline_name: "existing_baseline_name"
new_baseline_name: "new_baseline_name"
filter_no_reboot_required: true
- name: Delete a baseline
dellemc.openmanage.ome_firmware_baseline:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
baseline_name: "baseline_name"
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
state:
choices:
- present
- absent
default: present
description:
- C(present) creates or modifies a baseline.
- C(absent) deletes an existing baseline.
type: str
version_added: 3.4.0
version_added_collection: dellemc.openmanage
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
job_wait:
default: true
description:
- Provides the option to wait for job completion.
- This option is applicable when I(state) is C(present).
type: bool
version_added: 3.4.0
version_added_collection: dellemc.openmanage
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
is_64_bit:
description:
- Indicates if the repository contains 64-bit DUPs.
- This value will be set to C(true) by default, if not provided during baseline creation.
type: bool
device_ids:
description:
- List of device IDs.
- This option is mutually exclusive with I(device_service_tags) and I(device_group_names).
elements: int
type: list
baseline_id:
description:
- ID of the existing baseline.
- This option is mutually exclusive with I(baseline_name).
type: int
version_added: 3.4.0
version_added_collection: dellemc.openmanage
catalog_name:
description:
- Name of the catalog to be associated with the baseline.
type: str
baseline_name:
description:
- Name of the the baseline.
- This option is mutually exclusive with I(baseline_id).
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
job_wait_timeout:
default: 600
description:
- The maximum wait time of I(job_wait) in seconds. The job is tracked only for this
duration.
- This option is applicable when I(job_wait) is C(true).
type: int
version_added: 3.4.0
version_added_collection: dellemc.openmanage
downgrade_enabled:
description:
- Indicates whether firmware downgrade is allowed for the devices in the baseline.
- This value will be set to C(true) by default, if not provided during baseline creation.
type: bool
new_baseline_name:
description: New name of the baseline.
type: str
version_added: 3.4.0
version_added_collection: dellemc.openmanage
device_group_names:
description:
- List of group names.
- This option is mutually exclusive with I(device_ids) and I(device_service_tags).
elements: str
type: list
device_service_tags:
description:
- List of device service tags.
- This option is mutually exclusive with I(device_ids) and I(device_group_names).
elements: str
type: list
baseline_description:
description:
- Description for the baseline being created.
type: str
filter_no_reboot_required:
description:
- Select only components with no reboot required allows to create a firmware/driver
baseline that consists of only the components of the target devices that don't require
a reboot of the target devices.
type: bool
version_added: 8.1.0
version_added_collection: dellemc.openmanage
baseline_id:
description: ID of the deleted baseline.
returned: When I(state) is C(absent)
sample: 10123
type: int
baseline_status:
description: Details of the baseline status.
returned: success
sample:
CatalogId: 123
Description: BASELINE DESCRIPTION
DeviceComplianceReports: []
DowngradeEnabled: true
FilterNoRebootRequired: 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
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
job_id:
description: Job ID of the baseline task.
returned: When baseline job is in running state
sample: 10123
type: int
msg:
description: Overall status of the firmware baseline operation.
returned: always
sample: Successfully created the firmware baseline.
type: str