Skip to content

get_systems

Jump to bottom Edit New page
Alberto Gonzalez edited this page Oct 29, 2015 · 1 revision

(GET)/systems

Description

Gets the list of systems in the management grid.

Request

Syntax

GET /api/systems
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Optional filters include:

Name Description Type Required
sid system id int No
include_pending Indicates whether or not the list should include systems that are currently in the pending state of replication system int, 1 to include the pending requests, 0 to exclude them No, defaults to true
include_rejected Indicates whether or not the list should include previously rejected replication sources int, 1 to include the rejected requests, 0 to exclude them No (only allowed when include_pending is true)

Response

200 success

Parameters

Index Value Type Returned
id system id int always (negative when is_pending is true and status is not 'accepted'; otherwise it is a positive number)
is_pending Indicates whether or not it is an id of a pending replication system boolean always
request_id id of the pending request int never returned when is_pending is false, always returned when is_pending is true
name system name string always
host system ip address or hostname string always returned when is_pending is false, never returned when is_pending is true
asset_tag asset tag of the source appliance string never returned when is_pending is false, always returned when is_pending is true
role system role string always
  • | for local system, it may be... |
  • | Backup System - a system used for backups |
  • | Manager - a system that manages another remote system |
  • | Target - a system that is a target of replicated backups |
  • | for remote systems, it may be... |
  • | Managed DPU - a system that is managed but is not replicating |
  • | Replication Source - source system that is managed and replicating |
  • | Non-Managed Replication Source - source system that is replicating but not managed |
  • | Pending Replication Source - source system that is attempting to replicate to the local system | version | version of software on the source system | string | always returned when is_pending is false, never returned when is_pending is true
  • | unknown by default | version_status | string that describes version status | string | always returned when is_pending is false, never returned when is_pending is true
  • | latest - the latest release is installed |
  • | update_available - a version update is available |
  • | update_in_progress - a software update is in progress |
  • | unknown | local | this system is one to which the user is directly connected | boolean | always total_mb_size | total backup capacity of the source in MB | long | if available
  • | - | - | not available for Non-Managed Replication Sources total_mb_free | free total backup capacity of the source in MB | long | if available
  • | - | - | not available for Non-Managed Replication Sources registered_assets | number of clients and VMs that are registered on the system | long | if available, never returned when is_pending is true
  • | - | - | returns the number of current instances, even those without a backup
  • | - | - | not available for Non-Managed Replication Sources archiving | a boolean representing whether or not the system is archiving | boolean | if available, never returned when is_pending is true
  • | - | - | not available for Non-Managed Replication Sources replicating| a boolean representing whether or not the system is replicating | boolean | if available
  • | - | - | not available for Non-Managed Replication Sources online | a boolean representing whether or not the system is online | boolean | always returned when is_pending is false, never returned when is_pending is true
  • | if a managed system online also indicates that the remote database is running | status | source status: one of | string | always
  • | pending - the system is requesting to be a replication source on that system
  • | accepted - the replication request has been accepted, but configuration is not yet finished
  • | rejected - the replication request has been rejected (message output will give the reason)
  • | failed - the replication request was accepted, but the configuration failed (message will describe the failure)
  • | suspended- the system is suspended from replicating
  • | available- the system is online
  • | not available- the system is not online or we cannot verify it (i.e., a non-managed replication source) customer (1) | customer name associated with source | string | always, may be "Default Customer", never returned when is_pending is true customer_id (1) | customer ID | long | always, never returned when is_pending is true location (1) | location name associated with the source | string | always, may be "Default Location", never returned when is_pending is true location_id (1) | location ID | long | always, never returned when is_pending is true message| reason for rejection or failure to configure | string | never returned when is_pending is false, always returned when is_pending is true and status is rejected or failed created | formatted time-stamp of when the request arrived | string | never returned when is_pending is false, always returned when is_pending is true updated | formatted time-stamp of the most recent update to the request (may be same as created) | string | never returned when is_pending is false, always returned when is_pending is true

Note: Items marked by (1) are not in Release 1.0, nor are the customers resource and APIs to manage them.

Example

Sample Request

GET /api/systems/?include_pending=1&include_rejected=1
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

Sample Response

{
  "appliance": [
    {
      "id": 1,
      "host": "10.101.2.134",
      "name": "TargetUEB",
      "role": "Target",
      "version": "9.0.0-0.201507020206.CentOS6",
      "version_status": "latest",
      "online": true,
      "customer_id": 1,
      "customer_name": "Default Customer",
      "location_id": 1,
      "location_name": "Default Location",
      "registered_assets": 0,
      "replicating": false,
      "archiving": false,
      "local": false,
      "total_mb_size": 163756,
      "total_mb_free": 162523
    },
    {
      "id": 48,
      "host": "172.17.3.6",
      "name": "Linda_CE_UEB",
      "role": "Non-Managed Replication Source",
      "version": "Unknown",
      "version_status": "unknown",
      "online": false,
      "customer_id": 1,
      "customer_name": "Default Customer",
      "location_id": 1,
      "location_name": "Default Location",
      "registered_assets": 0,
      "replicating": false,
      "archiving": false,
      "local": false,
      "total_mb_size": 0,
      "total_mb_free": 0
    },
    {
      "id": 50,
      "host": "172.17.3.10",
      "name": "UF_142",
      "role": "Non-Managed Replication Source",
      "version": "Unknown",
      "version_status": "unknown",
      "online": false,
      "customer_id": 1,
      "customer_name": "Default Customer",
      "location_id": 1,
      "location_name": "Default Location",
      "registered_assets": 0,
      "replicating": false,
      "archiving": false,
      "local": false,
      "total_mb_size": 0,
      "total_mb_free": 0
    },
    {
      "id": 51,
      "host": "10.101.2.144",
      "name": "UEB_144",
      "role": "Replication Source",
      "version": "9.0.0-0.201507020206.CentOS6",
      "version_status": "latest",
      "online": true,
      "customer_id": 1,
      "customer_name": "Default Customer",
      "location_id": 1,
      "location_name": "Default Location",
      "registered_assets": 0,
      "replicating": true,
      "archiving": false,
      "local": false,
      "total_mb_size": 142010,
      "total_mb_free": 141498
    },
    {
      "id": 2,
      "host": "",
      "name": "TargetUEB.dpu",
      "role": "Managed DPU",
      "version": "9.0.0-0.201507020206.CentOS6",
      "version_status": "latest",
      "online": true,
      "customer_id": 1,
      "customer_name": "Default Customer",
      "location_id": 1,
      "location_name": "Default Location",
      "registered_assets": 0,
      "replicating": false,
      "archiving": false,
      "local": false,
      "total_mb_size": 163756,
      "total_mb_free": 162524
    },
    {
      "is_pending": true,
      "request_id": 11,
      "name": "UF_141",
      "asset_tag": "1dea6057-d160-4d91-94d4-adcd2cf8ddba",
      "role": "Pending Replication Source",
      "local": false,
      "replicating": false,
      "total_mb_size": 0,
      "total_mb_free": 0,
      "status": "rejected",
      "created": "UF_141",
      "updated": 1435449320,
      "message": "This is a test, don't take it personally."
    },
    {
      "is_pending": true,
      "request_id": 14,
      "name": "UF_143",
      "asset_tag": "c5f2692d-4e80-41db-9bb3-651d9ec59279",
      "role": "Pending Replication Source",
      "local": false,
      "replicating": false,
      "total_mb_size": 0,
      "total_mb_free": 0,
      "status": "pending",
      "created": "UF_143"
    }
  ],
  "timestamp": 1435937601
}
Add a custom footer
Add a custom sidebar

Clone this wiki locally