Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.14 - REST API Reference Guide

Introduction Using the SPS REST API Basic settings User management and access control Managing SPS General connection settings HTTP connections Citrix ICA connections MSSQL connections RDP connections SSH connections Telnet connections VNC connections Search, download, and index sessions Reporting Health and maintenance Advanced authentication and authorization Completing the Welcome Wizard using REST Enable and configure analytics using REST

Assign a role to a node

By default, nodes do not have any roles assigned to them. The only exception is the Central management node, which you specifically promoted to fulfill that role. To assign a role to a node in the cluster, complete the following steps.

  1. Open a transaction.

    For more information, see Open a transaction.

  2. Update the JSON object of the node.

    PUT the role you want to assign to the node and the node's IP address as a JSON object to the https://<IP-address-of-Central-Management-node>/api/cluster/nodes/<node-id-of-node-to-be-updated> endpoint.

    You can assign the following roles to a node:

    NOTE: The central-management role can only be assigned using the /api/cluster/promote endpoint.

    NOTE: Ensure that each node has a search role and only one search role.

    Role Description
    managed-host

    There can be several nodes with this role.

    Nodes with the Managed Host role synchronize their entire configuration from the Central Management node, not only those elements of the configuration that are related to the cluster.

    search-master

    There can be only one node with this role.

    The Search Master node is the one node in the cluster on which you can search all the session data recorded by other nodes in the cluster, provided that the other nodes have been assigned the Search Minion role.

    search-minion

    There can be several nodes with this role.

    Nodes with the Search Minion role send session data that they recorded to the Search Master for central search purposes. The session data recorded by a Search Minion node is not searchable on the node itself, only on the Search Master.

    search-local

    There can be several nodes with this role.

    Nodes with the Search Local role keep the session data that they recorded for local searching. The session data recorded by a Search Local node is searchable on the node itself, but not on the Search Master.

    This is the only backward-compatible search role.

    For further details on roles, see "Cluster roles" in the Administration Guide.

    The body of the PUT request should be the following:

    {
    "roles": ["<role-to-assign>"],
    "address": "<IP-address-of-node-to-be-updated>"
}

    For example:

    curl -H "Content-Type: application/json" --cookie cookies -X PUT https://<IP-address-of-Central-Management-node>/api/cluster/nodes/46f97a58-4028-467d-9a22-9cfe78ae3e1c --data '{"roles": ["managed-host"], "address": "<IP-address-of-node-to-be-updated>"}'
  3. Commit your changes.

    For more information, see Commit a transaction.

Query nodes

To list the nodes available in a cluster, complete the following steps.

  1. Query the /api/cluster/nodes endpoint on the Central Management node.
    curl --cookie cookies https://<IP-address-of-Central-Management-node>/api/cluster/nodes

    The following is a sample response received.

    For details of the meta object, see Message format.

    {
    "items": [
        {
            "key": "46f97a58-4028-467d-9a22-9cfe78ae3e1c",
            "meta": {
                "href": "/api/cluster/nodes/46f97a58-4028-467d-9a22-9cfe78ae3e1c",
                "status": "/api/cluster/status/46f97a58-4028-467d-9a22-9cfe78ae3e1c"
            }
        },
        {
            "key": "b35c54da-b556-4f91-ade5-d26283d68277",
            "meta": {
                "href": "/api/cluster/nodes/b35c54da-b556-4f91-ade5-d26283d68277",
                "status": "/api/cluster/status/b35c54da-b556-4f91-ade5-d26283d68277"
            }
        }
    ],
    "meta": {
        "href": "/api/cluster/nodes",
        "parent": "/api/cluster",
        "remaining_seconds": 28800,
        "self": "/api/cluster/nodes/b35c54da-b556-4f91-ade5-d26283d68277",
        "status": "/api/cluster/status"
    }
}
    Elements 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 node.
    meta Top-level item (JSON object) Contains links to different parts of the REST service.
    href string (relative path) The path of the node that returned the response.
    status string (relative path) The path to the status of the node that returned the response.

Query one particular node

To query one particular node, complete the following steps.

  1. Query the /api/cluster/nodes/<node-id-of-node-to-be-queried> endpoint on the node that you want to query.
    curl --cookie cookies https://<IP-address-of-node-to-be-queried>/api/cluster/nodes/<node-id-of-node-to-be-queried>

    The following is a sample response received.

    For details of the meta object, see Message format.

    {
    "body": {
        "address": "<IP-address-of-node-to-be-queried>",
        "roles": [
            "central-management"
        ]
    },
    "key": "b35c54da-b556-4f91-ade5-d26283d68277",
    "meta": {
        "href": "/api/cluster/nodes/b35c54da-b556-4f91-ade5-d26283d68277",
        "parent": "/api/cluster/nodes",
        "remaining_seconds": 28800,
        "status": "/api/cluster/status/b35c54da-b556-4f91-ade5-d26283d68277"
    }
}
    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 assigned to the node.
    key string The ID of the node.

