Managed Object - HostNetworkSystem

Property of
HostConfigManager
Extends
ExtensibleManagedObject
See also
HostDnsConfig, HostIpRouteConfig, HostIpRouteTableConfig, HostNetCapabilities, HostNetOffloadCapabilities, HostNetworkConfig, HostNetworkConfigResult, HostNetworkInfo, HostPortGroupSpec, HostVirtualNicSpec, HostVirtualSwitchSpec, PhysicalNicHintInfo, PhysicalNicLinkInfo
Since
null


Managed Object Description

Properties

Name Type Description
capabilities*HostNetCapabilities


consoleIpRouteConfig*HostIpRouteConfig


dnsConfig*HostDnsConfig


ipRouteConfig*HostIpRouteConfig


networkConfig*HostNetworkConfig


networkInfo*HostNetworkInfo


offloadCapabilities*HostNetOffloadCapabilities


Properties inherited from ExtensibleManagedObject
availableField, value
*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, UpdateIpRouteTableConfig, UpdateNetworkConfig, UpdatePhysicalNicLinkSpeed, UpdatePortGroup, UpdateServiceConsoleVirtualNic, UpdateVirtualNic, UpdateVirtualSwitch
Methods inherited from ExtensibleManagedObject
setCustomValue

AddPortGroup

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: portgrp

Return Value

Type Description
None

Faults

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

Events

Type
None



AddServiceConsoleVirtualNic

Required Privileges
None

Parameters

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

Since null
nic PHostVirtualNicSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

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

Events

Type
None



AddVirtualNic

Required Privileges
None

Parameters

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

Since null
nic PHostVirtualNicSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

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

Events

Type
None



AddVirtualSwitch

Required Privileges
Host.Config.Network

Parameters

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

Since null
spec* PHostVirtualSwitchSpec

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None



QueryNetworkHint

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostNetworkSystem used to make the method call.
device* Pxsd:string[]

Since null
*Need not be set P Required privilege: device

Return Value

Type Description
PhysicalNicHintInfo[]

Faults

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

Events

Type
None



RefreshNetworkSystem

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.

Events

Type
None



RemovePortGroup

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: pgName

Return Value

Type Description
None

Faults

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

Events

Type
None



RemoveServiceConsoleVirtualNic

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: device

Return Value

Type Description
None

Faults

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

Events

Type
None



RemoveVirtualNic

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: device

Return Value

Type Description
None

Faults

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

Events

Type
None



RemoveVirtualSwitch

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: vswitchName

Return Value

Type Description
None

Faults

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

Events

Type
None



RestartServiceConsoleVirtualNic

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: device

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateConsoleIpRouteConfig

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: config

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateDnsConfig

Deprecated.

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: config

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateIpRouteConfig

Deprecated.

Required Privileges
Host.Config.Network

Parameters

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

Since null
P Required privilege: config

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateIpRouteTableConfig

Deprecated.

Required Privileges
Host.Config.Network
Since
vSphere API 4.0

Parameters

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

Since vSphere API 4.0
P Required privilege: config

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateNetworkConfig

Required Privileges
None

Parameters

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

Since null
changeMode Pxsd:string

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
HostNetworkConfigResult

Faults

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

Events

Type
None



UpdatePhysicalNicLinkSpeed

Required Privileges
Host.Config.Network

Parameters

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

Since null
linkSpeed* PPhysicalNicLinkInfo

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdatePortGroup

Required Privileges
Host.Config.Network

Parameters

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

Since null
portgrp PHostPortGroupSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateServiceConsoleVirtualNic

Required Privileges
None

Parameters

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

Since null
nic PHostVirtualNicSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateVirtualNic

Required Privileges
None

Parameters

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

Since null
nic PHostVirtualNicSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateVirtualSwitch

Required Privileges
Host.Config.Network

Parameters

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

Since null
spec PHostVirtualSwitchSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None