Managed Object - HostNetworkSystem

Property of
HostConfigManager
See also
HostDnsConfig, HostIpRouteConfig, HostNetCapabilities, HostNetOffloadCapabilities, HostNetworkConfig, HostNetworkConfigResult, HostNetworkInfo, HostPortGroupSpec, HostVirtualNicSpec, HostVirtualSwitchSpec, PhysicalNicHintInfo, PhysicalNicLinkInfo

Managed Object Description

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

Properties

Name Type Description
capabilities*HostNetCapabilities Capability vector indicating the available product features.
consoleIpRouteConfig*HostIpRouteConfig IP route configuration for the service console. The IP route configuration is global to the entire host. This property is set only if IP routing can be configured for the service console.
dnsConfig*HostDnsConfig Client-side DNS configuration for the host. The DNS configuration is global to the entire host. This is set only if DNS can be configured for the host.
ipRouteConfig*HostIpRouteConfig The IP route configuration for the host. The IP route configuration is global to the entire host. This property is set only if IP routing can be configured for the host.
networkConfig*HostNetworkConfig Network configuration information. This information can be applied using the updateNetworkConfig() method. The information is a strict subset of the information available in NetworkInfo.
See HostNetworkInfo
networkInfo*HostNetworkInfo The network configuration and runtime information.
offloadCapabilities*HostNetOffloadCapabilities The offload capabilities available on this server.
*May not be present

Methods

Methods defined in this Managed Object
AddPortGroup, AddServiceConsoleVirtualNic, AddVirtualNic, AddVirtualSwitch, QueryNetworkHint, RefreshNetworkSystem, RemovePortGroup, RemoveServiceConsoleVirtualNic, RemoveVirtualNic, RemoveVirtualSwitch, RestartServiceConsoleVirtualNic, UpdateConsoleIpRouteConfig, UpdateDnsConfig, UpdateIpRouteConfig, UpdateNetworkConfig, UpdatePhysicalNicLinkSpeed, UpdatePortGroup, UpdateServiceConsoleVirtualNic, UpdateVirtualNic, UpdateVirtualSwitch

AddPortGroup

Adds a port group to the virtual switch.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
portgrpHostPortGroupSpec

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsThrown if the port group already exists.
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the PortGroup vlanId is invalid. Valid vlanIds range from [0,4095], where 0 means no vlan tagging. Exception is also thrown if network policy is invalid.
NotFoundThrown if the virtual switch does not exist.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See usesServiceConsoleNic

Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
portgroupxsd:string
See usesServiceConsoleNic
nicHostVirtualNicSpec
See usesServiceConsoleNic

Return Value

Type Description
xsd:string

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See usesServiceConsoleNic
InvalidArgumentThrown if the IP address or subnet mask in the IP configuration are invalid or the named PortGroup does not exist.
See usesServiceConsoleNic
NotSupportedThrown if the host is not an ESX Server system.
See usesServiceConsoleNic
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.

Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
portgroupxsd:string
nicHostVirtualNicSpec

Return Value

Type Description
xsd:string

Faults

Type Description
AlreadyExistsThrown if the portgroup already has a virtual network adapter.
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the IP address or subnet mask in the IP configuration are invalid. In the case of an ESX Server system, DHCP is not supported and this exception will be thrown if DHCP is specified. Exception may also be thrown if the named PortGroup does not exist.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See UpdateVirtualSwitch
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
vswitchNamexsd:string
See UpdateVirtualSwitch
spec*HostVirtualSwitchSpec
See UpdateVirtualSwitch
*Need not be set

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsThrown if the virtual switch already exists.
See UpdateVirtualSwitch
HostConfigFaultThrown for all other configuration failures.
See UpdateVirtualSwitch
InvalidArgumentThrown if network vswitchName exceeds the maximum allowed length, or the number of ports specified falls out of valid range, or the network policy is invalid, or beacon configuration is invalid.
See UpdateVirtualSwitch
ResourceInUseThrown if the physical network adapter being bridged is already in use.
See UpdateVirtualSwitch
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See supportsNetworkHints
See device
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
device*xsd:string[]
See supportsNetworkHints
See device
*Need not be set

Return Value

Type Description
PhysicalNicHintInfo[]

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See supportsNetworkHints
See device
InvalidArgumentThrown if the speed and duplexity combination is not valid for the current link driver.
See supportsNetworkHints
See device
NotFoundThrown if a specified physical network adapter does not exist.
See supportsNetworkHints
See device
NotSupportedThrown if the host is not an ESX Server system.
See supportsNetworkHints
See device
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RefreshNetworkSystem

Refresh the network information and settings to pick up any changes that might have occurred.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemovePortGroup

Removes port group from the virtual switch.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
pgNamexsd:string

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the port group or virtual switch does not exist.
ResourceInUseThrown if the port group can not be removed because there are virtual network adapters associated with it.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveServiceConsoleVirtualNic

Removes a virtual service console network adapter.
See usesServiceConsoleNic
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
devicexsd:string
See usesServiceConsoleNic

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See usesServiceConsoleNic
NotFoundThrown if the virtual network adapter cannot be found.
See usesServiceConsoleNic
NotSupportedThrown if the host is not an ESX Server system.
See usesServiceConsoleNic
ResourceInUseThrown if the network adapter is currently used by DHCP DNS.
See usesServiceConsoleNic
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveVirtualNic

Removes a virtual host/VMkernel network adapter.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
devicexsd:string

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the virtual network adapter cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveVirtualSwitch

Removes an existing virtual switch from the system.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
vswitchNamexsd:string

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the virtual switch does not exist.
ResourceInUseThrown if there are virtual network adapters associated with the virtual switch.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See usesServiceConsoleNic
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
devicexsd:string
See usesServiceConsoleNic

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See usesServiceConsoleNic
NotFoundThrown if the virtual network adapter cannot be found.
See usesServiceConsoleNic
NotSupportedThrown if the host is not an ESX Server system.
See usesServiceConsoleNic
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateConsoleIpRouteConfig

Applies the IP route configuration for the service console.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
configHostIpRouteConfig

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if any of the IP addresses are invalid.
NotSupportedThrown if the host is not an ESX Server system.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateDnsConfig

Applies the client-side DNS configuration for the host.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
configHostDnsConfig

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if any of the IP addresses are invalid, or for a DHCP DNS, if the DHCP virtual network adapter is not specified or the virtual network adapter specified is not DHCP enabled.
NotFoundwhen the DHCP virtual network adapter specified does not exist.
NotSupportedThrown if the host is not an ESX Server system.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateIpRouteConfig

Applies the IP route configuration for the host.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
configHostIpRouteConfig

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if any of the IP addresses are invalid.
NotSupportedThrown if the host is not an ESX Server system.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See HostConfigChangeMode

Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
configHostNetworkConfig
See HostConfigChangeMode
changeModexsd:string
See HostConfigChangeMode

Return Value

Type Description
HostNetworkConfigResult

Faults

Type Description
AlreadyExistswhen a network entity specified in the configuration already exists.
See HostConfigChangeMode
HostConfigFaultThrown for all other configuration failures.
See HostConfigChangeMode
InvalidArgumentThrown if an invalid parameter is passed in for one of the networking objects.
See HostConfigChangeMode
NotFoundwhen a network entity specified in the configuration already exists.
See HostConfigChangeMode
NotSupportedThrown if modify mode is not used, a remove or set operation is specified for an instance, or a singleton entity is configured.
See HostConfigChangeMode
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdatePhysicalNicLinkSpeed

Configures link speed and duplexity. If linkSpeed is not specified, physical network adapter will be set to autonegotiate.
See canSetPhysicalNicLinkSpeed
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
devicexsd:string
See canSetPhysicalNicLinkSpeed
linkSpeed*PhysicalNicLinkInfo
See canSetPhysicalNicLinkSpeed
*Need not be set

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See canSetPhysicalNicLinkSpeed
InvalidArgumentThrown if the speed and duplexity is not one of the valid configurations.
See canSetPhysicalNicLinkSpeed
NotFoundThrown if the physical network adapter does not exist.
See canSetPhysicalNicLinkSpeed
NotSupportedThrown if the host is not an ESX Server system.
See canSetPhysicalNicLinkSpeed
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdatePortGroup

Reconfigures a port group on the virtual switch.
Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
pgNamexsd:string
portgrpHostPortGroupSpec

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the PortGroup vlanId is invalid. Valid vlanIds range from [0,4095], where 0 means no vlan tagging. Exception is also thrown if network policy is invalid.
NotFoundThrown if the port group or virtual switch does not exist.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See usesServiceConsoleNic

Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
devicexsd:string
See usesServiceConsoleNic
nicHostVirtualNicSpec
See usesServiceConsoleNic

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See usesServiceConsoleNic
InvalidArgumentThrown if the IP address or subnet mask in the IP configuration are invalid or the named PortGroup does not exist.
See usesServiceConsoleNic
NotFoundThrown if the virtual network adapter cannot be found.
See usesServiceConsoleNic
NotSupportedThrown if the host is not an ESX Server system.
See usesServiceConsoleNic
ResourceInUseThrown if tries to turn of DHCP while the network adapter is currently used by DHCP DNS.
See usesServiceConsoleNic
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.

Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
devicexsd:string
nicHostVirtualNicSpec

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the IP address or subnet mask in the IP configuration are invalid. In the case of an ESX Server system, DHCP is not supported and this exception is thrown if DHCP is specified. Exception may also be thrown if the named PortGroup does not exist.
NotFoundThrown if the virtual network adapter cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
See HostNicOrderPolicy

Required Privileges
Host.Config.Network

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
vswitchNamexsd:string
See HostNicOrderPolicy
specHostVirtualSwitchSpec
See HostNicOrderPolicy

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See HostNicOrderPolicy
InvalidArgumentThrown if the bridge parameter is bad or the network policy is invalid or does not exist or the number of ports specified falls out of valid range, or the beacon configuration is invalid.
See HostNicOrderPolicy
NotFoundThrown if the virtual switch does not exist.
See HostNicOrderPolicy
NotSupportedThrown if network adapter teaming policy is set but is not supported.
See HostNicOrderPolicy
ResourceInUseThrown if the physical network adapter being bridged is already in use.
See HostNicOrderPolicy
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition