community.vmware.vmware_host_ipv6 – Enables/Disables IPv6 support for an ESXi host system
Note
This plugin is part of the community.vmware collection (version 1.17.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_ipv6
.
Synopsis
This module can be used to enable or disable IPv6 support for ESXi host systems in given vCenter infrastructure.
It also checks if the host needs to be restarted.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
Parameters
Parameter |
Comments |
---|---|
Name of the cluster from which all host systems will be used. This is required parameter if |
|
Name of the host system to work with. This is required parameter if |
|
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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: 443 |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
Enable or disable IPv6 support. You need to reboot the ESXi host if you change the configuration. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
Tested on vSphere 6.5
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Enable IPv6 for an host system
community.vmware.vmware_host_ipv6:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
state: enabled
delegate_to: localhost
- name: Disable IPv6 for an host system
community.vmware.vmware_host_ipv6:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
state: disabled
delegate_to: localhost
- name: Disable IPv6 for all host systems from cluster
community.vmware.vmware_host_ipv6:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
state: disabled
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about host system’s IPv6 configuration Returned: always Sample: {“esxi01”: {“changed”: false, “msg”: “IPv6 is already enabled and active for host \u0027esxi01\u0027”}} |
Authors
Christian Kotte (@ckotte) <christian.kotte@gmx.de>