Read
GET v1/protocol_endpoints
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsVolSnapName |
| description | NsDescription |
| pool_name | NsObjectName |
| pool_id | NsObjectID |
| state | NsPEOpStateType |
| serial_number | NsISCSISerialNumber |
| target_name | NsTargetName |
| group_specific_ids | NsBoolean |
| creation_time | NsTime |
| last_modified | NsTime |
GET v1/protocol_endpoints/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsVolSnapName |
| description | NsDescription |
| pool_name | NsObjectName |
| pool_id | NsObjectID |
| state | NsPEOpStateType |
| serial_number | NsISCSISerialNumber |
| target_name | NsTargetName |
| group_specific_ids | NsBoolean |
| creation_time | NsTime |
| last_modified | NsTime |
Description
Retrieve information on a set of protocol endpoints or a single protocol endpoint.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the protocol endpoint. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsVolSnapName | string | Name of the protocol endpoint. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| description | NsDescription | string | Text description of the protocol endpoint. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| pool_name | NsObjectName | string | Name of the pool where the protocol endpoint resides. If pool option is not specified, protocol endpoint is assigned to the default pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| pool_id | NsObjectID | string | Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| state | NsPEOpStateType | string enum | Operational state of protocol endpoint. Possible values: 'normal', 'deprecated'. | |
| serial_number | NsISCSISerialNumber | string | Identifier associated with the protocol endpoint for the SCSI protocol. A 32 digit hexadecimal number. Example: '1234123412341234abcdacbdacbdacbd'. | |
| target_name | NsTargetName | string | The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target protocol endpoint. The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target. | |
| group_specific_ids | NsBoolean | boolean | External UID is used to compute the serial number and IQN which never change even if the running group changes (e.g. after group merge). Group-specific IDs determine whether external UID is used for computing serial number and IQN. Possible values: 'true', 'false'. | |
| creation_time | NsTime | number | Time when this protocol endpoint was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this protocol endpoint was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| num_connections | NsUnsignedLong | number | Number of connections via this protocol endpoint. Unsigned 64-bit integer. Example: 1234. | |
| num_iscsi_connections | NsUnsignedLong | number | Number of iSCSI connections via this protocol endpoint. Unsigned 64-bit integer. Example: 1234. | |
| num_fc_connections | NsUnsignedLong | number | Number of FC connections via this protocol endpoint. Unsigned 64-bit integer. Example: 1234. | |
| access_control_records | NsAccessControlRecords | Array of NsAccessControlRecord | List of access control records that apply to this protocol endpoint. List of access control records associated with a volume or snapshot or protocol endpoint. | |
| iscsi_sessions | NsISCSISessions | Array of NsISCSISession | List of iSCSI sessions connected to this protocol endpoint. List of iSCSI initiator sessions information. | |
| fc_sessions | NsFCSessions | Array of NsFCSession | List of FC sessions connected to this protocol endpoint. List of Fibre Channel initiator sessions information. | |
| access_protocol | NsAccessProtocol | string enum | Access protocol of the protocol endpoint. Only initiator groups with the same access protocol can access the protocol endpoint. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. Possible values: 'iscsi', 'fc'. |
JSON Response
{
"data" : {
"serial_number" : "1a59ecb69a6489296c9ce900d3040000",
"name" : "pe0.669389426798688",
"last_modified" : 1426216433,
"access_control_records" : null,
"description" : "Protocol Endpoint for VMware Virtual Volumes",
"creation_time" : 1426216433,
"id" : "2e00000000000004d3000000000000000000000001",
"target_name" : "iqn.2007-11.com.storage:group-g1-g00000000000004d3",
"num_connections": 0,
"num_fc_connections": 0,
"num_iscsi_connections": 0,
"fc_sessions": [],
"iscsi_sessions": [],
"group_specific_ids" : true
}
}