Local services: cluster interface
To enable cluster management, enable the cluster interface on all nodes that you want to be part of your Safeguard for Privileged Sessions (SPS) cluster. Complete the following steps on each and every node of the cluster.
|
|
NOTE:
All nodes in a cluster must run the same version of SPS. |
URL
GET https://<IP-address-of-SPS>/api/configuration/local_services/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 configuration options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/local_services/cluster
Response
The following is a sample response received when listing the configuration options.
For details of the meta object, see Message format.
{
"body": {
"enabled": true,
"listen_address": {
"key": "nic1.interfaces.ff7574025754b3df1647001.addresses.2553887595ce3ca7f1eae4",
"meta": {
"href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/2553887595ce3ca7f1eae4"
}
}
},
"key": "cluster",
"meta": {
"first": "/api/configuration/local_services/admin_web",
"href": "/api/configuration/local_services/cluster",
"last": "/api/configuration/local_services/user_web",
"next": "/api/configuration/local_services/indexer",
"parent": "/api/configuration/local_services",
"previous": "/api/configuration/local_services/analytics",
"remaining_seconds": 600,
"transaction": "/api/transaction"
}
}| Element | Type | Description | ||
|---|---|---|---|---|
| enabled | boolean |
By default, this option is set to false. Set it to true to enable the cluster interface. | ||
| listen_address | Top level element (string) | Contains the key of the network interface that is used as the cluster interface. | ||
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 |
|---|---|---|
| 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. |
Date and time
Date & time
Contains the endpoints for configuring date and time on SPS.
URL
GET https://<IP-address-of-SPS>/api/configuration/datetime
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 endpoints for configuring date and time settings on SPS.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/datetime
Response
The following is a sample response received when listing the endpoints for date and time settings.
For details of the meta object, see Message format.
{
"items": [
{
"key": "ntp_servers",
"meta": {
"href": "/api/configuration/datetime/ntp_servers"
}
},
{
"key": "timezone",
"meta": {
"href": "/api/configuration/datetime/timezone"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/datetime",
"last": "/api/configuration/x509",
"next": "/api/configuration/http",
"parent": "/api/configuration",
"previous": "/api/configuration/alerting",
"transaction": "/api/transaction"
}
}
| Element | Description |
|---|---|
| ntp_servers | NTP server addresses. |
| timezone | Timezone settings. |
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 |
|---|---|---|
| 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. |
NTP servers
This endpoint contains NTP server addresses.
URL
GET https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers
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 NTP server addresses.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers
Response
The following is a sample response received when listing NTP server addresses.
For details of the meta object, see Message format.
{
"body": [
{
"selection": "fqdn",
"value": "pool.ntp.org"
}
],
"key": "ntp_servers",
"meta": {
"first": "/api/configuration/datetime/ntp_servers",
"href": "/api/configuration/datetime/ntp_servers",
"last": "/api/configuration/datetime/timezone",
"next": "/api/configuration/datetime/timezone",
"parent": "/api/configuration/datetime",
"previous": null,
"transaction": "/api/transaction"
}
}
Add an NTP server
To add an NTP server's address, you have to:
-
Open a transaction.
For details, see Open a transaction.
-
Create the JSON object for the new NTP server address list.
POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers endpoint. You can find a detailed description of the available parameters listed in Element .
-
Commit your changes.
For details, see Commit a transaction.
Modify an NTP server address
To modify an NTP server's address, you have to:
-
Open a transaction.
For details, see Open a transaction.
-
Modify the JSON object of the NTP server address list.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers endpoint. You can find a detailed description of the available parameters listed in Element .
-
Commit your changes.
For details, see Commit a transaction.
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. |
| 400 | InvalidQuery | The requested filter or its value is invalid. |
| 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. |