Managed Object - VsanIscsiTargetSystem(vim.cluster.VsanIscsiTargetSystem)

See also: ClusterComputeResource, Task, VsanIscsiInitiatorGroup, VsanIscsiLUN, VsanIscsiLUNSpec, VsanIscsiTarget, VsanIscsiTargetSpec, VsanObjectInformation
Since: vSphere API Release 6.5

Managed Object Description

The VsanIscsiTargetSystem exposes interfaces from vCenter to perform vSAN iSCSI target service related operations. To access these APIs from vCenter, user should possess correct privileges of the target cluster: cluster edit privilege is required for the adding, editing and removal of target, LUN, initiator and initiator group, while system read/view privilege is required for the view of these entities. The Managed Entity can be accessed through MOID of vsan-cluster-iscsi-target-system, through vSAN service at both vCenter server and ESXi host side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanRemediateIscsiLunsRuntimeStatus, VsanVitAddIscsiInitiatorGroup, VsanVitAddIscsiInitiatorsToGroup, VsanVitAddIscsiInitiatorsToTarget, VsanVitAddIscsiLUN, VsanVitAddIscsiTarget, VsanVitAddIscsiTargetToGroup, VsanVitEditIscsiLUN, VsanVitEditIscsiTarget, VsanVitGetHomeObject, VsanVitGetIscsiInitiatorGroup, VsanVitGetIscsiInitiatorGroups, VsanVitGetIscsiLUN, VsanVitGetIscsiLUNs, VsanVitGetIscsiTarget, VsanVitGetIscsiTargets, VsanVitQueryIscsiTargetServiceVersion, VsanVitRemoveIscsiInitiatorGroup, VsanVitRemoveIscsiInitiatorsFromGroup, VsanVitRemoveIscsiInitiatorsFromTarget, VsanVitRemoveIscsiLUN, VsanVitRemoveIscsiTarget, VsanVitRemoveIscsiTargetFromGroup

Methods defined in this Managed Object

VsanRemediateIscsiLunsRuntimeStatus, VsanVitAddIscsiInitiatorGroup, VsanVitAddIscsiInitiatorsToGroup, VsanVitAddIscsiInitiatorsToTarget, VsanVitAddIscsiLUN, VsanVitAddIscsiTarget, VsanVitAddIscsiTargetToGroup, VsanVitEditIscsiLUN, VsanVitEditIscsiTarget, VsanVitGetHomeObject, VsanVitGetIscsiInitiatorGroup, VsanVitGetIscsiInitiatorGroups, VsanVitGetIscsiLUN, VsanVitGetIscsiLUNs, VsanVitGetIscsiTarget, VsanVitGetIscsiTargets, VsanVitQueryIscsiTargetServiceVersion, VsanVitRemoveIscsiInitiatorGroup, VsanVitRemoveIscsiInitiatorsFromGroup, VsanVitRemoveIscsiInitiatorsFromTarget, VsanVitRemoveIscsiLUN, VsanVitRemoveIscsiTarget, VsanVitRemoveIscsiTargetFromGroup

VsanRemediateIscsiLunsRuntimeStatus(remediateIscsiLunsRuntimeStatus)

Remediates the iSCSI LUNs which runtime status are not consistent with configuration.
The remediation result will be returned after the task is finished.
Only if the remediation succeed for all LUNs, the task state will be "success". If the remediation fails with no exception raised, the task state will be "failure". If hit internal vSAN error, the task state will be "error" with error message in the fault field. Unhealthy status of the vSAN iSCSI service can lead to this vim.fault.VsanFault exception, e.g., the unavailability of the home object. Multiple entry of this function at the same time is not allowed.

Required Privileges: None
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSAN API 8.0.0.2

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanRemediateIscsiLunsRuntimeStatus" type="vsan:VsanRemediateIscsiLunsRuntimeStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanRemediateIscsiLunsRuntimeStatusResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitAddIscsiInitiatorGroup(addIscsiInitiatorGroup)

Adds iSCSI initiator group to one cluster.
If the initiator group already exists, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

initiatorGroupName

xsd:string

Since vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiInitiatorGroup" type="vsan:VsanVitAddIscsiInitiatorGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiInitiatorGroupResponse">
                  <complexType/>
               </element>

VsanVitAddIscsiInitiatorsToGroup(addIscsiInitiatorsToGroup)

Adds iSCSI initiators to one initiator group.
If the initiator group doesn't exist, or some of the initiators are already in the specified initiator group, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
initiatorGroupName	xsd:string	*Since* vSphere API Release 6.5
initiatorNames	xsd:string[]	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiInitiatorsToGroup" type="vsan:VsanVitAddIscsiInitiatorsToGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiInitiatorsToGroupResponse">
                  <complexType/>
               </element>

