vmware_vswitch - Manage a VMware Standard Switch to an ESXi host.

• Synopsis
  • Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status
• Maintenance
  • Author

Synopsis

• This module can be used to add, remove and update a VMware Standard Switch to an ESXi host.

Requirements

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

• python >= 2.6
• PyVmomi

Parameters

Notes

Examples

- name: Add a VMware vSwitch
  action:
    module: vmware_vswitch
    hostname: esxi_hostname
    username: esxi_username
    password: esxi_password
    switch: vswitch_name
    nics: vmnic_name
    mtu: 9000
  delegate_to: localhost

- name: Add a VMWare vSwitch without any physical NIC attached
  vmware_vswitch:
    hostname: 192.168.10.1
    username: admin
    password: password123
    switch: vswitch_0001
    mtu: 9000
  delegate_to: localhost

- name: Add a VMWare vSwitch with multiple NICs
  vmware_vswitch:
    hostname: esxi_hostname
    username: esxi_username
    password: esxi_password
    switch: vmware_vswitch_0004
    nics:
    - vmnic1
    - vmnic2
    mtu: 9000
  delegate_to: localhost

- name: Add a VMware vSwitch to a specific host system
  vmware_vswitch:
    hostname: 192.168.10.1
    username: esxi_username
    password: esxi_password
    esxi_hostname: DC0_H0
    switch_name: vswitch_001
    nic_name: vmnic0
    mtu: 9000
  delegate_to: localhost

Return Values

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

• Joseph Callen (@jcpowermac)
• Russell Teague (@mtnbikenc)
• Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>