Manage Safeguard for Privileged Sessions clusters
When you have a set of two or more Safeguard for Privileged Sessions (SPS instances in your deployment, you can join them into a cluster. This has several advantages. You can:
-
Manage the nodes from one central location.
-
Monitor their status and update their configuration centrally.
-
Search all session data recorded by all nodes in the cluster on a single node.
-
Scale the performance of the cluster by adding new nodes and joining them to the cluster easily.
-
Extend auditing to other networks by adding new nodes to the cluster and joining them to the cluster.
This is achieved by assigning roles to the individual nodes in your cluster: you can set one of your Safeguard for Privileged Sessions nodes to be the Central Management node and the rest of the nodes are managed from this central node.
|
|
NOTE:
All nodes in a cluster must run the same version of SPS. |
|
|
NOTE:
To configure the /api/cluster/ endpoint, your usergroup must have "read and write/perform" privileges assigned to the Basic Settings > Cluster management object. You can configure this on the AAA > Access Control page of SPS's web interface. For details, see "Managing user rights and usergroups" in the Administration Guide. |
URL
GET https://<IP-address-of-any-node-in-cluster>/api/cluster
Cookies
| Cookie name | Description | Required | Values |
|---|---|---|---|
| session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the endpoints available under the cluster endpoint.
curl --cookie cookies https://<IP-address-of-any-node-in-cluster>/api/cluster
Response
The following is a sample response received.
For details of the meta object, see Message format.
{
"items": [
{
"key": "configuration_sync",
"meta": {
"href": "/api/cluster/configuration_sync"
}
},
{
"key": "join_request",
"meta": {
"href": "/api/cluster/join_request"
}
},
{
"key": "nodes",
"meta": {
"href": "/api/cluster/nodes"
}
},
{
"key": "promote",
"meta": {
"href": "/api/cluster/promote"
}
},
{
"key": "status",
"meta": {
"href": "/api/cluster/status"
}
}
],
"meta": {
"href": "/api/cluster",
"join_request": "/api/cluster/join_request",
"nodes": "/api/cluster/nodes",
"parent": "/api",
"promote": "/api/cluster/promote",
"status": "/api/cluster/status",
"configuration_sync": "/api/cluster/configuration_sync"
}
}
| Element | Type | Description | ||
|---|---|---|---|---|
| items | Top-level element (list of JSON objects) | List of endpoints (objects) available from the current endpoint. | ||
| key | string | The ID of the endpoint. | ||
| meta | Top-level item (JSON object) | Contains the path to the endpoint. | ||
| href | string (relative path) | The path of the resource that returned the response. | ||
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| Code | Description | Notes |
|---|---|---|
| 201 | Created | The new resource was successfully created. |
| 401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
| 404 | NotFound | The requested object does not exist. |
Promote a Safeguard for Privileged Sessions node to be the Central Management node in a new cluster
You can build a cluster by promoting a Safeguard for Privileged Sessions node to the role of the Central Management node, and then join other nodes to your cluster.
To promote a node to be the Central Management node, complete the following steps:
-
Open a transaction.
For details, see Open a transaction.
-
Create the Central Management node.
POST an empty request to the https://<IP-address-of-node-to-become-Central-Management-node>/api/cluster/promote endpoint.
The following is a sample response received.
For details of the meta object, see Message format.
{ "body": { "address": "<IP-address-of-Central-Management-node>", "roles": [ "central-management" ] }, "meta": { "href": "/api/cluster/nodes/b35c54da-b556-4f91-ade5-d26283d68277", "parent": "/api/cluster/nodes", "remaining_seconds": 28800 } }Elements Type Description body Top-level element (JSON object) Contains the JSON object of the node. address string The IP address of the node. roles string The role of the node. -
Commit your changes.
For details, see Commit a transaction.
Join node(s) to the cluster
Once you have a Central Management Safeguard for Privileged Sessions node in place, then you can join other nodes to your cluster.
To join nodes to your cluster, complete the following steps for each node that you want to join to the cluster:
-
Open a transaction.
For details, see Open a transaction.
-
Create a join request.
POST the IP address of the Central Management node as a JSON object to the https://<IP-address-of-node-to-join-to-cluster>/api/cluster/join_request endpoint. The body of the POST request should be the following:
{ "central_management_address": "<IP-address-of-Central-Management-node>" }For example:
curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-node-to-join-to-cluster>/api/cluster/join_request --data '{"central_management_address": "<IP-address-of-Central-Management-node>"}'The following is a sample response received.
For details of the meta object, see Message format.
By default, no role is assigned to a non-management node, that is why the "roles" array is empty.
{ "body": { "address": "<IP-address-of-node-joined-to-cluster>", "node_id": "46f97a58-4028-467d-9a22-9cfe78ae3e1c", "psk": "Ler7HZDFmZCxnLLgHNRfZYfORhlZS99l9vEVr5UKtJEb1d4WeaHcBmQJLs4VDWIn", "roles": [] }, "meta": { "href": "/api/cluster/join_request", "parent": "/api/cluster", "remaining_seconds": 600 } }Elements Type Description body Top-level element (JSON object) Contains the JSON object of the node. address string The IP address of the node. node_id string A reference ID for the node. psk string The pre-shared key of the node used for authentication. roles string The role of the node. -
Join the node to the cluster.
POST the "body" object of the response to the https://<IP-address-of-Central-Management-node>/api/cluster/nodes endpoint as a JSON object. The body of the POST request should be the following:
{ "address": "<IP-address-of-node-joined-to-cluster>", "node_id": "46f97a58-4028-467d-9a22-9cfe78ae3e1c", "psk": "Ler7HZDFmZCxnLLgHNRfZYfORhlZS99l9vEVr5UKtJEb1d4WeaHcBmQJLs4VDWIn", "roles": [] },For example:
POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-Central-Management-node>/api/cluster/nodes --data '{"address": "<IP-address-of-node-joined-to-cluster>", "node_id": "46f97a58-4028-467d-9a22-9cfe78ae3e1c", "psk": "Ler7HZDFmZCxnLLgHNRfZYfORhlZS99l9vEVr5UKtJEb1d4WeaHcBmQJLs4VDWIn","roles": []}'If the POST request is successful, the response includes:
{ "body": { "address": "<IP-address-of-node-joined-to-cluster>", "roles": [] }, "key": "46f97a58-4028-467d-9a22-9cfe78ae3e1c", "meta": { "href": "/api/cluster/nodes/46f97a58-4028-467d-9a22-9cfe78ae3e1c", "parent": "/api/cluster/nodes", "remaining_seconds": 28800 } } -
Commit your changes on both the Central Management node and the node you joined to the cluster.
For details, see Commit a transaction.
Query join status
To find out whether a node has been joined to a cluster, complete the following steps.
-
Query the /api/cluster/join_request endpoint on the node whose join status you want to figure out.
curl GET --cookie cookies https://<IP-address-of-node-to-be-queried>/api/cluster/join_request
The following is a sample response received.
For details of the meta object, see Message format.
"details": { "central_management_address": "<IP-address-of-Central-Management-node>" }, "meta": { "href": "/api/cluster/join_request", "parent": "/api/cluster", "remaining_seconds": 600 }, "status": "in cluster" }Elements Type Description details Top-level element Contains the IP address of the Central Management node of the cluster. central_management_address string The IP address of the Central Management node.
Not provided when no cluster has been set up yet.
status string Possible values are:
- not configured: Displayed when no cluster has been set up yet.
- in progress: Displayed when the join action is in progress.
- in cluster: Displayed when the node is already in the cluster.