Documentation

vcenter_license - Manage VMware vCenter license keys

New in version 2.4.

Synopsis

  • Add and delete vCenter license keys.

Requirements

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

  • pyVmomi

Parameters

Parameter
Choices/Defaults
Comments
hostname
required
The hostname or IP address of the vSphere vCenter.
labels
Default:
{'source': 'ansible'}
The optional labels of the license key to manage in vSphere vCenter.
This is dictionary with key/value pair.
license
required
The license key to manage in vSphere vCenter.
password
required
The password of the vSphere vCenter.

aliases: pass, pwd
port
(added in 2.5)
Default:
443
The port number of the vSphere vCenter or ESXi server.
state
    Choices:
  • absent
  • present ←
Whether to add (present) or remove (absent) the license key.
username
required
The username of the vSphere vCenter.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Notes

Note

  • This module will also auto-assign the current vCenter to the license key if the product matches the license key, and vCenter us currently assigned an evaluation license only.
  • The evaluation license (00000-00000-00000-00000-00000) is not listed when unused.

Examples

- name: Add a new vCenter license
  vcenter_license:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    license: f600d-21ae3-5592b-249e0-cc341
    state: present
  delegate_to: localhost

- name: Remove an (unused) vCenter license
  vmware_license:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    license: f600d-21ae3-5592b-249e0-cc341
    state: absent
  delegate_to: localhost

Return Values

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

Key
Returned
Description
licenses
list
always
list of license keys after module executed

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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation you can edit this document to improve it.