Files
deb-python-pyvmomi/docs/vim/DistributedVirtualSwitch/ConfigSpec.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

4.2 KiB

vim.DistributedVirtualSwitch.ConfigSpec

The DVSConfigSpec data object contains configuration data for a DistributedVirtualSwitch . Use the ReconfigureDvs_Task method to apply the configuration to the switch.

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

configVersion (str, optional):

The version string of the configuration that this spec is trying to change. This property is required in reconfiguring a switch and should be set to the same value as configVersion . This property is ignored during switch creation.

name (str, optional):

The name of the switch. Must be unique in the parent folder.

numStandalonePorts (int, optional):

The number of standalone ports in the switch. Standalone ports are ports that do not belong to any portgroup. If set to a number larger than number of existing standalone ports in the switch, new ports get created to meet the number. If set to a number smaller than the number of existing standalone ports, free ports (uplink ports excluded) are deleted to meet the number. If the set number cannot be met by deleting free standalone ports, a fault is raised.

maxPorts (int, optional):

The maximum number of DistributedVirtualPorts allowed in the switch. If specified in a reconfigure operation, this number cannot be smaller than the number of existing DistributedVirtualPorts.

uplinkPortPolicy (vim.DistributedVirtualSwitch.UplinkPortPolicy, optional):

The uplink port policy.

uplinkPortgroup (vim.dvs.DistributedVirtualPortgroup, optional):

The uplink portgroups.

defaultPortConfig (vim.dvs.DistributedVirtualPort.Setting, optional):

The default configuration for ports.

host (vim.dvs.HostMember.ConfigSpec, optional):

The host member specification. A particular host should have only one entry in this array. Duplicate entries for the same host will raise a fault. The host version should be compatible with the version of DistributedVirtualSwitch . Use QueryDvsCheckCompatibility to check for compatibility.

extensionKey (str, optional):

The key of the extension registered by a remote server that controls the switch.

description (str, optional):

Set the description string of the switch.

policy (vim.DistributedVirtualSwitch.SwitchPolicy, optional):

The usage policy of the switch.

vendorSpecificConfig (vim.dvs.KeyedOpaqueBlob, optional):

Set the opaque blob that stores vendor specific configuration.

contact (vim.DistributedVirtualSwitch.ContactInfo, optional):

Set the human operator contact information.

switchIpAddress (str, optional):

IP address for the switch, specified using IPv4 dot notation. The utility of this address is defined by other switch features.

defaultProxySwitchMaxNumPorts (int, optional):

The default host proxy switch maximum port number