vmware.vmware_rest.vcenter_vm_guest_networking_routes_info module – Returns information about the network routing in the guest operating system 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_guest_networking_routes_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Returns the network routing table reported by VMware Tools for a virtual machine’s guest operating system.

  • Each route describes a destination network, its prefix length, the gateway used to reach it, and the guest network interface it is associated with.

  • VMware Tools must be installed and running in the guest for this information to be available.

Parameters

Parameter

Comments

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 guest network routing information is returned.

Must be the managed object identifier (MOID) of a virtual machine, as returned by vmware.vmware_rest.vcenter_vm_info.

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: Look up the VM called test_vm1 in the inventory
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
      - test_vm1
  register: search_result

- name: Get guest network routing information for the VM
  vmware.vmware_rest.vcenter_vm_guest_networking_routes_info:
    vm: "{{ search_result.value[0].vm }}"
  register: guest_routes

- name: Display the guest network routes
  ansible.builtin.debug:
    var: guest_routes.info

Return Values

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

Key

Description

info

list / elements=dictionary

A list of all network routes reported by the guest operating system.

This is always a list, regardless of how many routes the guest reports.

Returned: On success

Sample: [{"gateway_address": "10.0.2.2", "interface_index": 0, "network": "0.0.0.0", "prefix_length": 0}, {"interface_index": 0, "network": "10.0.2.0", "prefix_length": 24}]

value

any

Information about the network routes configured in the guest operating system.

Returned as a single route dictionary when the guest reports exactly one route, or as a list of route dictionaries when it reports more than one.

Returned: On success

Sample: [{"gateway_address": "10.0.2.2", "interface_index": 0, "network": "0.0.0.0", "prefix_length": 0}, {"interface_index": 0, "network": "10.0.2.0", "prefix_length": 24}]

Authors

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