community / community.vmware / 1.18.2 / module / vmware_vswitch Manage a VMware Standard Switch to an ESXi host. Authors: Joseph Callen (@jcpowermac), Russell Teague (@mtnbikenc), Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>community.vmware.vmware_vswitch (1.18.2) — module
Install with ansible-galaxy collection install community.vmware:==1.18.2
collections: - name: community.vmware version: 1.18.2
This module can be used to add, remove and update a VMware Standard Switch to an ESXi host.
- name: Add a VMware vSwitch community.vmware.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 community.vmware.vmware_vswitch: hostname: '{{ esxi_hostname }}' username: '{{ esxi_username }}' password: '{{ esxi_password }}' switch: vswitch_0001 mtu: 9000 delegate_to: localhost
- name: Add a VMware vSwitch with multiple NICs community.vmware.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 community.vmware.vmware_vswitch: hostname: '{{ esxi_hostname }}' username: '{{ esxi_username }}' password: '{{ esxi_password }}' esxi_hostname: DC0_H0 switch_name: vswitch_001 nic_name: vmnic0 mtu: 9000 delegate_to: localhost
- name: Delete a VMware vSwitch in a specific host system community.vmware.vmware_vswitch: hostname: '{{ esxi_hostname }}' username: '{{ esxi_username }}' password: '{{ esxi_password }}' esxi_hostname: DC0_H0 switch_name: vswitch_001 state: absent delegate_to: localhost
mtu: default: 1500 description: - MTU to configure on vSwitch. type: int nics: aliases: - nic_name default: [] description: - A list of vmnic names or vmnic name to attach to vSwitch. - Alias C(nics) is added in version 2.4. elements: str type: list 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 state: choices: - absent - present default: present description: - Add or remove the switch. type: str switch: aliases: - switch_name description: - vSwitch name to add. - Alias C(switch) is added in version 2.4. required: true type: str 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 esxi_hostname: aliases: - host description: - Manage the vSwitch using this ESXi host system. type: str 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(true), please make sure Python >= 2.7.9 is installed on the given machine. type: bool number_of_ports: default: 128 description: - Number of port to configure on vSwitch. type: int
result: description: information about performed operation returned: always sample: vSwitch 'vSwitch_1002' is created successfully type: str