Nexfs Management API Documentation

Method Index

PutISCSIConf

Update the iSCSI configuration through the Nexfs Management API


The request is made of four sections, interfaces, itargets, accounts and bindings.

Only changes that being made need to be sent, any sections that are not being changes can be left out off the request, and any section configurations that are not changing can also be left off the request - there is no requirement to resend the complete iSCSI configuration with each request.

Action: PutISCSIConf

Update the iSCSI configuration


Permissions

To update the nexfs iSCSI configuration a requesting session must have the iscsi/UpdateIsciConfiguration role enabled.


Request Parameters

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


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

Action

PutISCSIConf


RequestJson

A URI encoded json string containing a the new NFS export configuration

RequestJson Format

{

"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"

}]

}

,...

]

}

RequestJson Elements

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


Request Body

The request does not have a request body.

Response Syntax

HTTP1/1 200

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>string</Code>

<Message>string</Message>

<Resource>string</Resource>

<RequestId>integer</RequestId>

</RequestCompleted>


Response Elements

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


The following data is returned in XML format by the service:


RequestCompleted

Root Level tag for the successful response

Code

OK


Message

Request Completed


Resource

/nexfsconsoleapi

RequestId

A requestid number that identifies the request made against the management api


Errors

Also See Rest Error Responses


400 BadRequest The request was Malformed

A BadRequest will be returned if RequestJson is missing from the request

A BadRequest will also be returned if RequestJson is incorrectly formatted

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

The RequestJSON in the following example request is:

{

"itargets": [

{

"itarget": {

"tid": 1,

"headerdigest": "on",

"datadigest": "off",

"luns": [

{

"lun": 1,

"path": "/1GB",

"sn": "",

"mode": "online"

}

]

}

}

],

"bindings": [

{

"binding": {

"tid": 1,

"bindto": [

{

"address": "127.0.0.1:3260",

"mode": "add"

}

],

"accounts": [

{

"username": "9999",

"mode": "add"

}

]

}

}

]

}


GET http://dev02:9200/nexfsconsoleapi?Action=PutISCSIConf&RequestJSON={%20%22itargets%22:%20[{%20%20%22itarget%22:%20{%20%22tid%22:%201,%22headerdigest%22:%20%22on%22,%22datadigest%22:%20%22off%22,%22luns%22:%20[{%20%20%22lun%22:%201,%20%20%20%22path%22:%20%22/1GB%22,%20%20%20%22sn%22:%20%22%22,%20%20%20%22mode%22:%20%22online%22%20}]}}],%20%22bindings%22:%20[{%20%20%22binding%22:%20{%20%22tid%22:%201,%20%20%22bindto%22:%20[{%20%22address%22:%20%22127.0.0.1:3260%22,%20%22mode%22:%20%22add%22%20}%20],%20%22accounts%22:%20[{%20%22username%22:%20%229999%22,%20%22mode%22:%20%22add%22%20}]}}%20]}

Authorization: AWS4-HMAC-SHA256 Credential=8931697604de46d0a0fcbf590263fd01/20220905/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=b7edf4c8ebb93416deba919d371c866499be00942efa1c1e42d764f615731ccb

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

host: nexfs.example.com

x-amz-date: 20220905T122912Z

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>Ok</Code>

<Message>Request Completed</Message>

<Resource>/nexfsconsoleapi</Resource>

<RequestId>309</RequestId>

</RequestCompleted>