W3cubDocs

/Ansible

community.vmware.vcenter_extension module – Register/deregister vCenter Extensions

Note

This module is part of the community.vmware collection (version 5.7.2).

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
Parameters
Notes
Examples
Return Values

Synopsis

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

Parameters

Parameter	Comments
client_type string	Required for `state=present`. Type of client the extension is (win32, .net, linux, etc.). Default: `"vsphere-client-serenity"`
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.
name string	Required for `state=present`. The name of the extension you are installing.
password aliases: pass, pwd 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.
port integer	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. 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.
server_type string	Required for `state=present`. Type of server being used to install the extension (SOAP, REST, HTTP, etc.). Default: `"vsphere-client-serenity"`
ssl_thumbprint string	Required for `state=present`. SSL thumbprint of the extension hosting server.
state string	Add or remove vCenter Extension. Choices: `"absent"` `"present"` ← (default)
url string	Required for `state=present`. Link to server hosting extension zip file to install.
username aliases: admin, user 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.
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)
version string / required	The version of the extension you are installing or uninstalling.
visible boolean	Show the extension in solution manager inside vCenter. Choices: `false` `true` ← (default)

Notes

Note

All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.

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: "[email protected]"
     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	Description
result string	information about performed operation Returned: always Sample: `"'com.acme.Extension' installed."`

Authors

Michael Tipton (@castawayegr)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 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