vmware.vmware.license_info module – Fetch VMware vCenter license keys

Note

This module is part of the vmware.vmware collection (version 1.6.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 vmware.vmware. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware.license_info.

Synopsis

  • Fetch vCenter, ESXi server license keys.

Requirements

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

  • Python SDK for the VMware vSphere Management API

Parameters

Parameter

Comments

cluster

aliases: cluster_name

string

The cluster to use when connecting to a vCenter.

datacenter

aliases: datacenter_name

string

The datacenter to use when connecting to a vCenter.

hostname

string

The hostname or IP address of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

Address of a proxy that will receive all HTTPS requests and relay them.

The format is a hostname or a IP.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

Port of the HTTP proxy that will receive all HTTPS requests and relay them.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.

username

aliases: admin, user

string

The username of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

The check_mode support.

Notes

Note

  • All modules require API write access and hence is not supported on a free ESXi license.

Examples

- name: Fetch vCenter license
  vmware.vmware.license_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'

Return Values

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

Key

Description

licenses

list / elements=string

List of license keys.

Returned: always

Sample: ["f600d-21ae3-5592b-249e0-cc341", "143cc-0e942-b2955-3ea12-d006f"]

Authors

  • Ansible Cloud Team (@ansible-collections)