dellemc.openmanage.omevv_firmware_repository_profile module – Create, modify, or delete OMEVV firmware repository profile

Note

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

New in dellemc.openmanage 9.8.0

Synopsis

  • This module allows you to create, modify, or delete an OpenManage Enterprise Integration for VMware Center (OMEVV) firmware repository profile.

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.

catalog_path

string

Absolute path of the catalog.

HTTP, HTTPS, NFS, and CIFS paths are supported.

This parameter is required when state is present.

description

string

Description of OMEVV firmware repository profile.

hostname

string / required

IP address or hostname of the OpenManage Enterprise Modular.

name

string

Name of the OMEVV firmware repository profile.

This parameter is required for modification operation when state is absent.

new_name

string

Name of the new OMEVV profile name when modify operation is performed.

port

integer

OpenManage Enterprise HTTPS port.

Default: 443

protocol_type

string

NFS represents the NFS share path.

CIFS represents the NFS share path.

HTTP represents the HTTP share path.

HTTPS represents the HTTPS share path.

This parameter is required when state is present and a new profile is created.

Choices:

  • "NFS"

  • "CIFS"

  • "HTTP"

  • "HTTPS"

share_domain

string

Domain of the share.

share_password

string

Password of the share.

This parameter is required when catalog_path is HTTPS or CIFS.

share_username

string

Username of the share.

This parameter is required when catalog_path is HTTPS or CIFS.

state

string

present creates an OMEVV firmware repository profile or modifies an existing profile if the profile with the same name exists.

absent deletes the OMEVV firmware repository profile.

Either profile_name or profile_id is required when state is absent.

Choices:

  • "present" ← (default)

  • "absent"

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.

diff_mode

Support: full

Runs the task to report the changes that are made or the changes that must be applied.

Notes

Note

  • Run this module from a system that has direct access to Dell OpenManage Enterprise.

Examples

---
- name: Create an OMEVV firmware repository profile
  dellemc.openmanage.omevv_firmware_repository_profile:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    state: present
    name: profile-1
    catalog_path: http://xx.xx.xx.xx/share/Catalog/Catalog.xml

- name: Modify an OMEVV firmware repository profile
  dellemc.openmanage.omevv_firmware_repository_profile:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    state: present
    name: profile-1
    new_name: profile-2
    catalog_path: http://xx.xx.xx.xx/new_share/Catalog/Catalog.xml

- name: Delete an OMEVV firmware repository profile
  dellemc.openmanage.omevv_firmware_repository_profile:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    state: absent
    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: {"errorCode": "18001", "message": "Repository profile with name Test already exists."}

msg

string

Status of the profile operation.

Returned: always

Sample: "Successfully created the OMEVV firmware repository profile."

Authors

  • Shivam Sharma(@ShivamSh3)