Scripting Object - VcHostNetworkSystem

Scripting-object corresponding to
HostNetworkSystem
Attribute of
VcHostConfigManager

Scripting Object Description

This managed object type describes networking host configuration and serves as the top level container for relevant networking data objects.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
capabilitiesVcHostNetCapabilities

@since VI API 2.5
consoleIpRouteConfigVcHostIpRouteConfig

@since VI API 2.5
dnsConfigVcHostDnsConfig

@since VI API 2.5
idString

@since Unknown
ipRouteConfigVcHostIpRouteConfig

@since VI API 2.5
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
networkConfigVcHostNetworkConfig

@since VI API 2.5
networkInfoVcHostNetworkInfo

@since VI API 2.5
offloadCapabilitiesVcHostNetOffloadCapabilities

@since VI API 2.5
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
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

Methods

Methods defined in this Scripting Object
_getRef, addPortGroup, addServiceConsoleVirtualNic, addVirtualNic, addVirtualSwitch, commitNetworkTransaction, createTrigger, invokeHostNetworkTransactionCall, performHostOpaqueNetworkDataOperation, queryNetworkHint, refreshNetworkSystem, removePortGroup, removeServiceConsoleVirtualNic, removeVirtualNic, removeVirtualSwitch, restartServiceConsoleVirtualNic, setCustomValue, updateConsoleIpRouteConfig, updateDnsConfig, updateIpRouteConfig, updateIpRouteTableConfig, updateNetworkConfig, updatePhysicalNicLinkSpeed, updatePortGroup, updateServiceConsoleVirtualNic, updateVirtualNic, updateVirtualSwitch

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

queryNetworkHint

Requests network hint information for a physical network adapter. A network hint is some information about the network to which the physical network adapter is attached. The method receives in a list of physical network adapter devices and returns an equal number of hints if some devices are provided. If the list of devices is empty, then the method accesses hints for all physical network adapters. @since VI API 2.5

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcPhysicalNicHintInfo []

updateServiceConsoleVirtualNic

Configures the IP configuration for a virtual service console network adapter.

IP configuration is required although it does not have to be enabled if the host is an ESX Server system. The dynamic privilege check will check that the users have Network.Assign privilege on the DVPortGroup or the DVS if the port resides on a DVPortGroup or is a stand-alone DVS port. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostVirtualNicSpec


Return Value

Type Description
None

addPortGroup

Adds a port group to the virtual switch. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostPortGroupSpec


Return Value

Type Description
None

updateVirtualSwitch

Updates the properties of the virtual switch.

If the bridge is NULL, the configuration will be unset.

If a network adapter is listed in the active or standby list, then changing the set of network adapters to which the physical network adapter is associated may have a side effect of changing the network adapter order policy. If a network adapter is removed from the bridge configuration, then the network adapter is removed from the network adapter teaming order.

The BondBridge configuration is the only valid bridge configuration for an ESX Server system. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostVirtualSwitchSpec


Return Value

Type Description
None

removeServiceConsoleVirtualNic

Removes a virtual service console network adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

removeVirtualSwitch

Removes an existing virtual switch from the system. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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

updateConsoleIpRouteConfig

Applies the IP route configuration for the service console. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostIpRouteConfig


Return Value

Type Description
None

updateVirtualNic

Configures virtual host/VMkernel network adapter.

IP configuration is required although it does not have to be enabled if the host is an ESX Server system. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostVirtualNicSpec


Return Value

Type Description
None

refreshNetworkSystem

Refresh the network information and settings to pick up any changes that might have occurred. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

commitNetworkTransaction

