/ home / ansible / ansible.builtin / v2.6.0 / module / vmware_vswitch_facts

ansible.builtin.vmware_vswitch_facts (v2.6.0) — module

Gathers facts about an ESXi host's vswitch configurations

| "added in version" 2.6 of ansible.builtin"

Authors: Abhijeet Kasurde (@Akasurde)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.6.0

Description

This module can be used to gather facts about an ESXi host's vswitch configurations when ESXi hostname or Cluster name is given.

Requirements

python >= 2.6
PyVmomi

Usage examples

Scanned by Steampunk Spotter

- 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
  register: all_hosts_vswitch_facts

Scanned by Steampunk Spotter

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

Inputs

port:
default: 443
description:
- The port number of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PORT)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: int

hostname:
description:
- 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 C(VMWARE_HOST)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: str

password:
aliases:
- pass
- pwd
description:
- The password of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: str

username:
aliases:
- admin
- user
description:
- The username of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable C(VMWARE_USER)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: str

proxy_host:
description:
- 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 C(VMWARE_PROXY_HOST)
will be used instead.
- This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
required: false
type: str

proxy_port:
description:
- 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 C(VMWARE_PROXY_PORT)
will be used instead.
required: false
type: int

cluster_name:
description:
- Name of the cluster.
- Facts about vswitch belonging to every ESXi host systems under this cluster will
be returned.
- If C(esxi_hostname) is not given, this parameter is required.

esxi_hostname:
description:
- ESXi hostname to gather facts from.
- If C(cluster_name) is not given, this parameter is required.

validate_certs:
default: true
description:
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates
are not trusted.
- If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS)
will be used instead.
- Environment variable support added in Ansible 2.6.
- If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine.
type: bool

Outputs

hosts_vswitch_facts:
  description: metadata about host's vswitch configuration
  returned: on success
  sample:
    10.76.33.218:
      vSwitch0:
        mtu: 1500
        num_ports: 1536
        pnics:
        - vmnic0
      vSwitch_0011:
        mtu: 1500
        num_ports: 1536
        pnics:
        - vmnic2
        - vmnic1
  type: dict

Install Ansible via pip