vmware_vswitch - Manage a VMware Standard Switch to an ESXi host.
New in version 2.0.
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
Parameter | Choices/Defaults | Comments |
---|---|---|
esxi_hostname
(added in 2.5)
|
Manage the vSwitch using this ESXi host system.
aliases: host |
|
hostname
str
|
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 version 2.6.
|
|
mtu | Default:
1500
|
MTU to configure on vSwitch.
|
nics | Default:
[]
|
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 | Default:
128
|
Number of port to configure on vSwitch.
|
password
str
|
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 version 2.6.
aliases: pass, pwd |
|
port
int
(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 version 2.6.
|
state |
|
Add or remove the switch.
|
switch
required
|
vSwitch name to add.
Alias
switch is added in version 2.4.
aliases: switch_name |
|
username
str
|
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 version 2.6.
aliases: admin, user |
|
validate_certs
bool
|
|
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 version 2.6.
If set to
yes , please make sure Python >= 2.7.9 is installed on the given machine.
|
Notes
Note
- Tested on vSphere 5.5 and 6.5
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:
Key | Returned | Description |
---|---|---|
result
string
|
always |
information about performed operation
Sample:
vSwitch 'vSwitch_1002' is created successfully
|
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>
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.6/modules/vmware_vswitch_module.html