Navigation

Create One File System Store Configuration

Configures one new file system store.

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

Resource

POST /snapshot/fileSystemConfigs

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
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 one result, response body includes:

status
HTTP response code
envelope
The expected response body
false

Request Body Parameters

Name Type Description
assignmentEnabled boolean Optional. Flag indicating whether this file system store can be assigned backup jobs.
id string The unique name that labels this file system store.
labels array of strings

Optional. Array of tags to manage which backup jobs Ops Manager can assign to which file system stores.

Setting these tags limits which backup jobs this file system store can process. If omitted, this file system store can only process backup jobs for projects that do not use labels to filter their jobs.

loadFactor number

Optional. A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. This option is needed only if more than one snapshot store is in use.

See also

To learn more about Load Factor, see Edit an Existing Blockstore

mmapv1CompressionSetting string

The compression setting for the MMAPv1 storage engine snaphots.

The accepted values for this option are:

  • NONE
  • GZIP
storePath string The location where file system-based backups are stored on the file system store host.
wtCompressionSetting string

The compression setting for the WiredTiger storage engine snaphots.

The accepted values for this option are:

  • NONE
  • SNAPPY
  • ZLIB

Response

Name Type Description
assignmentEnabled boolean Flag indicating whether this file system store can be assigned backup jobs.
id string The unique identifier of this file system store.
labels array of strings Array of tags to manage which backup jobs Ops Manager can assign to which file system stores.
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
loadFactor number

A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. This option is needed only if more than one snapshot store is in use.

See also

To learn more about Load Factor, see Edit an Existing Blockstore

mmapv1CompressionSetting string

The compression setting for the MMAPv1 storage engine snaphots.

The accepted values for this option are:

  • NONE
  • GZIP
storePath string The system root-relative directory path where file system-based backups are stored on the file system store host.
wtCompressionSetting string

The compression setting for the WiredTiger storage engine snaphots.

The accepted values for this option are:

  • NONE
  • SNAPPY
  • ZLIB

Example Request

curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true' \
 --data '{
   "assignmentEnabled" : true,
   "labels" : [ "l1", "l2" ],
   "loadFactor" : 50,
   "mmapv1CompressionSetting" : "GZIP",
   "storePath" : "/data/backup",
   "wtCompressionSetting" : "NONE"
 }'

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

{
  "assignmentEnabled" : true,
  "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs",
    "rel" : "self"
  }],
  "loadFactor" : 50,
  "mmapv1CompressionSetting" : "GZIP",
  "storePath" : "/data/backup",
  "wtCompressionSetting" : "NONE"
}