community.vmware.vmware_host_tcpip_stacks module – Manage the TCP/IP Stacks configuration of ESXi host
Note
This module is part of the community.vmware collection (version 2.10.2).
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_tcpip_stacks.
New in community.vmware 1.10.0
Synopsis
This module can be used to modify the TCP/IP stacks configuration.
Parameters
Parameter |
Comments |
|---|---|
The TCP/IP stacks configuration of the default. |
|
The IP address of the alternate dns server. |
|
The TCP congest control algorithm. Choices:
|
|
The domain name portion of the DNS name. |
|
The ipv4 gateway address. |
|
The host name of the ESXi host. |
|
The ipv6 gateway address. |
|
The maximum number of socket connection that are requested. Default: |
|
The IP address of the preferred dns server. |
|
The domain in which to search for hosts, placed in order of preference. Default: |
|
Name of the ESXi host. |
|
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: |
|
The TCP/IP stacks configuration of the provisioning. |
|
The TCP congest control algorithm. Choices:
|
|
The ipv4 gateway address. |
|
The ipv6 gateway address. |
|
The maximum number of socket connection that are requested. Default: |
|
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 |
|
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:
|
|
The TCP/IP stacks configuration of the vmotion. |
|
The TCP congest control algorithm. Choices:
|
|
The ipv4 gateway address. |
|
The ipv6 gateway address. |
|
The maximum number of socket connection that are requested. Default: |
|
The TCP/IP stacks configuration of the vxlan. |
|
The TCP congest control algorithm. Choices:
|
|
The ipv4 gateway address. |
|
The ipv6 gateway address. |
|
The maximum number of socket connection that are requested. Default: |
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Update the TCP/IP stack configuration of the default
community.vmware.vmware_host_tcpip_stacks:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: false
esxi_hostname: "{{ esxi_hostname }}"
default:
hostname: "{{ esxi_hostname }}"
domain: example.com
preferred_dns: 192.168.10.1
alternate_dns: 192.168.20.1
search_domains:
- hoge.com
- fuga.com
gateway: 192.168.10.1
congestion_algorithm: cubic
max_num_connections: 12000
- name: Update the TCP/IP stack configuration of the provisioning
community.vmware.vmware_host_tcpip_stacks:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: false
esxi_hostname: "{{ esxi_hostname }}"
provisioning:
congestion_algorithm: newreno
max_num_connections: 12000
gateway: 10.10.10.254
- name: Update the TCP/IP stack configuration of the default and provisioning
community.vmware.vmware_host_tcpip_stacks:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: false
esxi_hostname: "{{ esxi_hostname }}"
default:
hostname: "{{ esxi_hostname }}"
domain: example.com
preferred_dns: 192.168.10.1
alternate_dns: 192.168.20.1
search_domains:
- hoge.com
- fuga.com
gateway: 192.168.10.1
congestion_algorithm: cubic
max_num_connections: 12000
provisioning:
congestion_algorithm: newreno
max_num_connections: 12000
gateway: 10.10.10.254
- name: Update the ipv6 gateway of the provisioning TCP/IP stack
community.vmware.vmware_host_tcpip_stacks:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: false
esxi_hostname: "{{ esxi_hostname }}"
provisioning:
ipv6_gateway: ::ffff:6440:301
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
dict of the TCP/IP stack configuration of the default. Returned: always Sample: |
|
dict of the TCP/IP stack configuration of the provisioning. Returned: always Sample: |
|
dict of the TCP/IP stack configuration of the vmotion. Returned: always Sample: |
|
dict of the TCP/IP stack configuration of the vxlan. Returned: always Sample: |