Scripting Object - VcHostDistributedVirtualSwitchManager

Scripting-object corresponding to
HostDistributedVirtualSwitchManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

Private interface to manage the Distributed Virtual Switch instances on a host.

Attributes

Name Type Description
distributedVirtualSwitchString []

@since vSphere API 4.0
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, hostDVSClonePort, hostDVSCreateDVS, hostDVSDeletePorts, hostDVSGetPortState, hostDVSReconfigure, hostDVSRemoveDVS, hostDVSSetDvpgList, hostDVSSetDVPortgroups, hostDVSSetDvportList, hostDVSSetDVS, hostDVSSetDVSList, hostDVSSetPorts, hostDVSUpdateDVPortgroups, hostDVSUpdatePorts, hostExecuteOpaqueCommand, loadDVPort, retrieveDVPort, retrieveDVPortgroup, retrieveDVPortgroupConfigSpec, retrieveDvsConfigSpec

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

hostDVSGetPortState

Retrieve the state of the port. This information is fetched by vpxd periodically and upon special port events. Note that only the {@link PortData#state} will be populated for each port. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String []

arg2String


Return Value

Type Description
VcHostDVSPortData []

hostDVSSetDVS

Idempotent version of create/reconfigureDistributedVirtualSwitch. If a Distributed Virtual Switch with the specified uuid does not exist on the host, this function creates the Distributed Virtual Switch. If the Distributed Virtual Switch already exists on the host, this function updates it. The spec data object is used in an overwrite semantics. They should be fully populated, not a delta with only the changed properties set. The deprecated {@link VmwareDVSSettingSpec#pvlanConfigSpec} property in spec data object is ignored. While updating, setting properties with the same value is a no-op. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostDVSCreateSpec []


Return Value

Type Description
None

hostDVSClonePort

Clone ports. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostDVSPortCloneSpec []


Return Value

Type Description
None

hostDVSCreateDVS

Create a Distributed Virtual Switch in the datacenter according to the specified ConfigSpec. Vpxd calls this method on hostd to create proxy-DVS instances on the host. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostDVSCreateSpec


Return Value

Type Description
None

loadDVPort

Load port from the given file. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String

arg2String


Return Value

Type Description
None

hostDVSSetDVPortgroups

Idempotent version of updateDVPortgroups function. The configSpec data object is used in an overwrite semantics. They should be fully populated, not a delta with only the changed properties set. The {@link DVPortgroupConfigSpec#operation} properties in the DVPortgroupConfigSpec data objects are ignored in this operation. While updating, setting properties with the same value is a no-op. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1VcHostDVPortgroupConfigSpec []


Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

hostDVSDeletePorts

Delete ports. Ports that are not found are ignored. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostDVSPortDeleteSpec []


Return Value

Type Description
None

retrieveDVPortgroup

Retrieve the list of portgroup keys on the given DVS. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
String []

hostDVSSetDvpgList

Setting the list of DistributedVirtualPortgroups that should be on the host. Those dvportgroups with a key not among the specified list will be removed. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1String []


Return Value

Type Description
None

hostDVSReconfigure

Reconfigure the switch. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostDVSConfigSpec


Return Value

Type Description
None

hostDVSRemoveDVS

Remove the specified DVS instance. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

hostDVSSetPorts

Idempotent version of updatePorts functions. Ports that are not present on the host will be created. Ports that are already present on the host will be updated. The port data objects is used in an overwrite semantics. They should be fully populated, not a delta with only the changed properties set. The {@link PortData#state} properties in the port data objects are ignored. While updating, setting properties with the same value is a no-op. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1VcHostDVSPortData []


Return Value

Type Description
None

retrieveDVPort

Retrieve the list of port keys on the given DVS. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
String []

retrieveDvsConfigSpec

Fetch the configSpec of the switch identified by the UUID. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcHostDVSConfigSpec

hostDVSSetDVSList

Setting the list of DistributedVirtualSwitches that should be on the host. Those switches with a UUID not among the specified list will be removed. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
None

hostDVSUpdatePorts

Add or Update the specified ports. Ports that are already present on the host will be updated with the new information. Ports that are not present on the host will be created. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostDVSPortData []


Return Value

Type Description
None

hostExecuteOpaqueCommand

Execute command on host side, and return result with Opaque Data as well. The command execution should be limited in very short time, since it may block other dvs/dvpg/dvport operations in its execution. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String

arg1VcDVSOpaqueCommandReqSpec


Return Value

Type Description
VcDVSOpaqueCommandResultInfo

hostDVSUpdateDVPortgroups

Update or add the DVPortgroups specified. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostDVPortgroupConfigSpec []


Return Value

Type Description
None

hostDVSSetDvportList

Setting the list of DistributedVirtualPorts that should be on the host. Those dvports with a key not among the specified list will be removed. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1String []


Return Value

Type Description
None

retrieveDVPortgroupConfigSpec

Fetch the configSpec of the specified DVPortgroups. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String []


Return Value

Type Description
VcHostDVPortgroupConfigSpec []