W3cubDocs

/Ansible

vmware_dvs_portgroup - Create or remove a Distributed vSwitch portgroup

New in version 2.0.

Synopsis

Create or remove a Distributed vSwitch portgroup

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.
num_ports
 yes
The number of ports the portgroup should contain
password
 yes
The password of the vSphere vCenter.
aliases: pass, pwd
portgroup_name
 yes
The name of the portgroup that is to be created or deleted
portgroup_type
 yes
  • earlyBinding
  • lateBinding
  • ephemeral
See VMware KB 1022312 regarding portgroup types
switch_name
 yes
The name of the distributed vSwitch the port group should be created on.
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.
vlan_id
 yes
The VLAN ID that should be configured with the portgroup

Examples

- name: Create Management portgroup
   local_action:
     module: vmware_dvs_portgroup
     hostname: vcenter_ip_or_hostname
     username: vcenter_username
     password: vcenter_password
     portgroup_name: Management
     switch_name: dvSwitch
     vlan_id: 123
     num_ports: 120
     portgroup_type: earlyBinding
     state: present

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_dvs_portgroup_module.html