Docs4dev
Docs
ansible / latest / collections / community / vmware / vcenter_extension_module.html

community.vmware.vcenter_extension – Register/deregister vCenter Extensions

Note

This plugin is part of the community.vmware collection (version 1.15.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 community.vmware.

To use it in a playbook, specify: community.vmware.vcenter_extension.

Synopsis

  • This module can be used to register/deregister vCenter Extensions.

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
client_type
string
Default:
"vsphere-client-serenity"
Required for state=present. Type of client the extension is (win32, .net, linux, etc.).
company
string
Required for state=present. The name of the company that makes the extension.
description
string
Required for state=present. A short description of the extension.
email
string
Required for state=present. Administrator email to use for extension.
extension_key
string / required
The extension key of the extension to install or uninstall.
hostname
string
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable support added in Ansible 2.6.
name
string
Required for state=present. The name of the extension you are installing.
password
string
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable support added in Ansible 2.6.

aliases: pass, pwd
port
integer
Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable support added in Ansible 2.6.
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.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
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.
server_type
string
Default:
"vsphere-client-serenity"
Required for state=present. Type of server being used to install the extension (SOAP, REST, HTTP, etc.).
ssl_thumbprint
string
Required for state=present. SSL thumbprint of the extension hosting server.
state
string
    Choices:
  • absent
  • present ←
Add or remove vCenter Extension.
url
string
Required for state=present. Link to server hosting extension zip file to install.
username
string
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable support added in Ansible 2.6.

aliases: admin, user
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
Environment variable support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
version
string / required
The version of the extension you are installing or uninstalling.
visible
boolean
    Choices:
  • no
  • yes ←
Show the extension in solution manager inside vCenter.

Notes

Note

  • Tested on vSphere 6.5
  • All modules requires API write access and hence is not supported on a free ESXi license.

Examples

- name: Register vCenter Extension
  community.vmware.vcenter_extension:
     hostname: "{{ groups['vcsa'][0] }}"
     username: "{{ vcenter_username }}"
     password: "{{ site_password }}"
     extension_key: "{{ extension_key }}"
     version: "1.0"
     company: "Acme"
     name: "Acme Extension"
     description: "acme management"
     email: "user@example.com"
     url: "https://10.0.0.1/ACME-vSphere-web-plugin-1.0.zip"
     ssl_thumbprint: "{{ ssl_thumbprint }}"
     state: present
  delegate_to: localhost
  register: register_extension

- name: Deregister vCenter Extension
  community.vmware.vcenter_extension:
     hostname: "{{ groups['vcsa'][0] }}"
     username: "{{ vcenter_username }}"
     password: "{{ site_password }}"
     extension_key: "{{ extension_key }}"
     version: "1.0"
     state: absent
  delegate_to: localhost
  register: deregister_extension

Return Values

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

Key Returned Description
result
string
always
information about performed operation

Sample:
'com.acme.Extension' installed.


Authors

  • Michael Tipton (@castawayegr)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vcenter_extension_module.html