Managed Object - IscsiManager(vim.host.IscsiManager)

Property of: HostConfigManager
See also: IscsiMigrationDependency, IscsiPortInfo, IscsiStatus
Since: vSphere API 5.0

Managed Object Description

This managed object provides interfaces for mapping VMkernel NIC to iSCSI Host Bus Adapter.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
BindVnic, QueryBoundVnics, QueryCandidateNics, QueryMigrationDependencies, QueryPnicStatus, QueryVnicStatus, UnbindVnic

BindVnic(bindVnic)

Bind a Virtual NIC to be used for an iSCSI adapter

Required Privileges: Host.Config.Storage

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

iScsiHbaName P

xsd:string

iSCSI adapter name for which the Virtual NIC to be added.

Since vSphere API 5.0

vnicDevice P

xsd:string

Virtual NIC that is to be bound to the iSCSI HBA

Since vSphere API 5.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
IscsiFault	Thrown for any problem that is not handled with a more specific fault.
IscsiFaultInvalidVnic	The given Virtual NIC is not valid for the HBA.
IscsiFaultVnicAlreadyBound	The given Virtual NIC is already bound to the HBA.
IscsiFaultVnicHasMultipleUplinks	The given Virtual NIC has multiple uplinks.
IscsiFaultVnicHasNoUplinks	The given Virtual NIC has no physical uplinks.
IscsiFaultVnicHasWrongUplink	The given Virtual NIC has the wrong uplink and it can't be used for iSCSI multi-pathing.
IscsiFaultVnicNotFound	The given Virtual NIC is not present on the system.
NotFound	Thrown if the given HBA is not found
PlatformConfigFault	Thrown for platform error that occurs during the operation.
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="BindVnic" type="vim25:BindVnicRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="BindVnicResponse">
                  <complexType/>
               </element>

QueryBoundVnics(queryBoundVnics)

Query the list of Virtual NICs that are bound to a given iSCSI HBA.

Required Privileges: Host.Config.Storage

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

iScsiHbaName P

xsd:string

iSCSI adapter name for which the method to be applied.

Since vSphere API 5.0

P Required privilege: iScsiHbaName

Return Value

Type	Description
IscsiPortInfo[]	An array of IscsiPortInfo containing detailed information on the list of Virtual NICs bound to the adapter

Faults

Type	Description
IscsiFault	Thrown for any problem that is not handled with a more specific fault.
NotFound	Thrown if the given HBA is not found
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="QueryBoundVnics" type="vim25:QueryBoundVnicsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryBoundVnicsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:IscsiPortInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryCandidateNics(queryCandidateNics)

Query the candidate Virtual NICs and Physical NICs that can be used for Port-Binding. For dependent offload adapters, the Virtual NIC should be attached to the physical NIC associated with the hardware function.

Required Privileges: Host.Config.Storage

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

iScsiHbaName P

xsd:string

iSCSI Adapter name for which the method to be applied.

Since vSphere API 5.0

P Required privilege: iScsiHbaName

Return Value

Type	Description
IscsiPortInfo[]	Array of IscsiPortInfo containing detailed information on list of eligible Virtual NICs that can be bound to the adapter. This list will also include details on the eligible Physical NICs that are not associated with any Virtual NICs.

Faults

Type	Description
IscsiFault	Thrown for any problem that is not handled with a more specific fault.
NotFound	Thrown if the given HBA is not found
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="QueryCandidateNics" type="vim25:QueryCandidateNicsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryCandidateNicsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:IscsiPortInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryMigrationDependencies(queryMigrationDependencies)

Query the dependency table for a migration operation of a given Physical NIC.

Required Privileges: Host.Config.Storage

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

pnicDevice P

xsd:string[]

List of Physical NICs to be migrated

Since vSphere API 5.0

P Required privilege: pnicDevice

Return Value

Type	Description
IscsiMigrationDependency	Dependency table, as described in IscsiMigrationDependency, providing the user of all the Virtual NIC and iSCSI resources affected.

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryMigrationDependencies" type="vim25:QueryMigrationDependenciesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryMigrationDependenciesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:IscsiMigrationDependency"/>
                     </sequence>
                  </complexType>
               </element>

QueryPnicStatus(queryPnicStatus)

Query if Physical NIC device is used for iSCSI.

Required Privileges: Host.Config.Storage

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

pnicDevice P

xsd:string

Physical NIC device name to check the status for

Since vSphere API 5.0

P Required privilege: pnicDevice

Return Value

Type	Description
IscsiStatus	A status object, IscsiStatus, indicating whether Physical NIC is used by iSCSI or not. Empty IscsiStatus (i.e reason unset) if Physical NIC device is not used. Fault code IscsiFaultPnicInUse if Physical NIC is being used.

Faults

Type	Description
IscsiFault	Thrown for any problem that is not handled with a more specific fault.
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="QueryPnicStatus" type="vim25:QueryPnicStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryPnicStatusResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:IscsiStatus"/>
                     </sequence>
                  </complexType>
               </element>

QueryVnicStatus(queryVnicStatus)

Query the status of Virtual NIC association with the iSCSI.

Required Privileges: Host.Config.Storage

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

vnicDevice P

xsd:string

Virtual NIC device to check the status for

Since vSphere API 5.0

P Required privilege: vnicDevice

Return Value

Type	Description
IscsiStatus	A status object IscsiStatus, containing list of the fault codes, providing the user with information as to whether Virtual NIC is used by iSCSI and list of compliance check failure codes if any. The returned IscsiStatus object will have an array of MethodFault objects providing following information: Empty IscsiStatus (i.e reason unset) if Virtual NIC device is not used. Fault code IscsiFaultVnicInUse if Virtual NIC is being used by iSCSI. This will be followed with list of fault codes corresponding to the compliance check failures.

Type

Description

IscsiStatus

A status object IscsiStatus, containing list of the fault codes, providing the user with information as to whether Virtual NIC is used by iSCSI and list of compliance check failure codes if any. The returned IscsiStatus object will have an array of MethodFault objects providing following information:

Empty IscsiStatus (i.e reason unset) if Virtual NIC device is not used.
Fault code IscsiFaultVnicInUse if Virtual NIC is being used by iSCSI.
This will be followed with list of fault codes corresponding to the compliance check failures.

Faults

Type	Description
IscsiFault	Thrown for any problem that is not handled with a more specific fault.
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="QueryVnicStatus" type="vim25:QueryVnicStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryVnicStatusResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:IscsiStatus"/>
                     </sequence>
                  </complexType>
               </element>

UnbindVnic(unbindVnic)

Unbind Virtual NIC binding from an iSCSI adapter.

Required Privileges: Host.Config.Storage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the IscsiManager used to make the method call.
iScsiHbaName P	xsd:string	iSCSI adapter name for which the Virtual NIC to be removed. *Since* vSphere API 5.0
vnicDevice P	xsd:string	Virtual NIC that is to be removed from the iSCSI HBA *Since* vSphere API 5.0
force P	xsd:boolean	*Since* vSphere API 5.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
IscsiFault	Thrown for any problem that is not handled with a more specific fault.
IscsiFaultVnicHasActivePaths	The given Virtual NIC is associated with "active" paths to the storage.
IscsiFaultVnicIsLastPath	The given Virtual NIC is associated with "only" paths to the storage.
IscsiFaultVnicNotBound	The given Virtual NIC is not bound to the adapter
NotFound	Thrown if the given HBA is not found
PlatformConfigFault	Thrown for platform error that occurs during the operation.
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="UnbindVnic" type="vim25:UnbindVnicRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnbindVnicResponse">
                  <complexType/>
               </element>