REST endpoints: Systems

REST

These ~~endpoints:~~endpoints mirror the CLI commands described in S, 0. 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.

`GET /systems/list`

List systems.

CLI command: systems list

Query parameters

Name Type Required Description connectToAllSystems boolean No Create a connection to all systems. showNodes boolean No Show nodes within the systems.

Response: an object of type SystemsList in Result, with: Systems (array of SystemElement), Message (string).

`POST /systems/multi_system_manager/register`

CLI command: systems multi_system_manager register

Body fields (JSON)

Name Type Required Description Multi_system_manager string Depends The IP address or DNS name of the Multi-System-Manager. RemoteNode string Depends The management IP address of a remote node to register. The node will be registered to the same Multi-System-Manager as the locally managed node.

`GET /systems/multi_system_manager/status`

Multi-System-Manager registration status.

CLI command: systems multi_system_manager status

This endpoint takes no parameters.

Response: a list of MultiSystemManagementSystemElement objects in Result.Systems, each with: SystemId (integer), IsConnected (boolean), Addresses (array of string), MultiSystemManagementAddress (string).

`DELETE /systems/multi_system_manager/unregister`

Unregister from Multi-System-Manager management.

CLI command: systems multi_system_manager unregister

Query parameters

Name Type Required Description systemId integer Depends The ID of the system to unregister. address string Depends The IP address or DNS name of the system to unregister.

`PUT /systems/rename`

Rename a system.

CLI command: systems rename

Body fields (JSON)

Name Type Required Description Name string Depends The system to rename, by name. Id integer Depends The system to rename, by ID. Newname string Yes The new name for the system.

`GET /systems/select`

Switch to a different system.

CLI command: systems select

Query parameters

Name Type Required Description name string Depends Switch and manage this system by name. id integer Depends Switch and manage this system by ID.

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