Navigation

Get All Backup Daemon Configurations

Retrieves the configurations of all backup daemons.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

GET /daemon/configs

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean

Flag indicating whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results array of objects This array includes one object for each item detailed in the results Embedded Document section.
links array of objects This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one backup daemon.

Name Type Description
assignmentEnabled boolean Flag indicating whether this Backup Daemon can be assigned backup jobs.
backupJobsEnabled boolean Flag indicating whether this Backup Daemon can be used to backup databases.
configured boolean Flag indicating whether this Backup Daemon is ready to use.
garbageCollectionEnabled boolean Flag indicating whether this Backup Daemon has garbage collection set.
headDiskType string

The type of disk used to store the head directory.

The accepted values for this option are:

  • HDD
  • SSD
id string The unique identifier of this Backup Daemon.
labels array of strings Array of tags to manage which backup jobs Ops Manager can assign to which Backup Daemons.
links array of objects One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification
machine object Backup Daemon host and its head directories.
machine.headRootDirectory string The root-relative path of the head directory on this Backup Daemon host.
machine.machine string The hostname or IP address of the Backup Daemon host.
numWorkers number The number of worker processes that can perform tasks (i.e. backup, restore, or groom) for the Backup Daemon.
resourceUsageEnabled boolean Flag indicating whether this Backup Daemon has its resource usage monitored.
restoreJobsEnabled boolean Flag indicating whether this Backup Daemon can be used to restore snapshots.
restoreQueryableJobsEnabled boolean Flag indicating whether this Backup Daemon can perform queryable restores.

Example Request

curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?pretty=true'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
     "assignmentEnabled" : true,
     "backupJobsEnabled" : false,
     "configured" : true,
     "garbageCollectionEnabled" : true,
     "headDiskType" : "SSD",
     "id" : "{DAEMON-CONFIG}",
     "labels" : [ "l1", "l2" ],
     "links" : [ {
       "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{DAEMON-CONFIG},
       "rel" : "self"
     }],
     "machine" : {
       "headRootDirectory" : "/data/backup/",
       "machine" : "localhost"
     },
     "numWorkers" : 50,
     "resourceUsageEnabled" : true,
     "restoreJobsEnabled" : false,
     "restoreQueryableJobsEnabled" : true
  } ],
  "totalCount" : 1
}