vmware.vmware_rest.vcenter_network_info module – Gather information about vCenter networks.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about one or more VMware vCenter networks.

  • Returns the networks that match the supplied filters, or all networks when no filter is given.

  • Use the filter parameters to narrow results by network name, identifier, type, folder, or datacenter.

Parameters

Parameter

Comments

datacenters

aliases: filter_datacenters

list / elements=string

A list of datacenter MOIDs to filter the results.

Only networks that reside in the specified datacenters will be returned.

If omitted or empty, networks in any datacenter are returned.

folders

aliases: filter_folders

list / elements=string

A list of folder MOIDs to filter the results.

Only networks that reside in the specified folders will be returned.

If omitted or empty, networks in any folder are returned.

names

aliases: filter_names

list / elements=string

A list of network names to filter the results.

Only networks whose names appear in this list will be returned.

If omitted or empty, networks with any name are returned.

networks

list / elements=string

A list of network MOIDs to filter the results.

Only networks whose identifiers appear in this list will be returned.

If omitted or empty, networks with any identifier are returned.

session_timeout

float

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

Default: 300.0

types

aliases: filter_types

list / elements=string

A list of network types to filter the results.

Only networks of one of the listed types will be returned.

STANDARD_PORTGROUP - vSphere standard portgroup (created and managed on ESX).

DISTRIBUTED_PORTGROUP - Distributed virtual portgroup (created and managed through vCenter).

OPAQUE_NETWORK - A network whose configuration is managed outside of vSphere. The identifier and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.

If omitted or empty, networks of any type are returned.

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: List all networks
  vmware.vmware_rest.vcenter_network_info:
  register: all_networks

- name: Filter networks by name
  vmware.vmware_rest.vcenter_network_info:
    names:
      - VM Network
  register: filtered_networks

- name: List distributed portgroups
  vmware.vmware_rest.vcenter_network_info:
    types:
      - DISTRIBUTED_PORTGROUP
  register: dvpg_networks

- name: List standard portgroups in a specific datacenter
  vmware.vmware_rest.vcenter_network_info:
    types:
      - STANDARD_PORTGROUP
    datacenters:
      - datacenter-1001
  register: dc_networks

Return Values

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

Key

Description

info

list / elements=string

A list of networks matching the query.

Returned: On success.

Sample: [{"name": "VM Network", "network": "network-1001", "type": "STANDARD_PORTGROUP"}]

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: {"name": "VM Network", "network": "network-1001", "type": "STANDARD_PORTGROUP"}

Authors

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