The Global Configuration resource represents the configuration settings for iSCSI.
Returns the iSCSI Global Configuration settings dictionary.
Example request:
GET /api/v1.0/services/iscsi/globalconfiguration/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_maxconnect": 8,
"iscsi_luc_authnetwork": "",
"iscsi_iotimeout": 30,
"iscsi_lucip": "127.0.0.1",
"iscsi_firstburst": 65536,
"iscsi_r2t": 32,
"iscsi_discoveryauthmethod": "None",
"iscsi_defaultt2w": 2,
"iscsi_maxrecdata": 262144,
"iscsi_basename": "iqn.2011-03.org.example.istgt",
"iscsi_defaultt2r": 60,
"iscsi_nopinint": 20,
"iscsi_discoveryauthgroup": null,
"iscsi_maxburst": 262144,
"iscsi_toggleluc": false,
"iscsi_lucport": 3261,
"iscsi_luc_authgroup": null,
"iscsi_maxsesh": 16,
"iscsi_luc_authmethod": "",
"iscsi_maxoutstandingr2t": 16,
"id": 1
}
Response Headers: | |
---|---|
|
|
Status Codes: |
|
Update Global Configuration.
Example request:
PUT /api/v1.0/services/iscsi/globalconfiguration/ HTTP/1.1
Content-Type: application/json
{
"iscsi_maxconnect": 16
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_maxconnect": 16,
"iscsi_luc_authnetwork": "",
"iscsi_iotimeout": 30,
"iscsi_lucip": "127.0.0.1",
"iscsi_firstburst": 65536,
"iscsi_r2t": 32,
"iscsi_discoveryauthmethod": "None",
"iscsi_defaultt2w": 2,
"iscsi_maxrecdata": 262144,
"iscsi_basename": "iqn.2011-03.org.example.istgt",
"iscsi_defaultt2r": 60,
"iscsi_nopinint": 20,
"iscsi_discoveryauthgroup": null,
"iscsi_maxburst": 262144,
"iscsi_toggleluc": false,
"iscsi_lucport": 3261,
"iscsi_luc_authgroup": null,
"iscsi_maxsesh": 16,
"iscsi_luc_authmethod": "",
"iscsi_maxoutstandingr2t": 16,
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
The Extent resource represents extents for the iSCSI targets.
Returns a list of all extents.
Example request:
GET /api/v1.0/services/iscsi/extent/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
"iscsi_target_extent_comment": "",
"iscsi_target_extent_type": "File",
"iscsi_target_extent_name": "extent",
"iscsi_target_extent_filesize": "10MB",
"id": 1,
"iscsi_target_extent_path": "/mnt/tank/iscsi"
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new extent and returns the new extent object.
Example request:
POST /api/v1.0/services/iscsi/extent/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_extent_type": "File",
"iscsi_target_extent_name": "extent",
"iscsi_target_extent_filesize": "10MB",
"iscsi_target_extent_path": "/mnt/tank/iscsi"
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"iscsi_target_extent_comment": "",
"iscsi_target_extent_type": "File",
"iscsi_target_extent_name": "extent",
"iscsi_target_extent_filesize": "10MB",
"id": 1,
"iscsi_target_extent_path": "/mnt/tank/iscsi"
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Update extent id.
Example request:
PUT /api/v1.0/services/iscsi/extent/1/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_extent_filesize": "20MB"
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_target_extent_comment": "",
"iscsi_target_extent_type": "File",
"iscsi_target_extent_name": "extent",
"iscsi_target_extent_filesize": "20MB",
"id": 1,
"iscsi_target_extent_path": "/mnt/tank/iscsi"
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Delete extent id.
Example request:
DELETE /api/v1.0/services/iscsi/extent/1/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes: |
|
---|
The Authorized Initiator resource represents network authorized to access to the iSCSI target.
Returns a list of all authorized initiators.
Example request:
GET /api/v1.0/services/iscsi/authorizedinitiator/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
"iscsi_target_initiator_initiators": "ALL",
"iscsi_target_initiator_comment": "",
"iscsi_target_initiator_auth_network": "ALL",
"id": 1,
"iscsi_target_initiator_tag": 1
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new authorized initiator and returns the new object.
Example request:
POST /api/v1.0/services/iscsi/authorizedinitiator/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_initiator_initiators": "ALL",
"iscsi_target_initiator_auth_network": "ALL",
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"iscsi_target_initiator_initiators": "ALL",
"iscsi_target_initiator_comment": "",
"iscsi_target_initiator_auth_network": "ALL",
"id": 1,
"iscsi_target_initiator_tag": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Update authorized initiator id.
Example request:
PUT /api/v1.0/services/iscsi/authorizedinitiator/1/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_initiator_auth_network": "192.168.3.0/24"
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_target_initiator_initiators": "ALL",
"iscsi_target_initiator_comment": "",
"iscsi_target_initiator_auth_network": "192.168.3.0/24",
"id": 1,
"iscsi_target_initiator_tag": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Delete authorized initiator id.
Example request:
DELETE /api/v1.0/services/iscsi/authorizedinitiator/1/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes: |
|
---|
The Auth Credential resource represents user credentials to access the iSCSI target.
Returns a list of all auth credentials.
Example request:
GET /api/v1.0/services/iscsi/authcredential/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
"iscsi_target_auth_secret": "secret",
"iscsi_target_auth_peeruser": "peeruser",
"iscsi_target_auth_peersecret": "peersecret",
"iscsi_target_auth_user": "user",
"iscsi_target_auth_tag": 1,
"id": 1
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new auth credential and returns the new object.
Example request:
POST /api/v1.0/services/iscsi/authcredential/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_auth_secret": "secret",
"iscsi_target_auth_peeruser": "peeruser",
"iscsi_target_auth_peersecret": "peersecret",
"iscsi_target_auth_user": "user",
"iscsi_target_auth_tag": 1
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"iscsi_target_auth_secret": "secret",
"iscsi_target_auth_peeruser": "peeruser",
"iscsi_target_auth_peersecret": "peersecret",
"iscsi_target_auth_user": "user",
"iscsi_target_auth_tag": 1,
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Update auth credential id.
Example request:
PUT /api/v1.0/services/iscsi/authcredential/1/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_auth_peeruser": "myuser"
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_target_auth_secret": "secret",
"iscsi_target_auth_peeruser": "myuser",
"iscsi_target_auth_peersecret": "peersecret",
"iscsi_target_auth_user": "user",
"iscsi_target_auth_tag": 1,
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Delete auth credential id.
Example request:
DELETE /api/v1.0/services/iscsi/authcredential/1/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes: |
|
---|
The Target resource represents user credentials to access the iSCSI target.
Returns a list of all targets.
Example request:
GET /api/v1.0/services/iscsi/target/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
"iscsi_target_logical_blocksize": 512,
"iscsi_target_portalgroup": 1,
"iscsi_target_initialdigest": "Auto",
"iscsi_target_queue_depth": 32,
"iscsi_target_name": "target",
"iscsi_target_initiatorgroup": 1,
"iscsi_target_alias": null,
"iscsi_target_type": "Disk",
"iscsi_target_authgroup": null,
"iscsi_target_authtype": "Auto",
"iscsi_target_serial": "10000001",
"iscsi_target_flags": "rw",
"id": 1
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new target and returns the new object.
Example request:
POST /api/v1.0/services/iscsi/target/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_name": "target",
"iscsi_target_portalgroup": 1,
"iscsi_target_initiatorgroup": 1
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"iscsi_target_logical_blocksize": 512,
"iscsi_target_portalgroup": 1,
"iscsi_target_initialdigest": "Auto",
"iscsi_target_queue_depth": 32,
"iscsi_target_name": "target",
"iscsi_target_initiatorgroup": 1,
"iscsi_target_alias": null,
"iscsi_target_type": "Disk",
"iscsi_target_authgroup": null,
"iscsi_target_authtype": "Auto",
"iscsi_target_serial": "10000001",
"iscsi_target_flags": "rw",
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Update target id.
Example request:
PUT /api/v1.0/services/iscsi/target/1/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_queue_depth": 64
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_target_logical_blocksize": 512,
"iscsi_target_portalgroup": 1,
"iscsi_target_initialdigest": "Auto",
"iscsi_target_queue_depth": 64,
"iscsi_target_name": "target",
"iscsi_target_initiatorgroup": 1,
"iscsi_target_alias": null,
"iscsi_target_type": "Disk",
"iscsi_target_authgroup": null,
"iscsi_target_authtype": "Auto",
"iscsi_target_serial": "10000001",
"iscsi_target_flags": "rw",
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Delete target id.
Example request:
DELETE /api/v1.0/services/iscsi/target/1/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes: |
|
---|
The Target To Extent resource represents association between targets and extents.
Returns a list of all target to extent.
Example request:
GET /api/v1.0/services/iscsi/targettoextent/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new target to extent and returns the new object.
Example request:
POST /api/v1.0/services/iscsi/targettoextent/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target": 1,
"iscsi_extent": 1
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"iscsi_target": 1,
"iscsi_extent": 1,
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Update target to extent id.
Example request:
PUT /api/v1.0/services/iscsi/targettoextent/1/ HTTP/1.1
Content-Type: application/json
{
"iscsi_extent": 2
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_target": 1,
"iscsi_extent": 2,
"id": 1
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Delete target to extent id.
Example request:
DELETE /api/v1.0/services/iscsi/targettoextent/1/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes: |
|
---|
The Portal resource represents IPs and ports which the daemon will listen to.
Returns a list of all portals.
Example request:
GET /api/v1.0/services/iscsi/portal/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
[
{
"iscsi_target_portal_tag": 1,
"id": 1,
"iscsi_target_portal_ips": [
"0.0.0.0:3260"
],
"iscsi_target_portal_comment": ""
}
]
Query Parameters: | |
---|---|
|
|
Response Headers: | |
|
|
Status Codes: |
|
Creates a new portal and returns the new object.
Example request:
POST /api/v1.0/services/iscsi/portal/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_portal_ips": [
"0.0.0.0:3260"
]
}
Example response:
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"iscsi_target_portal_tag": 1,
"id": 1,
"iscsi_target_portal_ips": [
"0.0.0.0:3260"
],
"iscsi_target_portal_comment": ""
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Update portal id.
Example request:
PUT /api/v1.0/services/iscsi/portal/1/ HTTP/1.1
Content-Type: application/json
{
"iscsi_target_portal_ips": [
"192.168.3.20:3260"
]
}
Example response:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"iscsi_target_portal_tag": 1,
"id": 1,
"iscsi_target_portal_ips": [
"192.168.3.20:3260"
],
"iscsi_target_portal_comment": ""
}
Json Parameters: | |
---|---|
|
|
Request Headers: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Delete portal id.
Example request:
DELETE /api/v1.0/services/iscsi/portal/1/ HTTP/1.1
Content-Type: application/json
Example response:
HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes: |
|
---|