vmware.vmware_rest.appliance_networking module – Manage the network configuration of the vCenter Server Appliance.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.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 vmware.vmware_rest.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Manage the network configuration of the vCenter Server Appliance across all of its interfaces.

  • Use state=reset to reset and restart the network configuration on all interfaces. This also renews the DHCP lease for any interface using a DHCP-assigned address.

  • IPv6 can be enabled or disabled on all interfaces with ipv6_enabled.

  • Use vmware.vmware_rest.appliance_networking_info to view the current network configuration.

Parameters

Parameter

Comments

ipv6_enabled

boolean

Whether IPv6 is enabled on all interfaces.

If not specified, the current state of IPv6 is left unchanged.

Due to the limitations of the vSphere API, this parameter does not support idempotency. If this parameter is specified, a change will always be reported.

This property was added in vSphere API 6.7.

Choices:

  • false

  • true

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

state

string

The desired state of the appliance network configuration.

Use present to apply the IPv6 enablement given in ipv6_enabled.

Use reset to reset and restart the network configuration on all interfaces.

Choices:

  • "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_port

integer

The port number of the vSphere vCenter.

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

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

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:

  • false

  • true ← (default)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Enable IPv6 on all appliance interfaces
  vmware.vmware_rest.appliance_networking:
    ipv6_enabled: true
    state: present

- name: Disable IPv6 on all appliance interfaces
  vmware.vmware_rest.appliance_networking:
    ipv6_enabled: false
    state: present

- name: Reset and restart the appliance network configuration
  vmware.vmware_rest.appliance_networking:
    state: reset

Return Values

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

Key

Description

value

any

The raw API response body from the vCenter operation. Empty when the operation returns no content.

Returned: On success

Sample: {}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)