dellemc.openmanage.omevv_firmware_repository_profile_info module – Retrieve OMEVV firmware repository profile information.

Note

This module is part of the dellemc.openmanage collection (version 9.9.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.omevv_firmware_repository_profile_info.

New in dellemc.openmanage 9.8.0

Synopsis

  • This module allows you to retrieve the OMEVV firmware repository profile information.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9.6

Parameters

Parameter

Comments

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

hostname

string / required

IP address or hostname of the OpenManage Enterprise Modular.

name

string

Name of the OMEVV firmware repository profile.

If name is provided, the module retrieves only specified firmware repository profile information.

port

integer

OpenManage Enterprise HTTPS port.

Default: 443

timeout

integer

The socket level timeout in seconds.

Default: 30

validate_certs

boolean

Whether to check SSL certificate. - If true, the SSL certificates will be validated. - If false, the SSL certificates will not be validated.

Choices:

  • false

  • true ← (default)

vcenter_password

string

Password for OpenManage Enterprise Integration for VMware vCenter (OMEVV).

If the password is not provided, then the environment variable OMEVV_VCENTER_PASSWORD is used.

Example: export OMEVV_VCENTER_PASSWORD=password

vcenter_username

string

Username for OpenManage Enterprise Integration for VMware vCenter (OMEVV).

If the username is not provided, then the environment variable OMEVV_VCENTER_USERNAME is used.

Example: export OMEVV_VCENTER_USERNAME=username

vcenter_uuid

string

Universally Unique Identifier (UUID) of vCenter.

vCenter UUID details can be retrieved using dellemc.openmanage.omevv_vcenter_info module.

If UUID is not provided, then the environment variable OMEVV_VCENTER_UUID is used.

Example: export OMEVV_VCENTER_UUID=uuid

Attributes

Attribute

Support

Description

check_mode

Support: full

Runs task to validate without performing action on the target machine.

Notes

Note

  • This module supports IPv4 and IPv6 addresses.

Examples

---
- name: Retrieve all firmware repository profile information.
  dellemc.openmanage.omevv_firmware_repository_profile_info:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"

- name: Retrieve specific firmware repository profile information using profile name.
  dellemc.openmanage.omevv_firmware_repository_profile_info:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    name: profile-1

Return Values

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

Key

Description

error_info

dictionary

Details of the HTTP Error.

Returned: on HTTP error

Sample: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

string

Status of the firmare repository profile information for the retrieve operation.

Returned: always

Sample: "Successfully retrieved the firmware repository profile information."

profile_info

list / elements=dictionary

Information on the vCenter.

Returned: success

Sample: [{"catalogCreatedDate": "2024-08-27T01:58:10Z", "catalogLastChecked": "2024-09-09T19:30:16Z", "checkCertificate": null, "createdBy": "OMEVV Default", "description": "Latest Firmware From Dell", "factoryCreated": true, "factoryType": "Default", "fileName": "catalog.xml", "id": 1000, "modifiedBy": null, "owner": "OMEVV", "profileName": "Dell Default Catalog", "profileType": "Firmware", "protocolType": "HTTPS", "sharePath": "https://downloads.dell.com//catalog/catalog.xml.gz", "status": "Success"}, {"catalogCreatedDate": "2024-08-27T01:58:10Z", "catalogLastChecked": "2024-09-09T19:30:16Z", "checkCertificate": null, "createdBy": "OMEVV Default", "description": "Latest Firmware From Dell", "factoryCreated": true, "factoryType": "Default", "fileName": "catalog.xml", "id": 1001, "modifiedBy": null, "owner": "OMEVV", "profileName": "Dell Default Catalog", "profileType": "Firmware", "protocolType": "HTTPS", "sharePath": "https://downloads.dell.com//catalog/catalog.xml.gz", "status": "Success"}]

Authors

  • Lovepreet Singh (@singh-lovepreet1)