Try SpotterCreate, modify, or delete a firmware catalog on OpenManage Enterprise or OpenManage Enterprise Modular
| "added in version" 2.0.0 of dellemc.openmanage"
Authors: Sajna Shetty(@Sajna-Shetty), Jagadeesh N V(@jagadeeshnv)
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 catalog on OpenManage Enterprise or OpenManage Enterprise Modular.
---
- 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]
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 catalog.
- C(absent) deletes an existing catalog.
type: str
version_added: 3.4.0
version_added_collection: dellemc.openmanage
source:
description:
- 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 I(repository_type) is
C(DELL_ONLINE).
type: str
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
file_name:
description:
- Catalog file name associated with the I(source_path).
- This option is ignored when I(repository_type) is C(DELL_ONLINE).
type: str
catalog_id:
description:
- ID of the catalog.
- This option is mutually exclusive with I(catalog_name).
- Provide the list of firmware catalog IDs that are supported when I(state) is C(absent).
elements: int
type: list
version_added: 3.4.0
version_added_collection: dellemc.openmanage
source_path:
description:
- Specify the complete path of the catalog file location without the file name.
- This is option ignored when I(repository_type) is C(DELL_ONLINE).
type: str
catalog_name:
description:
- Name of the firmware catalog to be created.
- This option is mutually exclusive with I(catalog_id).
- Provide the list of firmware catalog names that are supported when I(state) is C(absent).
elements: str
type: list
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
repository_type:
choices:
- NFS
- CIFS
- HTTP
- HTTPS
- DELL_ONLINE
description:
- Type of repository. The supported types are NFS, CIFS, HTTP, HTTPS,and DELL_ONLINE.
type: str
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
new_catalog_name:
description:
- New name of the firmware catalog.
type: str
version_added: 3.4.0
version_added_collection: dellemc.openmanage
check_certificate:
default: false
description:
- The certificate warnings are ignored when I(repository_type) is HTTPS. If C(true).
If not, certificate warnings are not ignored.
type: bool
repository_domain:
description:
- Domain name of the repository.
- This option is ignored when I(repository_type) is C(DELL_ONLINE).
type: str
catalog_description:
description:
- Description for the catalog.
type: str
repository_password:
description:
- Password to access the repository.
- This option is mandatory when I(repository_type) is CIFS.
- This option is ignored when I(repository_type) is C(DELL_ONLINE).
- C(NOTE) The module always reports the changed status, when this is provided.
type: str
repository_username:
description:
- User name of the repository where the catalog is stored.
- This option is mandatory when I(repository_type) is CIFS.
- This option is ignored when I(repository_type) is C(DELL_ONLINE).
type: str
associated_baselines:
description: IDs of the baselines associated with catalog.
elements: dict
returned: When I(state) is C(absent)
sample:
- BaselineId: 24
BaselineName: new
- BaselineId: 25
BaselineName: c7
- BaselineId: 27
BaselineName: c4
type: list
catalog_id:
description: IDs of the deleted catalog.
returned: When I(state) is C(absent)
sample: 10123
type: int
catalog_status:
description: Details of the catalog operation.
returned: When I(state) is C(present)
sample:
AssociatedBaselines: []
BaseLocation: null
BundlesCount: 0
Filename: catalog.gz
Id: 12
LastUpdated: null
ManifestIdentifier: null
ManifestVersion: null
NextUpdate: null
PredecessorIdentifier: null
ReleaseDate: null
ReleaseIdentifier: null
Repository:
CheckCertificate: true
Description: HTTPS Desc
DomainName: null
Id: null
Name: catalog4
Password: null
RepositoryType: HTTPS
Source: company.com
Username: null
Schedule: null
SourcePath: catalog
Status: null
TaskId: 10094
type: dict
error_info:
description: Details of the http error.
returned: on http error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to create or update the catalog because a repository with
the same name already exists.
Resolution: Enter a different name 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 catalog task.
returned: When catalog job is in a running state
sample: 10123
type: int
msg:
description: Overall status of the firmware catalog operation.
returned: always
sample: 'Successfully triggered the job to create a catalog with Task ID : 10094'
type: str