VsanVitAddIscsiInitiatorsToTarget(addIscsiInitiatorsToTarget)

Adds iSCSI initiators or initiator groups to one target.

If the target cannot be found or if there are initiators or initiator groups in the initiatorNames parameter are already associated with the specified target, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5
initiatorNames	xsd:string[]	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiInitiatorsToTarget" type="vsan:VsanVitAddIscsiInitiatorsToTargetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiInitiatorsToTargetResponse">
                  <complexType/>
               </element>

VsanVitAddIscsiLUN(addIscsiLUN)

Adds iSCSI LUN to specified target.
If the target cannot be found, a VsanFault exception is raised. If the LUN id is provided, it should be in range [0, 255] and be unique in the specified target. The LUN size should be provided, its minimum size is 1MB, the maximum size is 62TB. If either of them is not met, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5
lunSpec	VsanIscsiLUNSpec	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	The related task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiLUN" type="vsan:VsanVitAddIscsiLUNRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiLUNResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitAddIscsiTarget(addIscsiTarget)

Adds iSCSI target to this cluster.
The alias in VsanIscsiTargetSpec must be provided and unique. If iqn provided, it should be unique, if either of them is not met, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

targetSpec

VsanIscsiTargetSpec

Since vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	The related task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiTarget" type="vsan:VsanVitAddIscsiTargetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiTargetResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitAddIscsiTargetToGroup(addIscsiTargetToGroup)

Adds the iSCSI target to the specified initiator group.
If the initiator group is not found or the target is already in the accessible targets of the group, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
initiatorGroupName	xsd:string	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiTargetToGroup" type="vsan:VsanVitAddIscsiTargetToGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitAddIscsiTargetToGroupResponse">
                  <complexType/>
               </element>

VsanVitEditIscsiLUN(editIscsiLUN)

Edits iSCSI LUN in specified target.
All properties in VsanIscsiLUNSpec can be changed. If new LUN id is provided, it should be in range [0, 255] and be unique in the specified target, if lunSize is provided, it should be greater than existing size, i.e., LUNs are only allowed to grow, if either of them are not met, a VsanFault exception will be raised. If storagePolicy is provided, it is set by calling SetVsanObjectPolicy in VsanObjectSystem. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5
lunSpec	VsanIscsiLUNSpec	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	The related task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitEditIscsiLUN" type="vsan:VsanVitEditIscsiLUNRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitEditIscsiLUNResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitEditIscsiTarget(editIscsiTarget)

Edits iSCSI target in this cluster.
All properties in VsanIscsiTargetSpec can be changed. If authType changed, all existing connections are not effected, but the new connection to this target need to use the new authentication type, if port or network interface changed, it has the same impact to connection as authType change. If IQN or alias provided, it should be unique.
If IQN or alias is not unique, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

targetSpec

VsanIscsiTargetSpec

Since vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	The related task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitEditIscsiTarget" type="vsan:VsanVitEditIscsiTargetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitEditIscsiTargetResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetHomeObject(getHomeObject)

Gets the home object which stores the metadata for vSAN iSCSI target service. If the home object is not found, a VsanFault will be raised.
Please don't rely on this function to decide whether need to create the home object or not, because the home object may be in creation process.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

P Required privilege: System.Read

Return Value

Type	Description
VsanObjectInformation	VsanObjectInformation for the home object.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetHomeObject" type="vsan:VsanVitGetHomeObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetHomeObjectResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanObjectInformation"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetIscsiInitiatorGroup(getIscsiInitiatorGroup)

Gets one iSCSI initiator group.
If the initiator group doesn't exists, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

initiatorGroupName

xsd:string

Since vSphere API Release 6.5

P Required privilege: System.Read

Return Value

Type	Description
VsanIscsiInitiatorGroup	iSCSI initiator group.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiInitiatorGroup" type="vsan:VsanVitGetIscsiInitiatorGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiInitiatorGroupResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIscsiInitiatorGroup" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetIscsiInitiatorGroups(getIscsiInitiatorGroups)

Gets iSCSI initiator group list for one cluster.
If the operation fails, a VsanFault will be raised.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

P Required privilege: System.Read

Return Value

Type	Description
VsanIscsiInitiatorGroup[]	iSCSI initiator group list.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiInitiatorGroups" type="vsan:VsanVitGetIscsiInitiatorGroupsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiInitiatorGroupsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIscsiInitiatorGroup" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetIscsiLUN(getIscsiLUN)

Gets one iSCSI LUN for specified target.
If the target or the LUN cannot be found, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5
lunId	xsd:int	*Since* vSphere API Release 6.5

P Required privilege: System.Read

Return Value

