vmware_vswitch_facts – Gathers facts about an ESXi host’s vswitch configurations

From Get docs
Ansible/docs/2.9/modules/vmware vswitch facts module


vmware_vswitch_facts – Gathers facts about an ESXi host’s vswitch configurations

New in version 2.6.


DEPRECATED

Removed in Ansible:
version: 2.13
Why: Deprecated in favour of _info module.
Alternative: Use vmware_vswitch_info instead.

Synopsis

  • This module can be used to gather facts about an ESXi host’s vswitch configurations when ESXi hostname or Cluster name is given.
  • The vSphere Client shows the value for the number of ports as elastic from vSphere 5.5 and above.
  • Other tools like esxcli might show the number of ports as 1536 or 5632.
  • See https://kb.vmware.com/s/article/2064511 for more details.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments

cluster_name

string

Name of the cluster.

Facts about vswitch belonging to every ESXi host systems under this cluster will be returned.

If esxi_hostname is not given, this parameter is required.

esxi_hostname

string

ESXi hostname to gather facts from.

If cluster_name is not given, this parameter is required.

hostname

string

The hostname or IP address of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

Environment variable support added in Ansible 2.6.

password

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

Environment variable support added in Ansible 2.6.


aliases: pass, pwd

port

integer

added in 2.5

Default:

443

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Environment variable support added in Ansible 2.6.

proxy_host

string

added in 2.9

Address of a proxy that will receive all HTTPS requests and relay them.

The format is a hostname or a IP.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.

This feature depends on a version of pyvmomi greater than v6.7.1.2018.12

proxy_port

integer

added in 2.9

Port of the HTTP proxy that will receive all HTTPS requests and relay them.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.

username

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

Environment variable support added in Ansible 2.6.


aliases: admin, user

validate_certs

boolean

  • no
  • yes

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.

Environment variable support added in Ansible 2.6.

If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.



Notes

Note

  • Tested on vSphere 6.5


Examples

- name: Gather vswitch facts about all ESXi Host in given Cluster
  vmware_vswitch_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    delegate_to: localhost
  register: all_hosts_vswitch_facts

- name: Gather firewall facts about ESXi Host
  vmware_vswitch_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    delegate_to: localhost
  register: all_vswitch_facts

Return Values

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

Key Returned Description

hosts_vswitch_facts

dictionary

on success

metadata about host's vswitch configuration


Sample:

{'10.76.33.218': {'vSwitch0': {'mtu': 1500, 'num_ports': 128, 'pnics': ['vmnic0']}, 'vSwitch_0011': {'mtu': 1500, 'num_ports': 128, 'pnics': ['vmnic2', 'vmnic1']}}}




Status

  • This module will be removed in version 2.13. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_vswitch_facts_module.html