Read

GET v1/protocol_endpoints

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
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
num_connections	NsUnsignedLong
num_iscsi_connections	NsUnsignedLong
num_fc_connections	NsUnsignedLong

GET v1/protocol_endpoints/detail

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
fields	NsCommaSeparatedList
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
num_connections	NsUnsignedLong
num_iscsi_connections	NsUnsignedLong
num_fc_connections	NsUnsignedLong

GET v1/protocol_endpoints/id

Query parameters

Parameter	Type
fields	NsCommaSeparatedList

Description

Retrieve information on a set of protocol endpoints or a single protocol endpoint.

Normal Response Codes

200

HTTP Error Codes

400 401 404 500 503

Detail Error Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

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.

JSON Response