You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

vmware_portgroup - Create a VMware portgroup¶

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

Create a VMware 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.
network_policy (added in 2.2)	no			Network policy specifies layer 2 security settings for a portgroup such as promiscuous mode, where guest adapter listens to all the packets, MAC address changes and forged transmits. Settings are promiscuous_mode, forged_transmits, mac_changes
password	yes			The password of the vSphere vCenter. aliases: pass, pwd
portgroup_name	yes			Portgroup name to add
switch_name	yes			vSwitch to modify
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			VLAN ID to assign to portgroup

Examples ¶

# Example from Ansible playbook

    - name: Add Management Network VM Portgroup
      local_action:
        module: vmware_portgroup
        hostname: esxi_hostname
        username: esxi_username
        password: esxi_password
        switch_name: vswitch_name
        portgroup_name: portgroup_name
        vlan_id: vlan_id

    - name: Add Portgroup with Promiscuous Mode Enabled
      local_action:
        module: vmware_portgroup
        hostname: esxi_hostname
        username: esxi_username
        password: esxi_password
        switch_name: vswitch_name
        portgroup_name: portgroup_name
        network_policy:
            promiscuous_mode: True

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.