Docs4dev
Docs
ansible / 2.6 / modules / vmware_host_acceptance_module.html

vmware_host_acceptance - Manage acceptance level of ESXi host

New in version 2.5.

Synopsis

  • This module can be used to manage acceptance level of an 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
    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
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
ESXi hostname.
Acceptance level of this ESXi host system will be managed.
If cluster_name is not given, this parameter is required.
hostname
str
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 version 2.6.
password
str
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 version 2.6.

aliases: pass, pwd
port
int

(added in 2.5)
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 version 2.6.
state
    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
str
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 version 2.6.

aliases: admin, user
validate_certs
bool
    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 version 2.6.
If set to yes, 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
  vmware_host_acceptance:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
    acceptance_level: 'community'
    state: present
  register: cluster_acceptance_level

- name: Set acceptance level to vmware_accepted for the given ESXi Host
  vmware_host_acceptance:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    acceptance_level: 'vmware_accepted'
    state: present
  register: host_acceptance_level

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

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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vmware_host_acceptance_module.html