Update (Disaster Recovery Settings)

URL:: https://<root>/system/disasterrecovery/settings/update
Methods:: POST
Required Capability:: Access allowed with the "Security and infrastructure" privilege
Version Introduced:: 10.9

Description

The update operation updates the disaster recovery settings for your deployment. Currently, the only supported setting is stagingVolumeConfig. The stagingVolumeConfig setting must use a storage class to provision a persistent volume for use in backup and restore operations. Starting at ArcGIS Enterprise 11.3 on Kubernetes, static provisioning is supported.

Request parameters

Parameter Details

Parameter	Details
`settings`	A JSON object describing disaster recovery settings. Currently, the only supported setting is `stagingVolumeConfig`, which contains the following editable attributes: `provisioningType`: `DYNAMIC` or `STATIC`. `storageClass`: The storage class to use. `size`: The size for the persistent volume. `labels`: Key-value pair of labels assigned to the persistent volume. Only used when `provisioningType` is `STATIC`. `timeoutInSeconds`: Introduced at 11.0. Defines how long, in seconds, the job should run before timing out. The default property is two hours (7200 seconds). If your deployment has a large amount of content, consider setting the this property to a value larger than two hours. Note If static provisioning is used, you must patch the persistent volume to make it available to be bound to the disaster recovery pod before you run any disaster recovery operations. Dynamic Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 settings={ "stagingVolumeConfig": { "storageClass": "default", "size": "64Gi", "provisioningType": "DYNAMIC" }, "timeoutInSeconds": 7200 }` Static Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 settings={ "stagingVolumeConfig": { "storageClass": "default", "size": "64Gi", "provisioningType": "STATIC", "labels": {"purpose":"backups"} }, "timeoutInSeconds": 7200 }`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

settings

A JSON object describing disaster recovery settings. Currently, the only supported setting is stagingVolumeConfig, which contains the following editable attributes:

provisioningType: DYNAMIC or STATIC.
storageClass: The storage class to use.
size: The size for the persistent volume.
labels: Key-value pair of labels assigned to the persistent volume. Only used when provisioningType is STATIC.
timeoutInSeconds: Introduced at 11.0. Defines how long, in seconds, the job should run before timing out. The default property is two hours (7200 seconds). If your deployment has a large amount of content, consider setting the this property to a value larger than two hours.

Dynamic
Use dark colors for code blocksCopy
settings={
  "stagingVolumeConfig": {
    "storageClass": "default",
    "size": "64Gi",
    "provisioningType": "DYNAMIC"
  },
  "timeoutInSeconds": 7200
}

Static
Use dark colors for code blocksCopy
settings={
  "stagingVolumeConfig": {
    "storageClass": "default",
    "size": "64Gi",
    "provisioningType": "STATIC",
    "labels": {"purpose":"backups"}
  },
  "timeoutInSeconds": 7200
}

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
POST /context/admin/system/disasterrecovery/settings/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

settings={
  "stagingVolumeConfig": {
    "storageClass": "default",
    "size": "64Gi",
    "provisioningType": "DYNAMIC"
  },
  "timeoutInSeconds": 7200
}&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1e

JSON Response example

Use dark colors for code blocksCopy
{"status": "success"}