dellemc.openmanage.omevv_vcenter_info module – Retrieve all or specific OpenManage Enterprise vCenter information.

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_vcenter_info.

New in dellemc.openmanage 9.8.0

Synopsis

  • This module allows you to retrieve all or specific vCenter information from OpenManage Enterprise.

Requirements

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

  • python >= 3.9.6

Parameters

Parameter

Comments

ca_path

path

added in dellemc.openmanage 5.0.0

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

hostname

string / required

OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.

password

string

OpenManage Enterprise or OpenManage Enterprise Modular password.

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

Example: export OME_PASSWORD=password

port

integer

OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.

Default: 443

timeout

integer

added in dellemc.openmanage 5.0.0

The socket level timeout in seconds.

Default: 30

username

string

OpenManage Enterprise or OpenManage Enterprise Modular username.

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

Example: export OME_USERNAME=username

validate_certs

boolean

added in dellemc.openmanage 5.0.0

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is false by default.

Choices:

  • false

  • true ← (default)

vcenter_hostname

string

vCenter IP address or hostname.

If vcenter_hostname is provided, the module retrieves only specified vCenter information.

x_auth_token

string

added in dellemc.openmanage 9.3.0

Authentication token.

If the x_auth_token is not provided, then the environment variable OME_X_AUTH_TOKEN is used.

Example: export OME_X_AUTH_TOKEN=x_auth_token

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 vCenter information.
  dellemc.openmanage.omevv_vcenter_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"

- name: Retrieve specific vCenter information.
  dellemc.openmanage.omevv_vcenter_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    vcenter_hostname: xx.xx.xx.xx

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 vCenter information for the retrieve operation.

Returned: always

Sample: "Successfully retrieved the vCenter information."

vcenter_info

list / elements=dictionary

Information on the vCenter.

Returned: success

Sample: [{"consoleAddress": "vcenter_ip_or_hostname", "description": "vCenter 8.0", "registeredExtensions": ["PHM", "WEBCLIENT", "PHA", "VLCM"], "uuid": "77373c7e-d2b0-453b-9888-102499919bd1"}, {"consoleAddress": "vcenter_ip_or_hostname", "description": "vCenter 8.1", "registeredExtensions": ["PHM", "WEBCLIENT", "PHA", "VLCM"], "uuid": "77373c7e-d2b0-453b-9888-102499919bd2"}]

Authors

  • Lovepreet Singh (@singh-lovepreet1)