Managed Object - HostVirtualNicManager

Property of: HostConfigManager
Extends: ExtensibleManagedObject
See also: HostVirtualNicManagerInfo, VirtualNicManagerNetConfig
Since: vSphere API 4.0

Managed Object Description

The VirtualNicManager managed object describes the special Virtual NIC configuration of the host.

Properties

Name	Type	Description
info	HostVirtualNicManagerInfo	Network configuration.
Properties inherited from ExtensibleManagedObject
availableField, value

Methods

Methods defined in this Managed Object
DeselectVnicForNicType, QueryNetConfig, SelectVnicForNicType
Methods inherited from ExtensibleManagedObject
setCustomValue

DeselectVnicForNicType

Deselect the VirtualNic to be a special type.

Required Privileges: Host.Config.Network

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVirtualNicManager used to make the method call.
nicType	xsd:string	The type of VirtualNic that would be deselected
device	xsd:string	The device that uniquely identifies the VirtualNic.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for any other failure.
InvalidArgument	Thrown if nicType is invalid, device represents a nonexistent or invalid VirtualNic, or the VirtualNic is not selected
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DeselectVnicForNicType" type="vim25:DeselectVnicForNicTypeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DeselectVnicForNicTypeResponse">
            <complexType/>
         </element>

QueryNetConfig

Get the NetConfig for the specified nicType

Required Privileges: Host.Config.Network

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVirtualNicManager used to make the method call.
nicType	xsd:string	The NicType

Return Value

Type	Description
VirtualNicManagerNetConfig

Faults

Type	Description
HostConfigFault	Thrown for any other failure.
InvalidArgument	Thrown if nicType is invalid
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryNetConfig" type="vim25:QueryNetConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryNetConfigResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VirtualNicManagerNetConfig" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

SelectVnicForNicType

Select the NicType of the VirtualNic. Selecting a device automatically deselects the previous selection if NetConfig#multiSelectAllowed is false for the specified nicType. Else, the device is added to the list of selected nics.

Required Privileges: Host.Config.Network

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVirtualNicManager used to make the method call.
nicType	xsd:string	The type of VirtualNic that would be selected
device	xsd:string	The device that uniquely identifies the VirtualNic.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for any other failure.
InvalidArgument	Thrown if nicType is invalid, or device represents a nonexistent or invalid VirtualNic
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SelectVnicForNicType" type="vim25:SelectVnicForNicTypeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SelectVnicForNicTypeResponse">
            <complexType/>
         </element>