vmware.vmware_rest.appliance_networking_interfaces_ipv4 module – Set IPv4 network configuration for specific network interface.

Note

This module is part of the vmware.vmware_rest collection (version 4.3.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in vmware.vmware_rest 2.0.0

Synopsis

  • Set IPv4 network configuration for specific network interface.

Requirements

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

  • vSphere 7.0.3 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

address

string

The IPv4 address, for example, “10.20.80.191”.

This field is optional and it is only relevant when the value of mode is STATIC.

default_gateway

string

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.

If unset, the defaultGateway was never set.

interface_name

string / required

Network interface to update, for example, “nic0”.

The parameter must be the id of a resource returned by vmware.vmware_rest.appliance_networking_interfaces_info. This parameter is mandatory.

mode

string / required

The mode enumerated type defines different IPv4 address assignment modes. This parameter is mandatory.

Choices:

  • "DHCP"

  • "STATIC"

  • "UNCONFIGURED"

prefix

integer

The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.

This field is optional and it is only relevant when the value of mode is STATIC.

session_timeout

float

added in vmware.vmware_rest 2.1.0

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.

state

string

Choices:

  • "set" ← (default)

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 runs 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:

  • false

  • true ← (default)

Notes

Note

  • Tested on vSphere 7.0.3

Examples

- name: Set the IPv4 network information of nic99 (which does not exist)
  vmware.vmware_rest.appliance_networking_interfaces_ipv4:
    interface_name: nic99
    config:
      address: 10.20.80.191
      prefix: '32'
      mode: STATIC
  failed_when:
  - not(result.failed)
  - result.value.messages[0].default_message msg == "The interface is unknown."
  register: result

Return Values

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

Key

Description

failed_when_result

integer

Set the IPv4 network information of nic99 (which does not exist)

Returned: On success

Sample: 0

msg

string

Set the IPv4 network information of nic99 (which does not exist)

Returned: On success

Sample: "missing required arguments: mode"

Authors

  • Ansible Cloud Team (@ansible-collections)