Commit transaction to confirm that the host is connected to vCenter server. It commits the configuration changes by API calls with transactionId in {@link #invokeHostTransactionCall}. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

updateNetworkConfig

Applies the network configuration. This method operates primarily in two modes: replace or modify mode.

replace
When called in replace mode, this method applies the fully specified networking configuration to the networking system.

Upon successful completion of the call, the state of networking will match the configuration specified in config. In general, objects are created or destroyed to match the elements in the array of configurations. The identifier field in each element in an array of configurations is used to match an existing network entity. The state of existing network entities is patched to match that of the configuration.

An exception to this approach applies to the array of PhysicalNic.Config objects. The cardinality of physical network adapters cannot be changed through this operation. Thus, the identifier of every element in the array must match an existing PhysicalNic. If there are fewer elements in the array than there are existing PhysicalNics, then no change is made on the unreferenced PhysicalNic objects.

If the call fails, the networking error is returned as an exception and the state of networking reverts to the state prior to the start of the call.

modify When called in modify mode, only changes that are specified are made. For singleton entities like DnsConfig, the state is changed only if the data object is set. For array elements, there is an Operation field that indicates if the element should be added, removed, or edited. In the case of editing or removal, the entity must exist or an exception is thrown. In the case of adding, a specification needs to be provided.

It returns device names of vmkernel and service console virtual network adapter added to the system.

Currently, the only mode that is implemented is incremental mode. Only add operations are supported for instances. Singleton configuration is not supported. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostNetworkConfig

arg1String


Return Value

Type Description
VcHostNetworkConfigResult

addVirtualSwitch

Adds a new virtual switch to the system with the given name. The name must be unique with respect to other virtual switches on the host and is limited to 32 characters. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostVirtualSwitchSpec


Return Value

Type Description
None

updateDnsConfig

Applies the client-side DNS configuration. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostDnsConfig


Return Value

Type Description
None

removePortGroup

Removes port group from the virtual switch. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

addVirtualNic

Adds a virtual host/VMkernel network adapter. Returns the device of the virtual network adapter.

IP configuration is required although it does not have to be enabled if the host is an ESX Server system. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostVirtualNicSpec


Return Value

Type Description
String

updateIpRouteTableConfig

Applies the IP route table configuration. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostIpRouteTableConfig


Return Value

Type Description
None

updatePhysicalNicLinkSpeed

Configures link speed and duplexity. If linkSpeed is not specified, physical network adapter will be set to autonegotiate. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcPhysicalNicLinkInfo


Return Value

Type Description
None

invokeHostNetworkTransactionCall

Invoke API call on host with a transaction ID. If the invoked API succeeded and the call returns without exception, {@link #commitTransaction} needs to be invoked immediately, otherwise the change by the API is rolled back after the specified time. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String

arg1Number

arg2String

arg3Object

arg4Object

arg5Object

arg6Object


Return Value

Type Description
Object

restartServiceConsoleVirtualNic

Restart the service console virtual network adapter interface. If the service console virtual network adapter uses DHCP, restarting the interface may result it with a different IP configuration, or even fail to be brought up depending on the host system network configuration. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

removeVirtualNic

Removes a virtual host/VMkernel network adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

addServiceConsoleVirtualNic

Adds a virtual service console network adapter. Returns the device of the VirtualNic.

IP configuration is required although it does not have to be enabled if the host is an ESX Server system. The dynamic privilege check will ensure that users have Host.Config.Network privilege on the host, and Network.Assign privilege on the connecting DVPortGroup, or DVS if connecting to a standalone DVPort. Network.Assign privilege is not required for operations on standard network or for operations performed directly on the host @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostVirtualNicSpec


Return Value

Type Description
String

performHostOpaqueNetworkDataOperation

An internal method for testing purpose only. Supported "operation" values are: "get", "set", "add", "remove", "edit". @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String

arg1VcHostOpaqueNetworkData []


Return Value

Type Description
VcHostOpaqueNetworkData []

updateIpRouteConfig

Applies the IP route configuration. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostIpRouteConfig


Return Value

Type Description
None

updatePortGroup

Reconfigures a port group on the virtual switch. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostPortGroupSpec


Return Value

Type Description
None