| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
BindVnic, QueryBoundVnics, QueryCandidateNics, QueryMigrationDependencies, QueryPnicStatus, QueryVnicStatus, UnbindVnic |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Return Value
Type | Description |
---|---|
IscsiStatus | A status object, IscsiStatus, indicating whether Physical NIC is used by iSCSI or not.
|
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 |
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 |
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:
|
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 |
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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |