vmware.vmware_rest.appliance_networking_interfaces_ipv4_info module – Retrieve the IPv4 configuration of a vCenter Server Appliance network interface.

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_interfaces_ipv4_info.

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This functionality has been moved to vmware.vmware.appliance_info.

Alternative:

Use vmware.vmware.appliance_info instead.

Synopsis

  • Gather the current IPv4 settings of a specific network interface on the vCenter Server Appliance.

  • The returned information includes the address assignment mode, the IPv4 address, the CIDR prefix, and the default gateway.

  • Use vmware.vmware_rest.appliance_networking_interfaces_ipv4 to change the IPv4 configuration.

Parameters

Parameter

Comments

interface_name

string / required

The name of the network interface to query, for example nic0.

The value is the identifier of an interface returned by vmware.vmware_rest.appliance_networking_interfaces_info.

session_timeout

float

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

Default: 300.0

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: Get the IPv4 configuration of nic0
  vmware.vmware_rest.appliance_networking_interfaces_ipv4_info:
    interface_name: nic0
  register: result

Return Values

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

Key

Description

id

string

The name of the queried network interface.

Returned: On success

Sample: "nic0"

value

dictionary

The IPv4 configuration of the network interface.

Returned: On success

Sample: {"address": "192.168.123.8", "configurable": true, "default_gateway": "192.168.123.1", "mode": "STATIC", "prefix": 24}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

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