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

Note

This plugin is part of the community.vmware collection (version 1.9.0).

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.

Requirements

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

  • python >= 2.6

  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
acceptance_level
string
    Choices:
  • community
  • partner
  • vmware_accepted
  • vmware_certified
Name of acceptance level.
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.
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.
Environment variable support added in Ansible 2.6.
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.
state
string
    Choices:
  • list ←
  • present
Set or list acceptance level of the given ESXi host.
If set to list, then will return current acceptance level of given host system/s.
If set to present, then will set given acceptance level.
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.

Notes

Note

  • Tested on vSphere 6.5

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
    acceptance_level: 'community'
    state: present
  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 }}'
    acceptance_level: 'vmware_accepted'
    state: present
  delegate_to: localhost
  register: host_acceptance_level

- name: Get acceptance level from the given ESXi Host
  community.vmware.vmware_host_acceptance:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: list
  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 Returned Description
facts
dictionary
facts
dict with hostname as key and dict with acceptance level facts, error as value

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


Authors

  • Abhijeet Kasurde (@Akasurde)