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.2.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 |
---|---|
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. |
|
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. |
|
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. |
|
The mode enumerated type defines different IPv4 address assignment modes. This parameter is mandatory. Choices:
|
|
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. |
|
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. |
|
Choices:
|
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
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 |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
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 |
---|---|
Set the IPv4 network information of nic99 (which does not exist) Returned: On success Sample: |
|
Set the IPv4 network information of nic99 (which does not exist) Returned: On success Sample: |