openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/host/PortGroup/Specification.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

1.2 KiB
Raw Blame History

vim.host.PortGroup.Specification

This data object type describes the PortGroup specification representing the properties on a PortGroup that can be configured.

extends

vmodl.DynamicData

Attributes:

name (str):

The name of the port group.

vlanId (int):

The VLAN ID for ports using this port group. Possible values:
  • A value of 0 specifies that you do not want the port group associated with a VLAN.
  • A value from 1 to 4094 specifies a VLAN ID for the port group.
  • A value of 4095 specifies that the port group should use trunk mode, which allows the guest operating system to manage its own VLAN tags.

vswitchName (str):

The identifier of the virtual switch on which this port group is located.

policy (vim.host.NetworkPolicy):

Policies on the port group take precedence over the ones specified on the virtual switch.