Type	Description
VsanIscsiLUN	iSCSI LUN.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiLUN" type="vsan:VsanVitGetIscsiLUNRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiLUNResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIscsiLUN" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetIscsiLUNs(getIscsiLUNs)

Gets iSCSI LUN list for specified target list.
If some targets cannot be found, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

targetAliases*

xsd:string[]

Since vSphere API Release 6.5

*Need not be set P Required privilege: System.Read

Return Value

Type	Description
VsanIscsiLUN[]	iSCSI LUN list, it may be empty.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiLUNs" type="vsan:VsanVitGetIscsiLUNsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiLUNsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIscsiLUN" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetIscsiTarget(getIscsiTarget)

Gets one iSCSI target.
If the target cannot be found, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

targetAlias

xsd:string

Since vSphere API Release 6.5

P Required privilege: System.Read

Return Value

Type	Description
VsanIscsiTarget	iSCSI target detail.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiTarget" type="vsan:VsanVitGetIscsiTargetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiTargetResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIscsiTarget" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitGetIscsiTargets(getIscsiTargets)

Gets iSCSI target list for one cluster.
If the operation fails, a VsanFault will be raised.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

P Required privilege: System.Read

Return Value

Type	Description
VsanIscsiTarget[]	iSCSI target list, it may be empty.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiTargets" type="vsan:VsanVitGetIscsiTargetsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitGetIscsiTargetsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIscsiTarget" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitQueryIscsiTargetServiceVersion(queryIscsiTargetServiceVersion)

Queries iSCSI service version, if version file is not found, a NotFound exception is raised. When it is invoked from an ESXi host on MO 'vsan-cluster-iscsi-target-system', it just returns the iSCSI version on this host.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.

Return Value

Type	Description
xsd:string

Faults

Type	Description
NotFound
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:vsan="urn:vsan" name="VsanVitQueryIscsiTargetServiceVersion" type="vsan:VsanVitQueryIscsiTargetServiceVersionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitQueryIscsiTargetServiceVersionResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitRemoveIscsiInitiatorGroup(removeIscsiInitiatorGroup)

Removes iSCSI initiator group from one cluster.
If there are initiators in the group, the initiators will be removed at the same time. If the initiator group doesn't exist, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

initiatorGroupName

xsd:string

Since vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiInitiatorGroup" type="vsan:VsanVitRemoveIscsiInitiatorGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiInitiatorGroupResponse">
                  <complexType/>
               </element>

VsanVitRemoveIscsiInitiatorsFromGroup(removeIscsiInitiatorsFromGroup)

Removes iSCSI initiators from one initiator group.
If the initiator group does not exist, or some of the initiators are not in the specified initiator group, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
initiatorGroupName	xsd:string	*Since* vSphere API Release 6.5
initiatorNames	xsd:string[]	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiInitiatorsFromGroup" type="vsan:VsanVitRemoveIscsiInitiatorsFromGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiInitiatorsFromGroupResponse">
                  <complexType/>
               </element>

VsanVitRemoveIscsiInitiatorsFromTarget(removeIscsiInitiatorsFromTarget)

Removes iSCSI initiator or initiator groups from one target.
If the specified target cannot be found or if the initiators or initiator groups specified by the initiatorNames cannot be associated with the specified target, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5
initiatorNames	xsd:string[]	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiInitiatorsFromTarget" type="vsan:VsanVitRemoveIscsiInitiatorsFromTargetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiInitiatorsFromTargetResponse">
                  <complexType/>
               </element>

VsanVitRemoveIscsiLUN(removeIscsiLUN)

Removes iSCSI LUN from this target.
If the target or the LUN cannot be found, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5
lunId	xsd:int	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	The related task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiLUN" type="vsan:VsanVitRemoveIscsiLUNRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiLUNResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitRemoveIscsiTarget(removeIscsiTarget)

Removes iSCSI target from this cluster.
If the target cannot be found, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSphere API Release 6.5

targetAlias

xsd:string

Since vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
ManagedObjectReference to a Task	The related task.

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiTarget" type="vsan:VsanVitRemoveIscsiTargetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiTargetResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanVitRemoveIscsiTargetFromGroup(removeIscsiTargetFromGroup)

Removes accessible iSCSI target from one initiator group.
If the initiator group is not found or the target is not in the accessible targets of the group, a VsanFault will be raised. Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIscsiTargetSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	*Since* vSphere API Release 6.5
initiatorGroupName	xsd:string	*Since* vSphere API Release 6.5
targetAlias	xsd:string	*Since* vSphere API Release 6.5

P Required privilege: Host.Inventory.EditCluster

Return Value

Type	Description
None

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.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiTargetFromGroup" type="vsan:VsanVitRemoveIscsiTargetFromGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVitRemoveIscsiTargetFromGroupResponse">
                  <complexType/>
               </element>