Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

Update One File System Store Configuration

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Updates the configuration of one file system store.

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

PUT /snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}
Path Parameter
Type
Necessity
Description
FILE-SYSTEM-CONFIG-ID
string
Required
Unique identifier that labels this file system store configuration.

The following query parameters are optional:

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag that indicates 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, the response body includes:

Name
Description
status
HTTP response code
envelope
Expected response body
false
Body Parameter
Type
Necessity
Description
assignmentEnabled
boolean
Optional
Flag that indicates whether this file system store can be assigned backup jobs.
labels
array of strings
Optional

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

Positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. Set this option only if you're using more than one snapshot store.

Tip

See also:

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

mmapv1CompressionSetting
string
Optional

Compression setting if you use the MMAPv1 storage engine for your snaphots.

Ops Manager accepts NONE or GZIP. Ops Manager sets this value to NONE by default.

If the MongoDB runs FCV 4.2 or later, Ops Manager ignores this setting.

Important

MongoDB removed support for the MMAPv1 storage engine in MongoDB 4.2. If you edit your deployment's configuration to change your storage engine to WiredTiger Storage Engine, Ops Manager restarts the MongoDB processes.

storePath
string
Required
Location where file system-based backups are stored on the file system store host.
wtCompressionSetting
string
Optional

Compression setting if you use the WiredTiger storage engine for your snaphots.

Ops Manager accepts NONE or GZIP. Ops Manager sets this value to GZIP by default.

If the MongoDB runs FCV 4.2 or later, Ops Manager ignores this setting.

Name
Type
Description
assignmentEnabled
boolean
Flag that indicates whether this file system store can be assigned backup jobs.
id
string
Unique identifier of this file system store.
labels
array of strings
Tags that 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. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

loadFactor
number

Positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. Set this option only if you're using more than one snapshot store.

Tip

See also:

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

mmapv1CompressionSetting
string

Compression setting if you use the MMAPv1 storage engine for your snaphots.

Ops Manager may return NONE or GZIP.

If the MongoDB runs FCV 4.2 or later, Ops Manager ignores this setting.

Important

MongoDB removed support for the MMAPv1 storage engine in MongoDB 4.2. If you edit your deployment's configuration to change your storage engine to WiredTiger Storage Engine, Ops Manager restarts the MongoDB processes.

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

Compression setting if you use the WiredTiger storage engine for your snaphots.

Ops Manager may return NONE or GZIP.

If the MongoDB runs FCV 4.2 or later, Ops Manager ignores this setting.

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}?pretty=true' \
6 --data '{
7 "assignmentEnabled" : true,
8 "labels" : [ "l1", "l2" ],
9 "loadFactor" : 50,
10 "mmapv1CompressionSetting" : "NONE",
11 "storePath" : "/data/backup",
12 "wtCompressionSetting" : "GZIP"
13 }'
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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
1{
2 "assignmentEnabled" : true,
3 "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
4 "labels" : [ "l1", "l2" ],
5 "links" : [ {
6 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}",
7 "rel" : "self"
8 }],
9 "loadFactor" : 50,
10 "mmapv1CompressionSetting" : "NONE",
11 "storePath" : "/data/backup",
12 "wtCompressionSetting" : "GZIP"
13}
← Create One File System Store Configuration