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

Name

Type

Description

_this

ManagedObjectReference

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

portgrp P

HostPortGroupSpec

Since null

P Required privilege: portgrp

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

portgroup P

xsd:string

Since null

nic P

HostVirtualNicSpec

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
xsd:string

Faults

Type	Description
HostConfigFault
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

portgroup P

xsd:string

Since null

nic P

HostVirtualNicSpec

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
xsd:string

Faults

Type	Description
AlreadyExists
HostConfigFault
InvalidState
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

vswitchName P

xsd:string

Since null

spec* P

HostVirtualSwitchSpec

Since null

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

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists
HostConfigFault
ResourceInUse
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device* P

xsd:string[]

Since null

*Need not be set P Required privilege: device

Return Value

Type	Description
PhysicalNicHintInfo[]

Faults

Type	Description
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostNetworkSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

pgName P

xsd:string

Since null

P Required privilege: pgName

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
ResourceInUse
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device P

xsd:string

Since null

P Required privilege: device

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
ResourceInUse
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device P

xsd:string

Since null

P Required privilege: device

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

vswitchName P

xsd:string

Since null

P Required privilege: vswitchName

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
ResourceInUse
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device P

xsd:string

Since null

P Required privilege: device

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

config P

HostIpRouteConfig

Since null

P Required privilege: config

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

config P

HostDnsConfig

Since null

P Required privilege: config

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

config P

HostIpRouteConfig

Since null

P Required privilege: config

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
InvalidState
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

config P

HostIpRouteTableConfig

Since vSphere API 4.0

P Required privilege: config

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

config P

HostNetworkConfig

Since null

changeMode P

xsd:string

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
HostNetworkConfigResult

Faults

Type	Description
AlreadyExists
HostConfigFault
NotFound
ResourceInUse
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device P

xsd:string

Since null

linkSpeed* P

PhysicalNicLinkInfo

Since null

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

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

pgName P

xsd:string

Since null

portgrp P

HostPortGroupSpec

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists
HostConfigFault
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device P

xsd:string

Since null

nic P

HostVirtualNicSpec

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
NotFound
ResourceInUse
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

device P

xsd:string

Since null

nic P

HostVirtualNicSpec

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault
InvalidState
NotFound
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

vswitchName P

xsd:string

Since null

spec P

HostVirtualSwitchSpec

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

Events

Type
None