Skip to main content

Nodes

put__nodes_chap

Code samples

PUT /nodes/chap HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/chap

ISCSI target chap settings.

Body parameter

{
  "ChapName": "string",
  "ChapSecret": "string",
  "Force": true
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesChap false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__nodes_connect

Code samples

PUT /nodes/connect HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/connect

Switch connection to a different node.

Body parameter

{
  "Node": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesConnect false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__nodes_edit

Code samples

PUT /nodes/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/edit

Edit node.

Body parameter

{
  "Node": "string",
  "Newname": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesEdit false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__nodes_giveback

Code samples

PUT /nodes/giveback HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/giveback

Perform a giveback (changing HA state).

Body parameter

{
  "Force": true
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesGiveback false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__nodes_isns

Code samples

PUT /nodes/isns HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/isns

ISNS settings.

Body parameter

{
  "Address": "string",
  "AccessControl": true,
  "Force": true
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesIsns false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__nodes_list

Code samples

GET /nodes/list HTTP/1.1

Accept: application/json

GET /nodes/list

List all S1 nodes.

Parameters

Name In Type Required Description
sensors query boolean false See node sensors.
gateway query boolean false Display the IQNs and WWNs of the nodes.
vols query boolean false Display a list of volumes that run on each node.
ip query boolean false Display the IP addresses of the nodes.
sed query boolean false Check if SED password is supplied.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success NodeElementApiResult
400 Bad Request Bad Request string

get__nodes_sessions

Code samples

GET /nodes/sessions HTTP/1.1

Accept: application/json

GET /nodes/sessions

Show the connected sessions for all nodes.

Parameters

Name In Type Required Description
node query string false Node to get the connected sessions.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success NodeElementApiResult
400 Bad Request Bad Request string

put__nodes_takeover

Code samples

PUT /nodes/takeover HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/takeover

Perform a takeover (changing HA state).

Body parameter

{
  "Node": "string",
  "Force": true
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesTakeover false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__nodes_utils_run

Code samples

GET /nodes/utils/run HTTP/1.1

Accept: application/json

GET /nodes/utils/run

Run node utilities.

Parameters

Name In Type Required Description
node query string false The node to run the utility on.
utility query string false Utility to run.
args query string false Utility arguments.
timeoutSeconds query integer(int64) false Set limit for the operation (by default it is set to 10 seconds).

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__nodes_support_tunnel_disable

Code samples

PUT /nodes/support/tunnel/disable HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/support/tunnel/disable

Body parameter

{
  "Node": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesSupportTunnelDisable false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__nodes_support_tunnel_enable

Code samples

PUT /nodes/support/tunnel/enable HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /nodes/support/tunnel/enable

Enable support tunnel for node.

Body parameter

{
  "Node": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body NodesSupportTunnelEnable false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__nodes_support_tunnel_status

Code samples

GET /nodes/support/tunnel/status HTTP/1.1

Accept: application/json

GET /nodes/support/tunnel/status

Get status information for the support tunnel.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success NodeElementApiResult
400 Bad Request Bad Request string
No Comments
Back to top