Scripting Object - VcNetwork

Scripting-object corresponding to
Network
Attribute of
VcCannotAccessNetwork, VcCannotUseNetwork, VcClusterComputeResource, VcClusterNetworkConfigSpec, VcComputeResource, VcDatacenter, VcDestinationSwitchFull, VcHostConfigSummary, VcHostEsxAgentHostManagerConfigInfo, VcHostSystem, VcIpPoolAssociation, VcLegacyNetworkInterfaceInUse, VcNetworkEventArgument, VcNetworkSummary, VcNoAvailableIp, VcNodeDeploymentSpec, VcOpaqueNetworkSummary, VcOvfNetworkMapping, VcPassiveNodeDeploymentSpec, VcVAppCloneSpecNetworkMappingPair, VcVirtualApp, VcVirtualEthernetCardNetworkBackingInfo, VcVirtualMachine, VcVMOnConflictDVPort, VcVMOnVirtualIntranet
Returned by
getAllNetworks, getAllNetworks

Scripting Object Description

Represents a network accessible by either hosts or virtual machines. This can be a physical network or a logical network, such as a VLAN.

Networks are created:

To configure network access for hosts and virtual machines, use {@link vim.DistributedVirtualSwitch} and {@link vim.dvs.DistributedVirtualPortgroup} managed objects.

Attributes

Name Type Description
accessibleBoolean

@since Unknown
alarmActionsEnabledBoolean

@since vSphere API 4.0
availableFieldVcCustomFieldDef []

@since VI API 2.5
configIssueVcEvent []

@since VI API 2.5
configStatusVcManagedEntityStatus

@since VI API 2.5
customValueVcCustomFieldValue []

@since VI API 2.5
declaredAlarmStateVcAlarmState []

@since VI API 2.5
disabledMethodString []

@since VI API 2.5
effectiveRoleNumber []

@since VI API 2.5
hostVcHostSystem []

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
nameString

@since VI API 2.5
overallStatusVcManagedEntityStatus

@since VI API 2.5
parentVcManagedEntity

@since VI API 2.5
permissionVcPermission []

@since VI API 2.5
recentTaskVcTask []

@since VI API 2.5
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
summaryVcNetworkSummary

@since VI API 2.5
tagVcTag []

@since vSphere API 4.0
triggeredAlarmStateVcAlarmState []

@since VI API 2.5
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown
vmVcVirtualMachine []

@since VI API 2.5

Methods

Methods defined in this Scripting Object
_getRef, addTag, createTrigger, destroy_Task, destroyNetwork, reload, removeTag, rename_Task, retrieveCustomValues, setCustomValue

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

removeTag

Removes a set of tags from this object. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcTag []


Return Value

Type Description
None

destroy_Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

NOTE: The appropriate privilege must be held on the parent of the destroyed entity as well as the entity itself.

This method can throw one of several exceptions. The exact set of exceptions depends on the kind of entity that is being removed. See comments for each entity for more information on destroy behavior. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

destroyNetwork

Removes a network. A network can be removed only if it is not used by any host or virtual machine. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

reload

Reload the entity state. Clients only need to call this method if they changed some external state that affects the service without using the Web service interface to perform the change. For example, hand-editing a virtual machine configuration file affects the configuration of the associated virtual machine but the service managing the virtual machine might not monitor the file for changes. In this case, after such an edit, a client would call "reload" on the associated virtual machine to ensure the service and its clients have current data for the virtual machine. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

retrieveCustomValues

Retrieve Custom field values based on specified custom field keys. If there is no key specified, all custom values associated to this ManagedEntity will be returned. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0Number []


Return Value

Type Description
VcCustomFieldValue []

addTag

Add a set of tags to this object that can be queried later. The tag must be of the form "system/" or "global/ Parameters

NameTypeDescription
arg0VcTag []


Return Value

Type Description
None

rename_Task

Renames this managed entity.

Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask