Managed Object - IscsiManager

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


Managed Object Description

Properties

Name Type Description
None

Methods

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

BindVnic

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
vnicDevice Pxsd:string

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
IscsiFault
IscsiFaultInvalidVnic
IscsiFaultVnicAlreadyBound
IscsiFaultVnicHasMultipleUplinks
IscsiFaultVnicHasNoUplinks
IscsiFaultVnicHasWrongUplink
IscsiFaultVnicNotFound
NotFound
PlatformConfigFault
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



QueryBoundVnics

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
P Required privilege: iScsiHbaName

Return Value

Type Description
IscsiPortInfo[]

Faults

Type Description
IscsiFault
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



QueryCandidateNics

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
P Required privilege: iScsiHbaName

Return Value

Type Description
IscsiPortInfo[]

Faults

Type Description
IscsiFault
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



QueryMigrationDependencies

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
P Required privilege: pnicDevice

Return Value

Type Description
IscsiMigrationDependency

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



QueryPnicStatus

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
P Required privilege: pnicDevice

Return Value

Type Description
IscsiStatus

Faults

Type Description
IscsiFault
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



QueryVnicStatus

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
P Required privilege: vnicDevice

Return Value

Type Description
IscsiStatus

Faults

Type Description
IscsiFault
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



UnbindVnic

Required Privileges
Host.Config.Storage

Parameters

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

Since vSphere API 5.0
vnicDevice Pxsd:string

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
IscsiFault
IscsiFaultVnicHasActivePaths
IscsiFaultVnicIsLastPath
IscsiFaultVnicNotBound
NotFound
PlatformConfigFault
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