initiator
Suggest changes
PDFs
The initiator object contains information about an iSCSI or Fibre Channel initiator. An initiator object can contain IQN or WWPN identifiers. You can use the ListInitiators method to get a list of all initiators known on the system. You use initiator objects to configure SCSI initiator access to a set of volumes through volume access groups. An initiator can only be a member of one volume access group at a time. You can restrict initiator access to one or more VLANs by specifying one or more virtualNetworkIDs using the CreateInitiators and ModifyInitiators methods. If you don't specify any virtual networks, the initiator can access all networks.
Object members
This object contains the following members:
| Name | Description | Type |
|---|---|---|
alias |
The friendly name assigned to the initiator, if any. |
string |
attributes |
A set of JSON attributes assigned to this initiator. Empty if no attributes are assigned. |
JSON object |
chapUsername |
The unique CHAP username for this initiator. |
string |
initiatorID |
The numeric identifier for the initiator. |
integer |
initiatorName |
The initiator name, in IQN or WWPN format. |
string |
initiatorSecret |
The CHAP secret used to authenticate the initiator. |
string |
requireChap |
True if CHAP is required for this initiator. |
boolean |
targetSecret |
The CHAP secret used to authenticate the target (when using mutual CHAP authentication). |
string |
virtualNetworkIDs |
The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks. |
integer |
volumeAccessGroups |
A list of volume access group IDs that this initiator belongs to. |
integer array |