W3cubDocs

/Ansible

vmware_vswitch - Add a VMware Standard Switch to an ESXi host

New in version 2.0.

Synopsis

Add 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
nic_name
 yes
vmnic name to attach to vswitch
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
  • present
  • absent
Add or remove the switch
switch_name
 yes
vSwitch name to add
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

Example from Ansible playbook

    - name: Add a VMware vSwitch
      local_action:
        module: vmware_vswitch
        hostname: esxi_hostname
        username: esxi_username
        password: esxi_password
        switch_name: vswitch_name
        nic_name: vmnic_name
        mtu: 9000

Notes

Note

Tested on vSphere 5.5

This is an Extras Module

For more information on what this means please read Extras Modules

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

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