XLAB Steampunk logo Try Spotter
 / home / community / community.vmware / 4.2.0 / module / vmware_host_tcpip_stacks

community.vmware.vmware_host_tcpip_stacks (4.2.0) — module

Manage the TCP/IP Stacks configuration of ESXi host

Authors: sky-joker (@sky-joker)

Install collection | Add to requirements.yml | Description | Usage examples | Inputs | Outputs

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0


Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

This module can be used to modify the TCP/IP stacks configuration.

Usage examples

Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

vxlan:
    aliases:
    - nsx_overlay
    description:
    - The TCP/IP stacks configuration of the I(vxlan).
    suboptions:
      congestion_algorithm:
        choices:
        - newreno
        - cubic
        default: newreno
        description:
        - The TCP congest control algorithm.
        type: str
      gateway:
        description:
        - The ipv4 gateway address.
        type: str
      ipv6_gateway:
        description:
        - The ipv6 gateway address.
        type: str
      max_num_connections:
        default: 11000
        description:
        - The maximum number of socket connection that are requested.
        type: int
    type: dict

default:
    description:
    - The TCP/IP stacks configuration of the I(default).
    suboptions:
      alternate_dns:
        description:
        - The IP address of the alternate dns server.
        type: str
      congestion_algorithm:
        choices:
        - newreno
        - cubic
        default: newreno
        description:
        - The TCP congest control algorithm.
        type: str
      domain:
        description:
        - The domain name portion of the DNS name.
        required: true
        type: str
      gateway:
        description:
        - The ipv4 gateway address.
        type: str
      hostname:
        description:
        - The host name of the ESXi host.
        required: true
        type: str
      ipv6_gateway:
        description:
        - The ipv6 gateway address.
        type: str
      max_num_connections:
        default: 11000
        description:
        - The maximum number of socket connection that are requested.
        type: int
      preferred_dns:
        description:
        - The IP address of the preferred dns server.
        type: str
      search_domains:
        default: []
        description:
        - The domain in which to search for hosts, placed in order of preference.
        elements: str
        type: list
    type: dict

vmotion:
    description:
    - The TCP/IP stacks configuration of the I(vmotion).
    suboptions:
      congestion_algorithm:
        choices:
        - newreno
        - cubic
        default: newreno
        description:
        - The TCP congest control algorithm.
        type: str
      gateway:
        description:
        - The ipv4 gateway address.
        type: str
      ipv6_gateway:
        description:
        - The ipv6 gateway address.
        type: str
      max_num_connections:
        default: 11000
        description:
        - The maximum number of socket connection that are requested.
        type: int
    type: dict

hostname:
    description:
    - 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 E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

proxy_host:
    description:
    - 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 E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - 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 E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

provisioning:
    description:
    - The TCP/IP stacks configuration of the I(provisioning).
    suboptions:
      congestion_algorithm:
        choices:
        - newreno
        - cubic
        default: newreno
        description:
        - The TCP congest control algorithm.
        type: str
      gateway:
        description:
        - The ipv4 gateway address.
        type: str
      ipv6_gateway:
        description:
        - The ipv6 gateway address.
        type: str
      max_num_connections:
        default: 11000
        description:
        - The maximum number of socket connection that are requested.
        type: int
    type: dict

esxi_hostname:
    description:
    - Name of the ESXi host.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

Outputs

default:
  description: dict of the TCP/IP stack configuration of the default.
  returned: always
  sample: "{\n    \"alternate_dns\": \"192.168.20.1\",\n    \"congestion_algorithm\"\
    : \"cubic\",\n    \"domain\": \"example.com\",\n    \"gateway\": \"192.168.10.1\"\
    ,\n    \"ipv6_gateway\", null,\n    \"hostname\": \"esxi-test03\",\n    \"max_num_connections\"\
    : 12000,\n    \"preferred_dns\": \"192.168.10.1\",\n    \"search_domains\": [\n\
    \        \"hoge.com\",\n        \"fuga.com\"\n    ]\n}"
  type: dict
provisioning:
  description: dict of the TCP/IP stack configuration of the provisioning.
  returned: always
  sample: "{\n    \"congestion_algorithm\": \"newreno\",\n    \"gateway\": \"10.10.10.254\"\
    ,\n    \"ipv6_gateway\": null,\n    \"max_num_connections\": 12000\n}"
  type: dict
vmotion:
  description: dict of the TCP/IP stack configuration of the vmotion.
  returned: always
  sample: "{\n    \"congestion_algorithm\": \"newreno\",\n    \"gateway\": null,\n\
    \    \"ipv6_gateway\": null,\n    \"max_num_connections\": 11000\n}"
  type: dict
vxlan:
  description: dict of the TCP/IP stack configuration of the vxlan.
  returned: always
  sample: "{\n    \"congestion_algorithm\": \"newreno\",\n    \"gateway\": null,\n\
    \    \"ipv6_gateway\": null,\n    \"max_num_connections\": 11000\n}"
  type: dict
Got feedback? steampunk@xlab.si | © 2024. All rights reserved.
Cookie policy-Privacy policy-Terms of use-Security policy