community.vmware.vcenter_extension (4.2.0) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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

Inputs

    
url:
    description:
    - Required for O(state=present). Link to server hosting extension zip file to install.
    type: str

name:
    description:
    - Required for O(state=present). The name of the extension you are installing.
    type: str

port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

email:
    description:
    - Required for O(state=present). Administrator email to use for extension.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Add or remove vCenter Extension.
    type: str

company:
    description:
    - Required for O(state=present). The name of the company that makes the extension.
    type: str

version:
    description:
    - The version of the extension you are installing or uninstalling.
    required: true
    type: str

visible:
    default: true
    description:
    - Show the extension in solution manager inside vCenter.
    type: bool

hostname:
    description:
    - 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 E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

proxy_host:
    description:
    - 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 E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - 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 E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

client_type:
    default: vsphere-client-serenity
    description:
    - Required for O(state=present). Type of client the extension is (win32, .net, linux,
      etc.).
    type: str

description:
    description:
    - Required for O(state=present). A short description of the extension.
    type: str

server_type:
    default: vsphere-client-serenity
    description:
    - Required for O(state=present). Type of server being used to install the extension
      (SOAP, REST, HTTP, etc.).
    type: str

extension_key:
    description:
    - The extension key of the extension to install or uninstall.
    required: true
    type: str

ssl_thumbprint:
    description:
    - Required for O(state=present). SSL thumbprint of the extension hosting server.
    type: str

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

Outputs

result:
  description: information about performed operation
  returned: always
  sample: '''com.acme.Extension'' installed.'
  type: str