Docs4dev
Docs
ansible / 2.4 / vmware_vswitch_module.html

vmware_vswitch - Add or remove a VMware Standard Switch to an ESXi host

New in version 2.0.

Synopsis

  • Add or remove a VMware Standard Switch to an ESXi host.

Requirements (on host that executes module)

  • python >= 2.6
  • PyVmomi

Options

parameter required default choices comments
hostname
 yes
The hostname or IP address of the vSphere vCenter.
mtu
 no
MTU to configure on vSwitch.
nics
 no
A list of vmnic names or vmnic name to attach to vSwitch.
Alias nics is added in version 2.4.
aliases: nic_name
number_of_ports
 no 128
Number of port to configure on vSwitch.
password
 yes
The password of the vSphere vCenter.
aliases: pass, pwd
state
 no present
  • absent
  • present
Add or remove the switch.
switch
 yes
vSwitch name to add.
Alias switch is added in version 2.4.
aliases: switch_name
username
 yes
The username of the vSphere vCenter.
aliases: user, admin
validate_certs
 no True
  • True
  • False
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

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

Notes

Note

  • Tested on vSphere 5.5

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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