Vsan Iscsi Target System APIs

Vsan Iscsi Target System APIs

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.

Operations
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Initiator Group
Adds iSCSI initiator group to one cluster. If the initiator group already exists, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Initiators To Group
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.
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Initiators To Target
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.
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi LUN
Adds iSCSI LUN to specified target. If the target cannot be found, a VsanFault exception is raised.
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Target
Adds iSCSI target to this cluster. The alias in VsanIscsiTargetSpec must be provided and unique.
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Target To Group
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.
POST
Vsan Iscsi Target System Vsan Vit Edit Iscsi LUN
Edits iSCSI LUN in specified target. All properties in <code>VsanIscsiLUNSpec</code> can be changed.
POST
Vsan Iscsi Target System Vsan Vit Edit Iscsi Target
Edits iSCSI target in this cluster. All properties in VsanIscsiTargetSpec can be changed.
POST
Vsan Iscsi Target System Vsan Vit Get Home Object
Gets the home object which stores the metadata for vSAN iSCSI target service.
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Initiator Group
Gets one iSCSI initiator group. If the initiator group doesn't exists, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Initiator Groups
Gets iSCSI initiator group list for one cluster. If the operation fails, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi LUN
Gets one iSCSI LUN for specified target. If the target or the LUN cannot be found, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi LU Ns
Gets iSCSI LUN list for specified target list. If some targets cannot be found, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Target
Gets one iSCSI target.
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Targets
Gets iSCSI target list for one cluster.
POST
Vsan Iscsi Target System Vsan Vit Query Iscsi Target Service Version
Queries iSCSI service version, if version file is not found, a NotFound exception is raised.
POST
Vsan Iscsi Target System Vsan Remediate Iscsi Luns Runtime Status
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".
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiator Group
Removes iSCSI initiator group from one cluster. If there are initiators in the group, the initiators will be removed at the same time.
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiators From Group
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.
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiators From Target
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.
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi LUN
Removes iSCSI LUN from this target. If the target or the LUN cannot be found, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Target
Removes iSCSI target from this cluster. If the target cannot be found, a VsanFault will be raised.
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Target From Group
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.