configurebackuplocation

This utility is used with all ArcGIS Data Store types.

The configurebackuplocation utility allows you to specify the location where ArcGIS Data Store writes backup files for both scheduled backups and backups created with the backupdatastore utility. The configurebackuplocation utility also allows you to alter properties of a backup location and remove a backup location.

Relational stores are created with a default, local backup location. To avoid data loss, configure a default backup location by registering a remote file share using the change option.

Spatiotemporal big data stores, graph stores, and object stores are not created with a default backup location. Before you can begin creating backups, you must run the configurebackuplocation utility with the register option to specify a file share location, an Amazon Simple Storage Service (S3) bucket, or a Microsoft Azure Blob Storage container for these backups.

Note:

You cannot use a local drive for spatiotemporal big data store backup files.

You can register a second backup location to store the backups you create using the backupdatastore utility. You can use a shared file directory, an S3 bucket, or an Azure Blob Storage container for secondary backup locations.

For more information about ArcGIS Data Store backups, see Manage ArcGIS Data Store backups.

Syntax

configurebackuplocation --store {relational | spatiotemporal | graph | object} --operation {change | register | unregister | list | setdefault} [--location "<backup_location_arguments>"] [additional options]

Required options

You must provide the following options when you run the configurebackuplocation utility:

--store {relational | spatiotemporal | graph | object}

Specify the type of ArcGIS Data Store for which you're configuring or querying backup locations. The default value is relational.
--operation {change | register | unregister | list | setdefault}

The --operation option specifies the action that the configurebackuplocation utility will take. The default value is change.

The following is an explanation of each argument you can use with the --operation option:


Option	Description
`change`	Use this argument to change any of the following: Specify a different shared file location for scheduled relational store backups. The location set with the `change` argument is always the default backup location for relational stores. You must provide the `--location` option when you change the default relational store backup location. Alter the name of a backup location. You must provide the `--location` option and its `name` argument when changing a backup location's name. Update the authentication information you set for backup locations on Azure or S3. For S3, you can change the information you previously specified with the `username` and `password` options. For Azure, you can change the `password` value.
`register`	Use this argument to register a backup location. When you use the `register` argument, you must provide the `--location` option. The first backup location you define for a spatiotemporal big data store, graph store, or object store is set as the default backup location. When you register another backup location for a spatiotemporal big data store, object store, or graph store, a secondary backup location is registered. For the relational store, the `register` argument always registers a secondary backup location. The secondary backup location can be used to store manual backups generated with the backupdatastore utility.
`unregister`	Use this argument to remove a secondary backup location from a data store. If only one backup location is registered, the unregister argument completely removes the backup location for a spatiotemporal big data store, object store, or graph store.
`list`	Lists all of the backup locations registered for the data store that you specify with the `--store` option. The list indicates the physical backup location, the backup location's name, and which one is registered as the default backup location.
`setdefault`	If you configured multiple backup locations for the graph store, object store, or spatiotemporal big data store, use the `setdefault` argument to designate one of the backup locations as the default location. This location is where scheduled backups are written, and it is the default location used if you run the backupdatastore, listbackups, or restoredatastore utility without specifying a backup location.

The location option

The --location option is required in the following scenarios:

Specify the backup storage location when you register a backup location or change the default initial backup location for the relational store.
To change the name of an existing backup location, provide name argument and the new name value.

You can use the --location option when you set a default backup location or remove a backup location, or you can use the backup name.

