REST endpoints: Nodes

REST

These ~~endpoints:~~endpoints mirror the CLI commands described in Nodes overview, High availability, Support access and network settings. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

`PUT /nodes/chap`

Configure iSCSI target CHAP settings.

CLI command: nodes chap

Body fields (JSON)

Name Type Required Description ChapName string No iSCSI target CHAP username for mutual authentication. If omitted (together with ChapSecret), target CHAP is disabled. ChapSecret string No iSCSI target CHAP secret for mutual authentication. Force boolean No Skip the confirmation prompt.

`PUT /nodes/connect`

Switch connection to a different node.

CLI command: nodes connect

Body fields (JSON)

Name Type Required Description Node string Yes The node to connect to.

`PUT /nodes/edit`

Rename a node.

CLI command: nodes edit

Body fields (JSON)

Name Type Required Description Node string Yes The name of the node to rename. Newname string Yes The node's new name.

`PUT /nodes/giveback`

Perform a giveback (changing HA state).

CLI command: nodes giveback

Body fields (JSON)

Name Type Required Description Force boolean No Skip the confirmation prompt.

`PUT /nodes/isns`

Configure iSNS settings.

CLI command: nodes isns

Body fields (JSON)

Name Type Required Description Address string No The iSNS server address. If omitted, iSNS is disabled. AccessControl boolean No Enable iSNS access control. Force boolean No Skip the confirmation prompt.

`GET /nodes/list`

List all S1 nodes.

CLI command: nodes list

Query parameters

Name Type Required Description sensors boolean No Show node sensor readings. gateway boolean No Show the IQNs and WWPNs of the nodes. vols boolean No List the volumes running on each node. ip boolean No Show the IP addresses of the nodes. sed boolean No Show whether the SED password is set. memory boolean No Show memory stats.

Response: a list of NodeElement objects in Result.NodeElement.

`GET /nodes/management_db/state`

Show ManagementService state.

CLI command: nodes management_db state

This endpoint takes no parameters.

Response: a list of RaidInfo objects in Result.RaidInfo.

`GET /nodes/sessions`

Show the connected sessions for all nodes.

CLI command: nodes sessions

Query parameters

Name Type Required Description node string No Filter by node name. If omitted, all nodes are included.

Response: a list of NodeElement objects in Result.Sessions.

`PUT /nodes/support/tunnel/disable`

Disable support tunnel for node.

CLI command: nodes support tunnel disable

Body fields (JSON)

Name Type Required Description Node string Yes The node to disable the support tunnel on.

`PUT /nodes/support/tunnel/enable`

Enable support tunnel for node.

CLI command: nodes support tunnel enable

Body fields (JSON)

Name Type Required Description Node string Yes The node to enable the support tunnel on.

`GET /nodes/support/tunnel/status`

Get status information for the support tunnel.

CLI command: nodes support tunnel status

This endpoint takes no parameters.

Response: a list of NodeElement objects in Result.NodesSupportTunnelStatus.

`PUT /nodes/takeover`

Perform a takeover (changing HA state).

CLI command: nodes takeover

Body fields (JSON)

Name Type Required Description Node string Yes The node that will take over all volumes from its peer (its HA state becomes 'All', while the peer's becomes 'None'). Force boolean No Skip the confirmation prompt.

`GET /nodes/utils/run`

Run node utilities.

CLI command: nodes utils run

Query parameters

Name Type Required Description node string Yes The node to run the utility on. utility string Yes Utility to run. args string No Utility arguments. timeoutSeconds integer No Override the utility's configured timeout. If omitted, the utility's own timeout is used (no limit if none is configured).

Response: the command output, in the format selected by outputType.