vmware.vmware.license_info module – Fetch VMware vCenter license keys
Note
This module is part of the vmware.vmware collection (version 1.4.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 |
---|---|
The cluster to use when connecting to a vCenter. |
|
The datacenter to use when connecting to a vCenter. |
|
The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
The check_mode support. |
Notes
Note
All modules requires 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 |
---|---|
List of license keys. Returned: always Sample: |