Query the status of all nodes in the cluster

To query the status of all nodes in your cluster, complete the following steps.

  1. Query the /api/cluster/status endpoint on the Central Management node.
    curl --cookie cookies https://<IP-address-of-Central-Management-node>/api/cluster/status

    The following is a sample response received.

    For details of the meta object, see Message format.

    {
  "items": [
    {
      "key": "b35c54da-b556-4f91-ade5-d26283d68277",
      "fqdn": "sps.example.com",
      "health_status": null,
      "sync_status": "n/a",
      "meta": {
        "configuration": "/api/cluster/nodes/b35c54da-b556-4f91-ade5-d26283d68277",
        "href": "/api/cluster/status/b35c54da-b556-4f91-ade5-d26283d68277"
      }
    },
    {
      "key": "46f97a58-4028-467d-9a22-9cfe78ae3e1c",
      "last_seen": "2018-02-08T10:00:30Z",
      "fqdn": "managed-host.cluster",
      "health_status": {
        "memory": 62.5,
        "disk": 1.9,
        "swap": 0,
        "load1": 0.53,
        "load5": 0.68,
        "load15": 0.37,
        "sessions": {
          "ssh": 3,
          "rdp": 4
        },
        "total_sessions": 7
      },
      "sync_status": "pending",
      "configuration_sync": {
        "last_updated": "2018-02-08T09:59:00Z",
        "last_checked": "2018-02-08T09:59:00Z",
        "downloaded_xml_hash": "2853830f4aa0a90a63e75bab1b22e513",
        "issues": {
          "warnings": [
           {
              "message": "Connection 'simple_ssh_connection' and local service 'SSH' conflict on 10.30.42.42:22",
              "paths": [
                "/api/configuration/ssh/connections/12345",
                "/api/configuration/local_services/ssh"
              ]
            }
          ]
        }
      },
      "meta": {
        "configuration": "/api/cluster/nodes/46f97a58-4028-467d-9a22-9cfe78ae3e1c",
        "href": "/api/cluster/status/46f97a58-4028-467d-9a22-9cfe78ae3e1c"
      }
    }
  ],
  "meta": {
    "href": "/api/cluster/status",
    "parent":  "/api/cluster",
    "self": "/api/cluster/status/b35c54da-b556-4f91-ade5-d26283d68277"
  }
}
    Elements 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 node.

     

    fqdn

     

    string

    The address of the node as a fully qualified domain name.

     

    health_status

     

    null or object

    The health status of a node. If the node is down, the value is null. Otherwise, the health-related data is listed.

    memory floating point integer (percent) Memory use
    disk floating point integer (percent) Hard disk use
    swap floating point integer (percent) Swap use
    load1 floating point integer

    The average system load during the last one minute. The values mean the following:

    • < 1: low system load
    • 1-5: high system load
    • > 5: extremely high system load
    load5 floating point integer

    The average system load during the last five-minute period. The values mean the following:

    • < 1: low system load
    • 1-5: high system load
    • > 5: extremely high system load
    load15 floating point integer

    The average system load during the last fifteen-minute period. The values mean the following:

    • < 1: low system load
    • 1-5: high system load
    • > 5: extremely high system load
    sessions string

    The protocol type and the number of ongoing sessions. For example:

    "sessions": {
  "ssh": 3,
  "rdp": 4
},
    total_sessions integer (number of) The total number of ongoing sessions.
    sync_status string

    Indicates the status of configuration synchronization. It has the following values:

    • up-to-date: The node has fetched the latest configuration from the Central Management node, and has applied it. It is in sync with the Central Management node.
    • pending: There has been a configuration change on the Central Management node, and the change has not been synchronized yet to the node.
    • outdated: There has been some error on the node and therefore it is running an old configuration.
    • not-fetched: The node has not fetched any configuration yet.
    • n/a: The node is the Central Management node, so it is not fetching its configuration from any other node.
    meta Top-level item (JSON object) Contains links to different parts of the REST service.
    configuration string (relative path) The path to the configuration of the node that returned the response.
    href string (relative path) The path to the node that returned the response.
    last_seen string The last time the node sent status information to the Central Management node, in ISO 8601 format.
    configuration_sync Top-level item (JSON object)

     

     

    downloaded_xml_hash

    string

    The hash of the latest downloaded configuration file (used for configuration synchronization). If no configuration file has been downloaded yet, it says null.

    last_updated string The last time the node's configuration was synchronized, in ISO 8601 format.
    last_checked string The last time the node attempted to fetch a new configuration, in ISO 8601 format.
    issues Top-level item (JSON object) The issues that occurred during configuration synchronization.
    Elements of issues Type Description
    warning Top-level item (JSON object)
    message string Human-readable text explaining why the warning occurred.
    details array List of additional information about the warning (for example, the path where the warning occurred).
    error Top-level item (JSON object)
    type string The type of the error.
    message string Human-readable text explaining why the error occurred.
    details JSON object List of additional information about the error (for example, the path where the error occurred).
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating