dellemc.openmanage.ome_firmware_catalog module – Create, modify, or delete a firmware catalog on OpenManage Enterprise or OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 9.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
.
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_catalog
.
New in dellemc.openmanage 2.0.0
Synopsis
This module allows to create, modify, or delete a firmware catalog on OpenManage Enterprise or OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Description for the catalog. |
|
ID of the catalog. This option is mutually exclusive with catalog_name. Provide the list of firmware catalog IDs that are supported when state is |
|
Name of the firmware catalog to be created. This option is mutually exclusive with catalog_id. Provide the list of firmware catalog names that are supported when state is |
|
The certificate warnings are ignored when repository_type is HTTPS. If Choices:
|
|
Catalog file name associated with the source_path. This option is ignored when repository_type is |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Provides the option to wait for job completion. This option is applicable when state is Choices:
|
|
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 Default: |
|
New name of the firmware catalog. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Domain name of the repository. This option is ignored when repository_type is |
|
Password to access the repository. This option is mandatory when repository_type is CIFS. This option is ignored when repository_type is
|
|
Type of repository. The supported types are NFS, CIFS, HTTP, HTTPS,and DELL_ONLINE. Choices:
|
|
User name of the repository where the catalog is stored. This option is mandatory when repository_type is CIFS. This option is ignored when repository_type is |
|
The IP address of the system where the firmware catalog is stored on the local network. By default, this option is set to downloads.dell.com when repository_type is |
|
Specify the complete path of the catalog file location without the file name. This is option ignored when repository_type is |
|
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
If repository_password is provided, then the module always reports the changed status.
Run this module from a system that has direct access to Dell OpenManage Enterprise or OpenManage Enterprise Modular.
This module supports IPv4 and IPv6 addresses.
This module supports
check_mode
.
Examples
---
- name: Create a catalog from HTTPS repository
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_name: "catalog_name"
catalog_description: "catalog_description"
repository_type: "HTTPS"
source: "downloads.dell.com"
source_path: "catalog"
file_name: "catalog.gz"
check_certificate: true
- name: Create a catalog from HTTP repository
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_name: "catalog_name"
catalog_description: "catalog_description"
repository_type: "HTTP"
source: "downloads.dell.com"
source_path: "catalog"
file_name: "catalog.gz"
- name: Create a catalog using CIFS share
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_name: "catalog_name"
catalog_description: "catalog_description"
repository_type: "CIFS"
source: "192.167.0.1"
source_path: "cifs/R940"
file_name: "catalog.gz"
repository_username: "repository_username"
repository_password: "repository_password"
repository_domain: "repository_domain"
- name: Create a catalog using NFS share
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_name: "catalog_name"
catalog_description: "catalog_description"
repository_type: "NFS"
source: "192.166.0.2"
source_path: "/nfs/R940"
file_name: "catalog.xml"
- name: Create a catalog using repository from Dell.com
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_name: "catalog_name"
catalog_description: "catalog_description"
repository_type: "DELL_ONLINE"
check_certificate: true
- name: Modify a catalog using a repository from CIFS share
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_name: "catalog_name"
catalog_description: "new catalog_description"
repository_type: "CIFS"
source: "192.167.0.2"
source_path: "cifs/R941"
file_name: "catalog1.gz"
repository_username: "repository_username"
repository_password: "repository_password"
repository_domain: "repository_domain"
- name: Modify a catalog using a repository from Dell.com
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
catalog_id: 10
new_catalog_name: "new_catalog_name"
repository_type: "DELL_ONLINE"
catalog_description: "catalog_description"
- name: Delete catalog using catalog name
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
catalog_name: ["catalog_name1", "catalog_name2"]
- name: Delete catalog using catalog id
dellemc.openmanage.ome_firmware_catalog:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
catalog_id: [11, 34]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
IDs of the baselines associated with catalog. Returned: When state is Sample: |
|
IDs of the deleted catalog. Returned: When state is Sample: |
|
Details of the catalog operation. Returned: When state is Sample: |
|
Details of the http error. Returned: on http error Sample: |
|
Job ID of the catalog task. Returned: When catalog job is in a running state Sample: |
|
Overall status of the firmware catalog operation. Returned: always Sample: |