community.vmware.vmware_host_acceptance module – Manage the host acceptance level of an ESXi host

Note

This module is part of the community.vmware collection (version 5.1.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.vmware_host_acceptance.

Synopsis

  • This module can be used to manage the host acceptance level of an ESXi host.

  • The host acceptance level controls the acceptance level of each VIB on a ESXi host.

Parameters

Parameter

Comments

cluster_name

string

Name of the cluster.

Acceptance level of all ESXi host system in the given cluster will be managed.

If esxi_hostname is not given, this parameter is required.

esxi_hostname

string

ESXi hostname.

Acceptance level of this ESXi host system will be managed.

If cluster_name is not given, this parameter is required.

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.

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.

state

string / required

If set to partner, then accept only partner and VMware signed and certified VIBs.

If set to vmware_certified, then accept only VIBs that are signed and certified by VMware.

If set to vmware_accepted, then accept VIBs that have been accepted by VMware.

If set to community, then accept all VIBs, even those that are not signed.

Choices:

  • "community"

  • "partner"

  • "vmware_accepted"

  • "vmware_certified"

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)

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: Set acceptance level to community for all ESXi Host in given Cluster
  community.vmware.vmware_host_acceptance:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
    state: 'community'
  delegate_to: localhost
  register: cluster_acceptance_level

- name: Set acceptance level to vmware_accepted for the given ESXi Host
  community.vmware.vmware_host_acceptance:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: 'vmware_accepted'
  delegate_to: localhost
  register: host_acceptance_level

Return Values

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

Key

Description

facts

dictionary

dict with hostname as key and dict with acceptance level facts, error as value

Returned: facts

Sample: {"facts": {"localhost.localdomain": {"error": "NA", "level": "vmware_certified"}}}

Authors

  • Abhijeet Kasurde (@Akasurde)