Docs4dev
Docs
ansible / 2.11 / collections / dellemc / openmanage / ome_firmware_catalog_module.html

dellemc.openmanage.ome_firmware_catalog – Creates a catalog 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_catalog.

New in version 2.0.0: of dellemc.openmanage

Synopsis

  • This module triggers the job to create a catalog 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
catalog_description
string
Description of the catalog being created.
catalog_name
string / required
Name of the firmware catalog being created.
check_certificate
boolean
    Choices:
  • no ←
  • yes
Specifies if certificate warnings are ignored when repository_type is HTTPS.If True option is set, then the certificate warnings are ignored otherwise certificate warnings are not ignored.
file_name
string
Catalog file name relative to the source_path.
hostname
string / required
Target IP address or hostname.
password
string / required
Target user password.
port
integer
Default:
443
Target HTTPS port.
repository_domain
string
Domain name of the repository.
repository_password
string
Password to access the repository.
This option is mandatory when repository_type is CIFS.
repository_type
string
    Choices:
  • HTTP
  • NFS
  • CIFS
  • HTTPS ←
Type of Repository. The type supported are HTTP, NFS, CIFS, HTTPS.
repository_username
string
User name of the repository where the catalog is stored.
This option is mandatory when repository_type is CIFS.
source
string
The share address of the system where the firmware catalog is stored on the network.
source_path
string
Full Path of the catalog file location excluding file name.
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 catalog from repository on a HTTPS
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    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 catalog from repository on a HTTP
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "HTTP"
    source: "downloads.dell.com"
    source_path: "catalog"
    file_name: "catalog.gz"

- name: Create catalog from CIFS network share
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    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 catalog from NFS network share
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "NFS"
    source: "192.166.0.2"
    source_path: "/nfs/R940"
    file_name: "catalog.xml"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
catalog_status
dictionary
on success
Details of the catalog creation.

Sample:
{'AssociatedBaselines': [], 'BaseLocation': None, 'BundlesCount': 0, 'Filename': 'catalog.gz', 'Id': 0, 'LastUpdated': None, 'ManifestIdentifier': None, 'ManifestVersion': None, 'NextUpdate': None, 'PredecessorIdentifier': None, 'ReleaseDate': None, 'ReleaseIdentifier': None, 'Repository': {'CheckCertificate': True, 'Description': 'HTTPS Desc', 'DomainName': None, 'Id': None, 'Name': 'catalog4', 'Password': None, 'RepositoryType': 'HTTPS', 'Source': 'company.com', 'Username': None}, 'Schedule': None, 'SourcePath': 'catalog', 'Status': None, 'TaskId': 10094}
error_info
dictionary
on http error
Details of 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.'}}
msg
string
always
Overall status of the firmware catalog creation.

Sample:
Successfully triggered the job to create a catalog with Task Id : 10094


Authors

  • Sajna Shetty(@Sajna-Shetty)

© 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_catalog_module.html