vmware.vmware_rest.appliance_networking module – Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

Note

This module is part of the vmware.vmware_rest collection (version 2.1.5).

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 vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.appliance_networking.

New in version 2.0.0: of vmware.vmware_rest

Synopsis

  • Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

Requirements

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

  • vSphere 7.0.2 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

dns

dictionary

DNS Configuration to set for the machine Required with state=[‘change’]

Valid attributes are:

  • mode (str): dns_server_mode Describes DNS Server source (DHCP,static) ([‘change’])

    This key is required with [‘change’].

    • Accepted values:

      • dhcp

      • is_static

  • servers (list): List of the currently used DNS servers. ([‘change’])

    This key is required with [‘change’].

hostname

string

New hostname to assign to the management network of vCenter appliance Required with state=[‘change’]

ipv4

dictionary

IPv4 Configuration to set for the machine Required with state=[‘change’]

Valid attributes are:

  • mode (str): The mode defines different IPv4 address assignment modes. ([‘change’])

    This key is required with [‘change’].

    • Accepted values:

      • DHCP

      • STATIC

      • UNCONFIGURED

  • address (str): The IPv4 address, for example, “10.20.80.191”. ([‘change’])

  • prefix (int): The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. ([‘change’])

  • default_gateway (str): The IPv4 address of the default gateway. This configures the global default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. ([‘change’])

ipv6

dictionary

IPv6 Configuration to set for the machine Required with state=[‘change’]

Valid attributes are:

  • dhcp (bool): An address will be assigned by a DHCP server. ([‘change’])

    This key is required with [‘change’].

  • autoconf (bool): An address will be assigned by Stateless Address Autoconfiguration (SLAAC). ([‘change’])

    This key is required with [‘change’].

  • addresses (list): The list of addresses to be statically assigned. ([‘change’])

    This key is required with [‘change’].

  • default_gateway (str): The default gateway for static IP address assignment. This configures the global IPv6 default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. ([‘change’])

    This key is required with [‘change’].

ipv6_enabled

boolean

IPv6 Enabled or not

Choices:

  • no

  • yes

session_timeout

float

added in 2.1.0 of vmware.vmware_rest

Timeout settings for client session.

The maximal number of seconds for the whole operation including connection establishment, request sending and response.

The default value is 300s.

SSO_password

string

vCenter Server SSO administrator Password Required with state=[‘change’]

SSO_user

string

vCenter Server SSO administrator username Required with state=[‘change’]

state

string

Choices:

  • change

  • present ← (default)

  • reset

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_rest_log_file

string

You can use this optional parameter to set the location of a log file.

This file will be used to record the HTTP REST interaction.

The file will be stored on the host that run the module.

If the value is not specified in the task, the value of

environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

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.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Tested on vSphere 7.0.2

Examples

- name: Set network information
  vmware.vmware_rest.appliance_networking:
    ipv6_enabled: false
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

dictionary

moid of the resource

Returned: On success

value

dictionary

Set network information

Returned: On success

Sample: {}

Authors

  • Ansible Cloud Team (@ansible-collections)