vmware.vmware_rest.vcenter_vm_hardware_ethernet_info module – Gather information about the virtual Ethernet adapters of a virtual machine.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Gather information about the virtual Ethernet (network) adapters attached to a virtual machine.

  • When nic is provided, returns the detailed configuration of that single adapter.

  • When nic is omitted, returns a list of all Ethernet adapters configured on the virtual machine.

  • Reported details include the adapter emulation type, MAC address, connection state, and network backing.

Parameters

Parameter

Comments

nic

string

Identifier of the virtual Ethernet adapter to gather information about.

Must be the MOID (managed object identifier) of a Nic resource on the virtual machine.

When omitted, information about all Ethernet adapters on the virtual machine is returned.

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)

vm

string / required

Identifier of the virtual machine whose Ethernet adapters are queried.

Must be the MOID (managed object identifier) of a Vm resource.

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: List all Ethernet adapters on a virtual machine
  vmware.vmware_rest.vcenter_vm_hardware_ethernet_info:
    vm: vm-1001
  register: all_nics

- name: Get details about a specific Ethernet adapter
  vmware.vmware_rest.vcenter_vm_hardware_ethernet_info:
    vm: vm-1001
    nic: "4000"
  register: my_nic

Return Values

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

Key

Description

id

string

MOID of the queried Ethernet adapter.

Returned: When only one resource, with a MOID, was queried.

Sample: "4000"

info

list / elements=string

A list of Ethernet adapters configured on the virtual machine.

Returned: On success.

Sample: [{"label": "Network adapter 1", "mac_address": "00:50:56:8a:1b:2c", "nic": "4000", "state": "CONNECTED", "type": "VMXNET3"}]

value

any

Raw output from the API response.

This output is maintained for consistency with version 4.x and earlier of this collection. It is recommended to switch to the info return key for a more consistent and documented output.

Returned: On success.

Sample: {"allow_guest_control": true, "backing": {"network": "network-1002", "type": "STANDARD_PORTGROUP"}, "label": "Network adapter 1", "mac_address": "00:50:56:8a:1b:2c", "mac_type": "ASSIGNED", "pci_slot_number": 160, "start_connected": true, "state": "CONNECTED", "type": "VMXNET3", "wake_on_lan_enabled": false}

Authors

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