Retrieving Nexfs Active iSCSI Information

The Nexfs Management API allows retrieval of active iSCSI information, stats and status for targets, sessions, accounts, interfaces, connections, and LUNs.

Action: GetActiveISCSI

Requests active iSCSI session details or statistics, including information about active targets, accounts, interfaces, and sessions.

Permissions

To retrieve active iSCSI information, the requesting session must have the `iscsi/GetActive` permission enabled.

Request Parameters

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

The request must be signed using a valid AWS Signature Version 4, with an active temporary session security token.

Action

Required: Must be set to 'GetActiveISCSI'

Connection

Connection ID, Required for actions being filtered by iscsi connection

LUN

LUN ID, Required for actions being filtered by iscsi LUN

Retrieve

Required. Specifies which active iSCSI information to return.

The following show action information retrieve parameters are supported:

The following show action information retrieve parameters are supported:

Session

Session ID, Required for actions being filtered by iscsi session

Target

Required when using "showtargetsession" and "showtarget" as the 'Retrieve' Value. Specifies the targt ID to limit the results.

All values for Target, Session, Connection and LUN must be integers.

Request Body

The request does not have a request body.

Response Syntax

If available, the requested information is returned in the response body as `text/plain`.

Response Elements

If the request is successful, the service responds with HTTP 200 and the requested information in the response body.

Errors

Also See Rest Error Responses

400 BadRequest The request was Malformed

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 Requests

showtargets:

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetActiveISCSI&Retrieve=showtargets

Authorization: AWS4-HMAC-SHA256 Credential=e01920da85cf44dfa1f670dc52073a28/20220823/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=d92d8e66b23619d5ea3c278b048bd2d1f63335928611c61b891db6a3e968ab02

host: nexfs.example.com

x-amz-date: 20220823T130753Z

Example showtargets Response

Target 1: iqn.2021-09.com.nexfs:nexfs01.itarget:nexfsbuild02

Target Status: ready

Connection information:

LUN information:

LUN: 0

Type: controller

SCSI ID: Nexus 0100010000

SCSI SN: Nexfs 110

Size: 0 MB, Block size: 1

Online: Yes

Readonly: No

Software Write Protect: No

Thin Provisioning: No

Path: None

LUN: 1

Type: disk

SCSI ID: Nexus 0100010001

SCSI SN: 60e0f24240e811f0aa9800224d5064b6

Size: 0 MB, Block size: 512

Online: Yes

Readonly: No

Software Write Protect: No

Thin Provisioning: Yes

Path: /statopendeleted

CHAP Authenication Accounts:

salesserver

iscsiserver (outgoing)

Enabled Interfaces:

Acl:

ALL

Example stattargets Response

Target: * Session: * Connection: *

rxdata: 0

txdata: 0

datain pdus: 0

dataout pdus: 0

cmd pdus: 0

rsp pdus: 0

logins: 0

logouts: 0

errors: 0

digest err: 0

timeout err: 0