appliance_networking_interfaces_ipv4
Set IPv4 network configuration for specific network interface
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.appliance_networking_interfaces_ipv4
Synopsis
Set IPv4 network configuration for specific network interface
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) 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 C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | 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. | ||||
| address | string | The IPv4 address, for example, “10.20.80.191”. | ||
| This field is optional and it is only relevant when the value of I(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 | yes | Network interface to update, for example, “nic0”. | |
| The parameter must be the id of a resource returned by M(vmware.vmware_rest.appliance_networking_interfaces_info). This parameter is mandatory. | ||||
| mode | string | yes | The I(mode) enumerated type defines different IPv4 address assignment modes. This parameter is mandatory. | |
| prefix | int | 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 I(mode) is STATIC. | ||||
| state | string | set | Operation to perform; allowed values: set. |
Example
yaml
- 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 == "The interface is unknown."
register: result