Nexfs Management API Documentation

Method Index

GetISCSIConf

Retrieving the iSCSI configuration Nexfs Management API

Action: GetISCSICOnf

Get the current iSCSI configuration.


Permissions

To retrieve the nexfs iSCSI export configuration a requesting session must have the iscsi/GetISCSIConf role enabled.

Request Parameters

A request must be made against the nexfs management console api with the GetISCSIConf action.


The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.

Action

GetISCSIConf

Request Body

The request does not have a request body.

Response Syntax

HTTP1/1 200

{

"interfaces": [{

"interface": {

"address": "string"

}

}

,...

],

"itargets": [{

"itarget": {

"tid": integer,

"headerdigest": "string",

"datadigest": "string",

"luns": [{

"lun": integer,

"path": "string",

"sn": "string",

"mode": "string"

}

...,

]}

}

,...

],

"accounts": [{

"account": {

"username": "string",

"password": "string",

"mode": "string"

}

}

,...


],

"bindings": [{

"binding": {

"tid": integer,

"bindto": [{

"address": "string,

"mode": "string"

}

,...

],

"accounts": [{

"username": "string",

"mode": "string"

}]

}

,...

]

}


Response Elements

If the action is successful, the service sends back an HTTP 200 response.

See the Service Configuration section of Integrated iSCSI for a description of response elements and values.

Errors

Also See Rest Error Responses


401 Unauthorized The request cannot be authenticated


403 Forbidden Session does not have the rights to perform the requested action


500 InternalServerError An Internal Error was encountered

Example Request


GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetISCSIConf

Authorization: AWS4-HMAC-SHA256 Credential=7b48741f04fc49bc8f0133bbe4e9232f/20220905/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=7983899fd9670243266fb3dc3b5949a97de5f26499f82d07c6292186098bc000

content-type: application/x-www-form-urlencoded; charset=utf-8

host: nexfs.example.com

x-amz-date: 20220823T165710Z

Example Response

{

"interfaces": [{

"interface": {

"address": "192.168.128.3:3260"

}

},{

"interface": {

"address": "127.0.0.1:3260"

}

}],

"itargets": [{

"itarget": {

"tid": 1,

"headerdigest": "off",

"datadigest": "off",

"luns": [{

"lun": 1,

"path": "/10TBLun",

"sn": "8041b20e12ef11edaacab35455cc69a9",

"mode": "online"

}, {

"lun": 2,

"path": "/images/500TGBLun",

"sn": "ad3cd86e12f011edaacab35455cc69a9",

"mode": "offline"

}]

}

}, {

"itarget": {

"tid": 2,

"headerdigest": "on",

"datadigest": "on",

"luns": [{

"lun": 1,

"path": "/images/800TBLun",

"sn": "8b964756139311edaacab35455cc69a9",

"mode": "online"

}]

}

},],

"accounts": [{

"account": {

"username": "nexus1",

"password": "9ahfde25HHJ",

"mode": "add"

}

}, {

"account": {

"username": "nexus22",

"password": "10Plsh7Utws",

"mode": "add"

}

}],

"bindings": [{

"binding": {

"tid": 1,

"bindto": [{

"address": "127.0.0.1:3260",

"mode": "add"

}],

"accounts": [{

"username": "nexus1",

"mode": "add"

}]

}

}, {

"binding": {

"tid": 2,

"bindto": [],

"accounts": []

}

}]

}