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

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
iScsiHbaName Pxsd:string

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

Since vSphere API 5.0
vnicDevice Pxsd: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
IscsiFaultThrown for any problem that is not handled with a more specific fault.
IscsiFaultInvalidVnicThe given Virtual NIC is not valid for the HBA.
IscsiFaultVnicAlreadyBoundThe given Virtual NIC is already bound to the HBA.
IscsiFaultVnicHasMultipleUplinksThe given Virtual NIC has multiple uplinks.
IscsiFaultVnicHasNoUplinksThe given Virtual NIC has no physical uplinks.
IscsiFaultVnicHasWrongUplinkThe given Virtual NIC has the wrong uplink and it can't be used for iSCSI multi-pathing.
IscsiFaultVnicNotFoundThe given Virtual NIC is not present on the system.
NotFoundThrown if the given HBA is not found
PlatformConfigFaultThrown for platform error that occurs during the operation.
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

Show WSDL type definition



QueryBoundVnics(queryBoundVnics)

Query the list of Virtual NICs that are bound to a given iSCSI HBA.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
iScsiHbaName Pxsd: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
IscsiFaultThrown for any problem that is not handled with a more specific fault.
NotFoundThrown if the given HBA is not found
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

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
iScsiHbaName Pxsd: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
IscsiFaultThrown for any problem that is not handled with a more specific fault.
NotFoundThrown if the given HBA is not found
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

Show WSDL type definition



QueryMigrationDependencies(queryMigrationDependencies)

Query the dependency table for a migration operation of a given Physical NIC.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
pnicDevice Pxsd:string[]

List of Physical NICs to be migrated

Since vSphere API 5.0
P Required privilege: pnicDevice

Return Value

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

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

Show WSDL type definition



QueryPnicStatus(queryPnicStatus)

Query if Physical NIC device is used for iSCSI.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
pnicDevice Pxsd:string

Physical NIC device name to check the status for

Since vSphere API 5.0
P Required privilege: pnicDevice

Return Value

Type Description
IscsiStatusA 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
IscsiFaultThrown for any problem that is not handled with a more specific fault.
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

Show WSDL type definition



QueryVnicStatus(queryVnicStatus)

Query the status of Virtual NIC association with the iSCSI.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
vnicDevice Pxsd:string

Virtual NIC device to check the status for

Since vSphere API 5.0
P Required privilege: vnicDevice

Return Value

Type Description
IscsiStatusA 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
IscsiFaultThrown for any problem that is not handled with a more specific fault.
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

Show WSDL type definition



UnbindVnic(unbindVnic)

Unbind Virtual NIC binding from an iSCSI adapter.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the IscsiManager used to make the method call.
iScsiHbaName Pxsd:string

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

Since vSphere API 5.0
vnicDevice Pxsd:string

Virtual NIC that is to be removed from the iSCSI HBA

Since vSphere API 5.0
force Pxsd:boolean

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
IscsiFaultThrown for any problem that is not handled with a more specific fault.
IscsiFaultVnicHasActivePathsThe given Virtual NIC is associated with "active" paths to the storage.
IscsiFaultVnicIsLastPathThe given Virtual NIC is associated with "only" paths to the storage.
IscsiFaultVnicNotBoundThe given Virtual NIC is not bound to the adapter
NotFoundThrown if the given HBA is not found
PlatformConfigFaultThrown for platform error that occurs during the operation.
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

Show WSDL type definition