POST cluster

This web method can send a command to all FTL servers in the cluster, including:

  • A command to shutdown all FTL servers.

  • Commands to manage the disaster recovery (DR) feature. Note that these commands are also available via the FTL admin tool (tibftladmin). See FTL Administration Utility and Disaster Recovery for full details.

Input Data

Supply the command in JSON format.

Commands

Syntax Description
{"cmd":"shutdown"} Shutdown the FTL server cluster.
{"cmd": "activate_dr", "args": [{"auto_config_update": <bool>}]} Activate a DR site, with optional automatic realm configuration update. See FTL Administration Utility.
{"cmd": "prepare_planned_dr_failover"} Prepare an active site for planned DR failover. See FTL Administration Utility.
{"cmd": "deactivate_dr"} Final deactivation of an active site during planned DR failover. See FTL Administration Utility.
{"cmd": "enable_dr", "args": [{"drto": "<urls>", "auto_config_update": <bool>}]} Enable the DR feature on running FTL servers. Specify the URLs of the new DR site. Automatic realm configuration update is optional. See FTL Administration Utility.

Example Requests

Simple shutdown: 

curl -X POST http://<host>:<port>/api/v1/cluster/ -d '{"cmd":"shutdown"}'

Save persistence state to disk, then shutdown: 

curl -X POST http://<host>:<port>/api/v1/cluster/ -d '{"cmd":"shutdown", "args":[{"savestate": true}]}'
Note: The savestate option is not needed if disk persistence is enabled.
Note: You can also shut down all FTL servers with POST ftlservers/<server_name>.

Activate DR:

curl -X POST http://<host>:<port>/api/v1/cluster -d '{"cmd": "activate_dr", "args": [{"auto_config_update": <bool>}]}'

Prepare planned DR failover:

curl -X POST http://<host>:<port>/api/v1/cluster -d '{"cmd": "prepare_planned_dr_failover"}'

Deactivate DR:

curl -X POST http://<host>:<port>/api/v1/cluster -d '{"cmd": "deactivate_dr"}'

Enable DR:

curl -X POST http://<host>:<port>/api/v1/cluster -d '{"cmd": "enable_dr", "args": [{"drto": "<urls>", "auto_config_update": <bool>}]}'