For the spatiotemporal big data store or to register a secondary backup location for the relational store, specify the following arguments with the --location option separated by a semicolon (;) and enclose the entire argument string in double quotation marks ("):

--location "type=fs|s3|azure;location=<backup_location>;[name=<backup_location_name>];[username=<AWS_access_key_ID_or_Azure_account>];[password=<AWS_secret_access_key_or_Azure_account_key>];[endpointsuffix=<Azure_cloud_location> | region=<AWS_region>]".

An explanation of each of the arguments supported with the --location option is provided below:


Argument	Description
`type=`	This argument is required. Define what type of location to use for backups. Specify `fs` to store backups in a file share. For relational stores, the default backup location must be a file share. Specify `s3` to store backups in an Amazon S3 bucket. Specify `azure` to store backups in an Azure Blob Storage container.
`location=`	This argument is required. For file shares, specify the file path. For Amazon S3 buckets, specify the bucket name and path to the bucket. For Blob Storage containers, specify the container name and path to the container. When you use this argument to change the initial default relational store backup location, the location you specify cannot be an existing registered backup location.
`name=`	You can assign a name to the backup location. For example, if your backup location is a file path, such as `\\sharedserver_sharedfolders_datastorebackups`, you can designate a name for this location, such as dsbackupsfolder. When you run the backupdatastore, listbackups, or restoredatastore utility, provide this name instead of the location path. If you do not provide a name when you configure the data store backup location, ArcGIS Data Store assigns a default name.
`username=`	This argument is required if you set the `type=` argument to `azure` or `s3`. For S3 buckets, provide the access key ID for your Amazon Web Services (AWS) account. For Azure Blob Storage containers, provide the name for the Microsoft Azure storage account that can access the Blob Storage container.
`password=`	This argument is required if you set the `type=` argument to `azure` or `s3`. For S3 buckets, provide the secret key for your AWS account. For Azure Blob Storage containers, provide the key for the Azure account you specified with the `username` argument.
`endpointsuffix=`	If you set the `type=` argument to `azure`, you can use the `endpointsuffix` argument to indicate where the Azure Blob Storage container is located. By default, the `endpointsuffix` is assumed to be `core.windows.net`. If your container is in the Microsoft Azure Government cloud environment, set `endpointsuffix=core.usgovcloudapi.net`. If your container is in a private cloud, set `endpointsuffix` to the endpoint suffix of your Azure private cloud.
`region=`	This argument is required when you set the `type=` argument to `s3`. You must supply the region code. For example, set the region to ap-southeast-2 if the bucket is deployed in the Asia Pacific (Sydney) region. Consult AWS documentation for region codes.

Additional options

Additional options you can provide with the configurebackuplocation utility are as follows:


Option	Description
`--force`	Only used with relational stores, this option allows you to change the default backup location even if the existing default backup location is unavailable. Valid values are `true` or `false`. When you change the default backup location for a relational store, ArcGIS Data Store copies the existing backup files from the old location to the new location. If ArcGIS Data Store cannot access the old location, it cannot copy the files. In previous releases, this would cause the configurebackuplocation tool to fail. To proceed with changing the default backup location without copying existing backup files, specify `--force true`. The default value for this option is `false`, which means you cannot change the default backup location if ArcGIS Data Store cannot access the existing default location.
`--prompt`	Valid values are `yes` or `no`. When you run this utility, you are prompted to confirm the action you specified. If you automate the use of this utility, set the `--prompt` option to `no`; otherwise, the script will not proceed until you answer the prompt.

Examples

The following sections provide examples of changing, setting, or listing backup locations for data stores.

Change the default backup location for the relational store

In the first example, the backup location for a relational store is set to a directory named fsdata_bu on a machine named myshare.

./configurebackuplocation.sh --operation change --store relational --location "type=fs;location=/net/myshare/fsdata_bu"
You are going to change the backup location of the data store. Existing backups will be copied to the new location and it could take a few moments.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)? Yes

configurebackuplocation --operation change --store relational --location "type=fs;location=\\myshare\fsdata_bu"
You are going to change the backup location of the data store. Existing backups will be copied to the new location and it could take a few moments.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)? Yes

Add a backup location for the relational store

In this example, a second backup location on Azure is registered for the same relational store.

./configurebackuplocation.sh --operation register --store relational --location "type=azure;location=mybackups;name=secondrelloc;username=myazureaccountlogin;password=zpw4myazureaccount"

configurebackuplocation --operation register --store relational --location "type=azure;location=mybackups;name=secondrelloc;username=myazureaccountlogin;password=zpw4myazureaccount"

You are going to change the backup location of the data store. Existing backups will be copied to the new location and it could take a few moments.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)? Yes

Set a backup location for a graph store

In this example, a backup location on a network share is registered for a graph store. A name, fshare, is assigned to the backup location.

./configurebackuplocation.sh --operation register --store graph --location "type=fs;location=/net/sharedmachine/g_bu;name=fshare" --prompt no

configurebackuplocation --operation register --store graph --location "type=fs;location=\\sharedmachine\g_bu;name=fshare" --prompt no

Add backup locations and set a default location

In this example, a second backup location is specified for the spatiotemporal big data store. The additional backup location is in Azure storage.

./configurebackuplocation.sh --operation register --store spatiotemporal --location "type=azure;location=myblobs;name=mazloc;username=myazureaccountlogin;password=zpw4myazureaccount" --prompt no

configurebackuplocation --operation register --store spatiotemporal --location "type=azure;location=myblobs;name=mazloc;username=myazureaccountlogin;password=zpw4myazureaccount" --prompt no

In this example, a second backup location in the Europe (Spain) region on AWS is specified for the same spatiotemporal big data store. A name, awsloc, is assigned to the backup location.

./configurebackuplocation.sh --operation register --store spatiotemporal --location "type=s3;location=mybucket;name=awsloc;username=abcdefg1234567;password=z9y8x7w6v5u4t3s2r1q0;region=eu-south-2" --prompt no

configurebackuplocation --operation register --store spatiotemporal --location "type=s3;location=mybucket;name=awsloc;username=abcdefg1234567;password=z9y8x7w6v5u4t3s2r1q0;region=eu-south-2" --prompt no

In this example, the S3 bucket is set as the default backup location for the spatiotemporal big data store using the backup location's name (awsloc).

./configurebackuplocation.sh --operation setdefault --store spatiotemporal --location "name=awsloc" --prompt no

configurebackuplocation --operation setdefault --store spatiotemporal --location "name=awsloc" --prompt no

Obtain a list of all backup locations for a data store

In this example, all backup locations for the spatiotemporal big data store are listed.

./configurebackuplocation.sh --operation list --store spatiotemporal

configurebackuplocation --operation list --store spatiotemporal

Backup locations for spatiotemporal big data store:
================================================================
Name             Type     Location                     isDefault
================================================================
fsshare          fs       /net/sharedmachine/ge_bu     false
awsloc           s3       mybucket                     true
mazloc           azure    myblobs                      false

Backup locations for spatiotemporal big data store:
================================================================
Name             Type     Location                     isDefault
================================================================
fsshare          fs       \\sharedmachine\ge_bu        false
awsloc           s3       mybucket                     true
mazloc           azure    myblobs                      false