ArcGIS Data Store utility reference—ArcGIS Enterprise | Documentation for ArcGIS Enterprise

Utilities installed with ArcGIS Data Store provide the data store administrator tools to manage data stores. This page describes the utilities and provides syntax and examples for each.

All utilities must be run on the ArcGIS Data Store machine. You can find the utilities in the <ArcGIS Data Store installation directory>\datastore\tools directory.

Type the utility name followed by --help to get syntax assistance.

Note:

Your login must be a member of the Windows Administrator group, and you must open the Command Prompt with the Run as Administrator option to use the ArcGIS Data Store utilities.

allowconnection

This utility is used with relational data stores.

For security reasons, all connections to the data store are made through the GIS Server site by default. If you want to open a relational data store for connections from an additional machine, you can use the allowconnection utility.

You can run the allowconnection utility on the primary relational data store machine only.

Syntax

allowconnection <host name> <username> [<database>]

Specify the name of the computer you want to allow to connect to the relational data store (host name) and one of the database accounts used by the data store (username): either the data store administrator, replica owner, geodatabase administrator, or managed user (the user who publishes feature layer data), which you can obtain using the listadminusers or listmanageduser utility. You can also specify the name of the primary relational data store database but, since there is only one, this value is optional.

Example

In this example, a connection is allowed from the workcom computer to the relational data store when connecting as the hqo.n_1E7 managed user.

allowconnection workcom hqo.n_1E7

backupdatastore

This utility is used with all data store types.

Use this utility to create a full backup of a data store between scheduled backup times. For example, create a backup of each data store prior to upgrading ArcGIS Data Store or before making a large number of changes to a data store.

The backupdatastore utility can be run for only one data store type at a time.

The following table indicates where to run the backupdatastore utility and what the utility does for each data store type:


Data store type	Machine	Behavior
Relational data store	Run the backupdatastore utility on the primary relational data store machine.	The backupdatastore utility always creates a full backup of the relational data store.
Tile cache data store	The backupdatastore utility can be run on any machine in the tile cache data store.	The first time you run the backupdatastore utility for a tile cache data store after setting a backup location, backup copies are made of all existing tile cache data store databases. Subsequent use of the backupdatastore utility creates backup copies of any tile cache data store databases created since the last time you ran the utility.
Spatiotemporal big data store	The backupdatastore utility can be run on any machine in the cluster.	The first time you run the backupdatastore utility for a spatiotemporal big data store after setting a backup location, a full backup is created. Subsequent use of the backupdatastore utility creates a backup file containing only the changes since the initial full backup.
Object store	The backupdatastore utility can be run on any machine in the cluster.	The backupdatastore utility always creates a full backup of the object store for video service data. Feature layer query caches are not included in the backup file.
Graph store	The backupdatastore utility can be run on either machine in the graph store.	The backupdatastore utility always creates a full backup of the graph store.

Before you run the backupdatastore utility, ensure that the backup location for the data store is large enough to accommodate backups. To change data store backup locations, use the configurebackuplocation utility.

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

Syntax

backupdatastore [<backup file name>] [--store {relational | tileCache | spatiotemporal | graph | object}] [--location <backup_arguments>] [--prompt {yes | no}]

You must provide a name for the backup file.

If you do not specify the --store option, the relational value is assumed.

If you do not specify the --location option, backup files are written to the data store's default backup location.

To specify one of the other registered backup locations instead, use the --location option. You can either provide the backup name or the backup type and location. When you use the type= and location= arguments, separate them by a semicolon (;).

Supported arguments for the --location option are as follows:


Argument	Description
name=	You can use the backup location name to indicate the registered backup location. If you specify a name, you do not need to use the type= and location= arguments.
type=	If you do not specify a backup location name, you must specify the backup location type and physical location. Type values and their descriptions are as follows: fs—A file share s3—An Amazon Simple Storage Service (S3) bucket azure—A Microsoft Azure Blob storage container
location=	Use the location= argument to indicate the physical location of the registered backup location. This argument must be used with the type= argument. For file shares, provide the file path. For S3 buckets, provide the bucket name. For Azure Blob storage containers, provide the container name.

Examples

In this example, the backupdatastore utility creates a full backup file named project1bu in the default backup location of the relational data store. By including --prompt no, the utility does not prompt for a confirmation response.

backupdatastore project1bu --prompt no

In this example, a backup file named localbu5 is created for the spatiotemporal big data store in a file share location, which you named gadbu when you configured the backup location.

backupdatastore localbu5 --store spatiotemporal --location name=gadbu

You are going to back up the data store. This could take some time, depending on the size of your data store.
Please do not interrupt the process once it has started.

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

In this example, a backup is created of a spatiotemporal big data store in an Azure Blob storage container named blob4backups, and the backup file created is named spds311016:

backupdatastore spds311016 --store spatiotemporal --location type=azure;location=blob4backups

You are going to back up the data store. This could take some time, depending on the size of your data store.
Please do not interrupt the process once it has started.

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

changedatastoremode

This utility is used with relational and spatiotemporal big data stores.

The changedatastoremode utility allows you to place a relational data store in read-only mode while you perform maintenance on the data store. For example, if you need to perform a maintenance task that will cause the data store to restart, such as changing the backup location from one drive to another drive or changing database properties, you can place the relational data store in read-only mode so no users are in the process of publishing or editing data when the data store restarts.

The changedatastoremode utility is also used to place the relational data store back in a read-write mode after you finish maintenance or after you add enough disk space to the primary data store machine to allow the data store to function properly in read-write mode.

You must run the changedatastoremode utility on the primary relational data store machine, not the standby machine.

When your spatiotemporal big data store gets close to running out of disk space, ArcGIS Data Store places it in read-only mode to avoid data corruption. You can use the changedatastoremode utility to return a spatiotemporal big data store to read-write mode after you have added sufficient disk space to the spatiotemporal big data store machines.

Note:

If ArcGIS Data Store places the data store in read-only mode due to insufficient disk space, automatic backups are also disabled to avoid filling the disk further. Therefore, you must reset your automatic backup schedule using the updatebackupschedule utility after you place the data store back in read-write mode.

Syntax

changedatastoremode {readonly | readwrite} [--prompt {yes | no}] --store {relational | spatiotemporal}

Examples

In this example, the relational data store is placed in read-only mode, meaning clients cannot perform such activities as publishing hosted feature layers to ArcGIS Enterprise or editing data through a hosted feature layer. The --prompt option is provided to suppress the confirmation prompt.

changedatastoremode readonly --store relational --prompt no

To place a spatiotemporal big data store in read-write mode after you add disk space to the machines, specify the readwrite option and specify spatiotemporal with the --store option as shown in the following example:

changedatastoremode readwrite --prompt no --store spatiotemporal

changedbproperties

This utility is used with relational, tile cache, and spatiotemporal big data stores.

The changedbproperties utility allows you to change various properties depending on the type of data store you run it against.

Syntax

changedbproperties --store {relational | tileCache | spatiotemporal} [configuration options]

You must provide the --store option and at least one configuration option. The following are supported configuration options, their descriptions, and the data store type with which each option can be used:


Configuration option	Description	Supported data store type
--disk-threshold-readonly	This option controls when a relational data store will be placed in read-only mode to avoid loss of data due to insufficient disk space. Specify sizes in MB. The default disk space value is 1024 MB.	Relational data store only
--max-connections	Use this parameter to specify the maximum number of connections allowed to a relational data store. Relational data stores accept up to 150 connections by default. Use the --max-connections property to change the number of connections allowed. Take into consideration that ArcGIS Data Store internal processes can take up to five connections. Also consider how many concurrent connections the ArcGIS Data Store machine can accept and continue to perform well. If the machine running ArcGIS Data Store doesn't have a lot of memory, you may need to decrease the number of connections allowed. The number you specify cannot be less than 10. When you change the maximum number of connections allowed, the number is changed on both the primary and standby data store machines.	Relational data store only
--pitr	This option indicates whether ArcGIS Data Store creates incremental backups of the relational data store, thereby allowing you to recover the relational data store to a point in time. Possible arguments for this option are enable or disable.	Relational data store only The default setting is --pitr disable. Note: You must set the --pitr option to enable if you will use the webgisdr utility—which is installed with Portal for ArcGIS—to create incremental backups of your ArcGIS Enterprise deployment.
--enablessl	This option controls use of the Transport Layer Security (TLS) protocol when populating the tile cache data store and for communication between the relational data store and the hosting server. Supported arguments for the --enablessl parameter are as follows: true—This is the default setting. The Transport Layer Security protocol will be used when writing scene layer data to the tile cache data store when you specify --store tileCache and when communicating between the relational data store and hosting server when you specify --store relational. false—Specify false and --store tileCache to use HTTP communication from the hosting server when writing to the tile cache data store. Specify false and --store relational to use HTTP communication between the hosting server and relational data store.	Relational and tile cache data stores
--heap-size	Use this parameter to change the amount of heap memory (in MB) used by a spatiotemporal big data store. By default, this type of data store will use half the RAM on the machine (up to 70 percent of free RAM) when it starts. You can change the heap size to an amount between 512 MB and 32,000 MB, but ensure the amount you specify does not exceed the amount of RAM available on the machine.	spatiotemporal big data store
--rebalance	By default, this option is set to true, which means the spatiotemporal big data store distributes data to other machines if any one machine is unavailable. If you need to perform maintenance on one spatiotemporal big data store machine, such as upgrading it, you can temporarily shut off rebalancing by specifying --rebalance false. The rebalance option will be suspended for the number of minutes set for the --max-rebalance-off parameter.	spatiotemporal big data store
--max-rebalance-off	This option is used in combination with the --rebalance option to indicate how long rebalancing will remain suspended. By default, --max-rebalance-off is set to 60 minutes. That means if you temporarily shut off rebalancing, it will start again after 60 minutes. If you need more or less time than that to perform the maintenance task for which you suspended rebalancing, change the time setting for --max-rebalance-off.	spatiotemporal big data store
--prompt	When you run this utility, you are prompted to confirm the action you specified. If you automate the use of this utility, specify --prompt no; otherwise, the script will not proceed until you answer the prompt.	relational, tile cache, and spatiotemporal big data stores

Examples

The following sections include examples of using the options available with the changedbproperties utility.

Change the read-only threshold for the relational data store

By default, the relational data store is placed in read-only mode when free disk space drops to 1,024 MB. In the following example, there are other apps writing to the machine, so the administrator configures the relational data store to be placed in read-only mode sooner: when free disk space on the machine drops to 4,000 MB:

changedbproperties --store relational --disk-threshold-readonly 4000

You are changing the following database properties:
         ...disk space threshold to change relational data store into READONLY mode to 4000MB)

Changing database configurations could cause the database to restart. Please do not interrupt the process once it has started.

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

Change the number of connections allowed to the relational data store

In this example, the number of maximum connections allowed to a relational data store is set to 100:

changedbproperties --store relational --max-connections 100

You are changing the following database properties:
         ...max number of connections to 100 (on all relational data store machines)

Changing database configurations could cause the database to restart. Please do not interrupt the process once it has started.

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

Enable point-in-time recovery for the relational data store

By default, point-in-time recovery is disabled. In this example, point-in-time recovery is enabled for the relational data store:

changedbproperties --store relational --pitr enable

You are changing the following database properties:
         ...enable point-in-time recovery for relational store

Changing database configurations could cause the database to restart. Please do not interrupt the process once it has started.

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

Disable SSL

By default, the relational data store communicates with the hosting server over HTTPS. In this example, the --enablessl parameter is used to configure the relational data store to communicate with the hosting server over HTTP.

changedbproperties --store relational --enablessl false

You are changing the following database properties:
         ...disable ssl for relational store

Changing database configurations could cause the database to restart. Please do not interrupt the process once it has started.

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

Change the heap size for the spatiotemporal big data store

By default, the spatiotemporal big data store uses half the RAM on the machine (and 70 percent of free RAM) when it starts.

Caution:

Decreasing the heap size could prevent the data store from starting. If you increase the heap size, do not specify a number that exceeds the amount of RAM available on the machine.

In this example, the heap size is set to 1,600 MB.

changedbproperties --store spatiotemporal --heap-size 1600

You are changing the following database properties:
         ...heap size for spatiotemporal store to 1600MB (on current machine)

Changing database configurations could cause the database to restart. Please do not interrupt the process once it has started.

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

Pause rebalancing for the spatiotemporal big data store

In this example, the administrator needs to perform a brief maintenance procedure on one machine in a spatiotemporal big data store and does not want the data store to rebalance. To do this, the --rebalance and --max-rebalance-off options are used to suspend rebalancing for 30 minutes. After 30 minutes, the spatiotemporal big data store will automatically change rebalance to true.

Because this must happen periodically, the administrator keeps the following statement in a script and sets the prompt option to no.

changedbproperties --store spatiotemporal --rebalance false --prompt no

changedbproperties --store spatiotemporal --max-rebalance-off 30 --prompt no

changeloglocation

This utility is used with all data store types.

The default error log file location for ArcGIS Data Store is <ArcGIS Data Store directory>\arcgisdatastore\logs. To use a different file directory, run the changeloglocation utility and specify the new directory path.

The ArcGIS Data Store account must have write privileges to the directory you specify.

Syntax

changeloglocation <directory path>

Example

In this example, log files will be created in the local directory, d:\datastorefiles\logs.

changeloglocation 'd:\datastorefiles\logs'

changenosqldslocation

This utility is used with tile cache data stores.

Tile cache data stores can get large if you store a lot of high-resolution tiles in it. In those cases, you may want to move the data to another drive on the same server or to a shared location on a different server.

If you move the data to a shared directory, you must grant read and write permissions on the directory to the ArcGIS Data Store account.

Syntax

changenosqldslocation <path> [--prompt {yes | no}]

Example

In this example, the databases that store scene layer caches will be created in a shared directory named dstorecache on machine server2.

changenosqldslocation \\server2\dstorecache --prompt no

changepassword

This utility is used with relational data stores.

ArcGIS Data Store randomly generates usernames and passwords for the database accounts used for relational data stores. If your site requires you to set your own passwords, obtain the passwords for relational data store accounts and run changepassword to reset them.

Use the listadminusers utility to get usernames and passwords for administrator users and the listmanageduser utility to get the username and password for the feature data owner.

The changepassword utility must be run on the primary relational data store machine. To identify which is the primary machine, run the describedatastore utility.

Syntax

changepassword <username> <new password> [--prompt {yes | no}]

Example

In this example, the password is changed for user gwi_n2Te0 to Phfl4mp!.

changepassword gwi_n2Te0 Phfl4mp

You are going to change the password for user gwi_n2Te0.
Do you want to continue (Yes or No)?Yes

If you need to script password changes, include a flag to suppress the confirmation prompt, as in the following example:

changepassword gwi_n2Te0 Phfl4mp --prompt no

changestaginglocation

This utility is used with relational data store, tile cache data store, and graph store.

When you restore the relational or tile cache data store, ArcGIS Data Store extracts the compressed backup files on a staging location. That means you must have a staging location that can accommodate this uncompressed data. By default, that location is in the ArcGIS Data Store data directory. If there is a lot of data in the relational or tile cache data store, set up a separate staging location and specify that for recovery.

Similarly, if you define an S3 bucket or an Azure Blob storage container for relational data store, tile cache data store, or graph store backup files, the staging location is used to package the backup files before copying them into the cloud storage location.

Syntax

changestaginglocation <directory path>

Example

In this example, the designated staging location is \\netserver\rbustage.

changestaginglocation \\netserver\rbustage

configurebackuplocation

This utility is used with all 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 data 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.

Tile cache data stores created in primary-standby mode have a default backup location; tile cache data stores created in cluster mode do not. In either case, use the configurebackuplocation utility with the register option to specify a shared network location, an Amazon Simple Storage Service (S3) bucket, or a Microsoft Azure Blob storage container to securely store tile cache data store backups. You cannot use a local drive for tile cache backup files if the data store is running in cluster mode.

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 | tileCache | 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 | tileCache | 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 configurebackuplocaton 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 data store backups. The location set with the change argument is always the default backup location for relational data stores. You must provide the --location option when you change the default relational data 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 a tile cache data store running in cluster mode is set as the default backup location. When you register another backup location for a tile cache data store (primary-standby or cluster mode), spatiotemporal big data store, or graph store, a secondary backup location is registered. For the relational data 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 tile cache or spatiotemporal big data store or a 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 a graph store, tile cache data 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 backup location for the relational data 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 tile cache data stores or spatiotemporal big data stores, or to register a secondary backup location for a relational data 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 data 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.
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	Used only with relational data 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 data 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. If you want 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 data store

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

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 data store

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

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 --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 --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 --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 --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 --operation list --store spatiotemporal

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

configuredatastore

This utility is used with all data store types.

After you install ArcGIS Data Store, you can run the configuredatastore utility rather than run the Data Store configuration wizard to create a data store and register it with a GIS Server site. You can create the following types of data stores using this utility:

Additional uses for the configuredatastore utility are as follows:

Upgrade a data store after updating the ArcGIS Data Store software on all machines in the data store.
Designate the role of a machine in a spatiotemporal big data store.

Syntax

configuredatastore <ArcGIS Server admin URL> <ArcGIS Server administrator> <ArcGIS Server administrator password> <data directory> [--stores {relational | tileCache | spatiotemporal | graph | object}] [--mode {singleInstance | primaryStandby | cluster}] [--roles {coord | data}]


Option	Description
<ArcGIS Server admin URL>	This is the GIS Server site that is used or will be used as the ArcGIS Enterprise hosting server. The ArcGIS Server admin URL is in the format https://gisserver.domain.com:6443. Note: Even if the GIS Server site uses a web adaptor or load balancer, you must provide the URL in the aforementioned format.
<ArcGIS Server administrator>	Provide the username for a built-in (not organization-specific) user who has administrator privileges in the hosting GIS Server site.
<ArcGIS Server administrator password>	Provide the password for the account used above.
<data directory>	The data directory is the location on the local machine where data store files will be created.
--stores	This option indicates the type of ArcGIS Data Store to configure. Valid values are as follows: relational tileCache spatiotemporal graph object If you do not specify the --stores option, the relational value is assumed.
--mode	This optional option applies to tile cache data stores and object stores only. Valid values are singleInstance, primaryStandby, or cluster. If you do not specify a mode, tile cache data stores are created in primaryStandby mode, and object stores are created in singleInstance mode. Tile cache data stores created in primaryStandby mode can contain two machines. If you need the tile cache data store to scale to include three or more machines, create a tile cache data store in cluster mode. You can use the --mode option to switch the tile cache data store from primaryStandby mode to cluster mode. Object stores created in singleInstance mode can contain only one machine. If you need high availability, deploy the object store in cluster mode. When used in cluster mode, the object store must contain at least three machines. The primaryStandby mode no longer applies to object stores. You cannot change modes for an object store. See Add machines to a data store for details.
--roles	This optional option applies to multiple machine spatiotemporal big data stores only. Supported values are coord, data, or coord,data. Spatiotemporal big data store machines can be created in either role or both roles. To deploy a machine in both roles, separate the two roles with a comma; for example, specify --role coord,data when you run the configuredatastore utility to create a spatiotemporal big data store on a machine. For a description of each role—coordinator and data—see Add machines to a data store. You can also run the configuredatastore utility with the --roles option to change the role of an existing spatiotemporal big data store machine.

Configure a specific type of data store

You specify the type of data store to create using the --stores option, as indicated above. Use the following links for a description of each type of data store:

To configure more than one data store type on the same machine, separate the types with a comma (no spaces). For example, to configure both a relational and tile cache data store on the same machine, specify --stores relational,tileCache.

Note:

Data stores configured on the same machine compete for memory and other resources, negatively affecting performance and possibly causing the data stores to stop working. This is especially true for spatiotemporal big data stores, graph stores, and object stores; do not configure a spatiotemporal big data store, graph store, or object store on the same machine as another data store or other ArcGIS component.

If you script the creation of multiple spatiotemporal big data store machines, one spatiotemporal big data store machine must be manually configured with the GIS Server site before you can script the creation of additional spatiotemporal big data store machines. Include wait times in your script to be sure the additional spatiotemporal big data store machines are not added at the same time.

Each data store type has a default mode in which it is created. You can specify a different mode when you create a tile cache data store or object store.

See Create a data store for instructions.

Configure data stores after updating ArcGIS Data Store installations

As part of upgrading ArcGIS Data Store, you must reconfigure the existing data store machines. After you install a new version of ArcGIS Data Store over the existing ArcGIS Data Store on every data store machine, log in to any machine in a data store and run the configuredatastore utility to finish upgrading that particular data store type. For example, run configuredatastore on the primary relational data store machine, and the standby machine will also be upgraded.

If a machine contains both a relational and tile cache data store, specify --stores relational,tileCache when you run the configuredatastore utility, and it updates all the machines in both data stores.

To reconfigure updated spatiotemporal big data store machines, log on to any of the machines in the spatiotemporal big data store and run the configuredatastore utility. This updates all machines in the spatiotemporal big data store.

Configuration cannot proceed until you install the new version of ArcGIS Data Store on all machines in the ArcGIS Enterprise deployment.

See Upgrade ArcGIS Data Store for more information.

Changing tile cache data store mode

To determine the current mode set for a tile cache data store, run the describedatastore utility on the tile cache data store machine.

If you need to change the tile cache data store mode from primaryStandby to cluster mode, run the configuredatastore utility with the --mode option set to cluster.

Note:

You can use the --mode option to specify the tile cache data store or object store mode when creating the data store or to change the mode of the tile cache data store from primaryStandby to cluster mode, but you cannot change the mode when upgrading a tile cache data store, you cannot change the tile cache data store mode from cluster to primaryStandby, and you cannot change the mode of any other type of data store.

Changing the spatiotemporal big data store machine role

Every spatiotemporal big data store cluster must have a machine in the coordinator role that acts as the current coordinator of all the other machines in the cluster. The first machine you create in a spatiotemporal big data store must include the coordinator role, and this first machine is the current, active coordinator. To ensure that the cluster continues to work even when the current coordinator machine fails, the cluster must have at least two other machines that have the coordinator role assigned to them.

A spatiotemporal big data store cluster must also have at least one machine in the data role.

Roles are assigned to the machines when you add them to the cluster, as described in Add machines to a data store. Machines that are eligible to be a coordinator can be changed to store data only. Machines that are currently only in the data role can have the coordinator role added to them.

Supported role changes are as follows:

Specify --roles data to change a coordinator to a data machine. This is possible if there are other coordinator-eligible machines in the cluster. You can change a coordinator machine to a data role if there are at least three other coordinator-eligible machines in the cluster.
Specify --roles data to remove the coordinator role from a machine that was deployed with both roles. This leaves the machine in the data role. You can remove the coordinator role from the machine if there are at least three other coordinator-eligible machines in the cluster.
Specify --roles coord,data to add the coordinator role to a machine that was initially deployed to fill only the data role. A maximum of five machines can include the coordinator role. If there are already five coordinator machines in the cluster, you cannot add the coordinator role to a data machine in the cluster.

Tip:

Before you change a machine's role, run the describedatastore utility on one of the machines to identify what role is assigned to each machine in the spatiotemporal big data store cluster.

Examples

In this example, a data store for hosted feature layer data (relational data store) is created. The URL for the GIS Server site that will use the data store is https://gisserver.domain.com:6443, the site administrator username and password are admin and Iph33l$ik, respectively, and the data directory for the data store is C:\datastore\data\.

configuredatastore https://gisserver.mydomain.com:6443 admin Iph33l$ik c:\datastore\data\ --stores relational --prompt no

In the following example, an existing tile cache data store (primary-standby) is changed to cluster mode:

configuredatastore https://gisserver.mydomain.com:6443 admin Iph33l$ik c:\datastore\scenedata\ --stores tileCache --mode cluster --prompt no

In the next example, one of the data-only machines in a spatiotemporal big data store cluster has the coordinator role added to it, making it eligible to act as the coordinator if the current coordinator machine fails.

configuredatastore https://gisserver.mydomain.com:6443 admin Iph33l$ik c:\datastore\scenedata\ --stores spatiotemporal --roles coord,data --prompt no

configureserviceaccount

This utility is used with all data store types on Microsoft Windows servers.

The configureserviceaccount utility changes the login used for the ArcGIS Data Store account on a single Windows machine.

When you set the account using this utility, you can export the account information to a file. The password is encrypted in the file. You can use this file to import the same account information if, for example, you set up another ArcGIS Data Store and want to use the same account. In that case, run the configureserviceaccount utility on the new machine and import the file with the account information.

You can also use this utility to update the password of the ArcGIS Data Store account. If the password for the Windows account changes, run the utility and specify a new password for the account.

If you set the ArcGIS Data Store account to a group managed service account, the account you specify with the username parameter can include $ at the end of the account name or omit it. You do not need to specify the password parameter when you use a group managed service account.

When you update the account, you must update it for every machine in the data store. For example, if you update the account for a three node spatiotemporal big data store, you must run the configureserviceaccount utility on all three machines

Syntax

configureserviceaccount [--username <Windows account>] [--password <account password>] [--readconfig <user configuration file>] [--writeconfig <user configuration file>]


Option	Description
--username	The network login or group managed service account used for the ArcGIS Data Store account. This option is not required if you use the --readconfig option.
--password	The password for the network login that you specified with the --username option. To change the password for the existing ArcGIS Data Store account, run the configureserviceaccount utility with the --username option and specify the new password with the --password option. This option is not required if you use the --readconfig option or if you specify a group managed service account with the --username option.
--writeconfig	If included when you run the configureserviceaccount utility, this option creates a configuration file containing the credentials provided. Password information is encrypted in the file.
--readconfig	Configures the ArcGIS Data Store account using information stored in a configuration file that was created using the --writeconfig option. When you use this option, no other options are required.

Example

In this example, configureserviceaccount sets the mynetwork\datastore account to run the ArcGIS Data Store service and grants this account the privileges required on ArcGIS Data Store system folders and files.

configureserviceaccount --username mynetwork\datastore --password SewL0ng

In this example, a group managed service account is used for the ArcGIS Data Store account and the information is written to a configuration file in the temp directory:

configureserviceaccount --username mydomain\datastore-gmsa$ --writeconfig c:\temp\domainaccountconfig.xml

Note:

Changing the account under which the service runs causes the service to restart.

In this example, the ArcGIS Data Store account is changed, and the account information is written to a file (adsainfo) at C:\adminfiles.

configureserviceaccount --username mynetwork\datastore --password SewL0ng --writeconfig C:\adminfiles\adsainfo.xml

In this example, ArcGIS Data Store is installed on a different machine, and the administrator runs the configureserviceaccount utility to set the same account using the file created in the previous example.

configureserviceaccount --readconfig C:\adminfiles\adsainfo

deletebackup

This utility is used with relational data stores and object stores.

The deletebackup utility allows you to delete backup files you created for relational data stores or object stores. First, run the configurebackuplocation utility with the --operation option set to list to get a list of all backup locations configured for the data store. Next, run the listbackups utility with one of the locations to see the names and creation times of the backups in that location. Repeat that step for every backup location. You can then run the deletebackup utility to delete the backup files you no longer need. You must run deletebackup separately for each location from which you want to delete backup files.

Note:

You can only delete backups that are not required to recover your data store. For example, you cannot delete the most recent full backup of a relational data store.

Syntax

deletebackup <backup name> [--store {relational | object}] [--location "<backup-location>"] [--prompt {yes | no}]

Example

In the following example, the relational data store backup named featuresMarchbu is deleted from the default backup location.

deletebackup featuresMarchbu --store relational

You are attempting to delete backup 'featuresMarchbu'. This operation is irreversible.

Do you wish to continue (Yes or No)?yes

Operation completed successfully

In this example, the june-videobu of the object store is deleted from the backup location named videobucket.

deletebackup june-videobu --store object -- location "videobucket"

You are attempting to delete backup 'june-videobu'. This operation is irreversible.

Do you wish to continue (Yes or No)?yes

Operation completed successfully

describedatastore

This utility is used with all data store types.

The describedatastore utility provides information about an ArcGIS Data Store installation. It reports what data store types are installed on the machine where you run the utility and provides information about each data store type on the machine.

Note:

If a data store is installed on the machine but not configured, it will show up as an available ArcGIS Data Store, but no additional information will be returned for that data store type.

Some information is common to all data store types, and some is specific to a type of data store. The following tables list and explain the properties returned by the describedatastore utility:

General properties

The values for these properties are the same for all data store types installed on the machine.


Property	Description
ArcGIS Data Store release	The software release number for the ArcGIS Data Store installation.
Staging location	For relational and tile cache data stores, the staging location is where ArcGIS Data Store extracts the compressed backup files before restoring the data store. If a data store has a cloud storage location configured for backups, backup files are first placed in the staging location before they are copied to the cloud storage location. To change the staging location, use the changestaginglocation utility.
Log location	The file directory to which ArcGIS Data Store writes log files. To change the log file location, use the changeloglocation utility.
Free disk space	The amount of available disk space left on the machine where ArcGIS Data Store is installed.

Common properties

These properties appear for each data store type, but their values are specific to the data store for which they are listed.


Property	Description
Backup location	The default backup location used by each type of data store.
Backup schedule	For automated backups, how often a backup is created of each type of data store.
Data store status	Indicates whether the data store is running.
Owning system URL	The hosting GIS Server site with which the data store is registered. This is usually the same hosting server for all the data stores on the machine; however, it is possible to have data stores on the same machine that are used with different ArcGIS Enterprise deployments.
Portal for ArcGIS URL	This is usually the same Portal for ArcGIS URL for all the data stores on the machine; however, it is possible to have data stores on the same machine that are used with different ArcGIS Enterprise deployments.
Registered machines	A list of all machines in the specific data store type. This property lists all machines regardless of their status.

Relational data store properties

These properties are specific to a relational data store deployment.


Property	Description
Days backup retained	The number of days that relational data store backup files are retained before ArcGIS Data Store deletes them.
Is point-in-time-recovery enabled	Indicates whether the relational data store is configured to create incremental backups, which allow you to restore it to a specific point in time. This setting is configured using the changedbproperties utility.
SSL enabled	Indicates whether SSL communication is enabled.
Threshold for READONLY mode	The free disk space threshold at which the relational data store will be placed in read-only mode. You can change this value for the relational data store using the changedbproperties utility.
Maximum connections	Indicates the maximum allowed number of connections to the relational data store.
Number of connections	The number of current feature layer connections to the relational data store.
Data store mode	Indicates whether the data store is in read-write or read-only mode.
Last failover	This property reports the most recent date and time that the primary machine failed, resulting in the standby machine being promoted to the primary role. This property is not listed if the data store has never failed over.

Tile cache data store properties

These properties are specific to a tile cache data store deployment.


Property	Description
Member machines	If the tile cache data store is deployed in cluster mode, this property provides a list of the active and available machines in the cluster.
Last failover	For tile cache data stores running in primary-standby mode, this property reports the most recent date and time that the primary machine failed, resulting in the standby machine being promoted to the primary role. This property is not listed if the data store has never failed over.
Deployment mode	Indicates whether the tile cache data store is running in primary-standby or cluster mode.
SSL enabled	Indicates whether SSL communication is enabled.

Spatiotemporal big data store properties

These properties are specific to a spatiotemporal big data store deployment.


Property	Description
Is cluster finalized	Indicates whether the cluster contains the required minimum number of coordinator and data machines.
Automatic rebalance	If this property value is set to on, the spatiotemporal big data store distributes data to other machines if any one machine is unavailable. If this property value is set to off, data will not be redistributed if a machine is unavailable. This setting is changed using the changedbproperties utility.
Max rebalance off time	When you disable rebalancing (in which case, the Automatic rebalance property value will be set to off), it is only disabled for the number of minutes indicated by this property. At the end of this period of time, the Automatic rebalance property value will be set to on. This setting is changed using the changedbproperties utility.
Threshold for READONLY mode	The free disk space threshold at which the spatiotemporal big data store will be placed in read-only mode.
Member machines	A list of the active and available machines in the spatiotemporal big data store cluster.
Data store mode	Indicates whether the data store is in read-write or read-only mode.
Current coordinator machine in cluster	The machine in the spatiotemporal big data store that is currently acting as the coordinator of all machines in the cluster.
Coordinator candidate machines in spatiotemporal cluster	Machines in the spatiotemporal big data store that have the coordinator role assigned and, therefore, can become the current coordinator.
Data machines in spatiotemporal cluster	Machines in the spatiotemporal big data store that are assigned the data role.

Graph store properties

These properties are specific to a graph store deployment.


Property	Description
Deployment mode	Indicates whether the data store was deployed in single instance or cluster mode.
Last failover	This property reports the most recent date and time that the primary machine failed, resulting in the standby machine being promoted to the primary role. This property is not listed if the data store has never failed over.

Object store properties

These properties are specific to an object store deployment.


Property	Description
Deployment mode	Indicates whether the data store was deployed in single instance or cluster mode. Object stores created prior to ArcGIS Data Store 11.1 will report primary-standby mode but can contain only one machine.

Syntax

describedatastore

Example

The describedatastore utility returns general information that applies to all data stores on a machine and returns separate sections that contain information specific to each type of data store.

You should have different data stores on different machines, but to allow you to see the information returned for each type, the following output shows a machine that has all ArcGIS Data Store types on the same machine. The first two sections (Available ArcGIS Data Stores and General Information) are always returned. The data store sections returned by describedatastore vary depending on what type of data store is present on the machine where you run the utility.

describedatastore

Available ArcGIS Data Stores
==============================================================
Relational Data Store
Tile Cache Data Store
Spatiotemporal Big Data Store
Graph Store
Object Store

General Information of ArcGIS Data Store on machine.domain.com
==============================================================
ArcGIS Data Store release....11.3.0.1234
Staging location.............C:\arcgisdatastore\staging
Log location.................C:\arcgisdatastore\logs
Free disk space..............174.00GB

Information for relational data store ds_sthiu0_5T
==============================================================
Backup location..............\\nwshare\dsbackups
Backup schedule..............{"schedule-starttime":"00:00:00","schedule-frequency":"Every 7 DAYS"}
Days backup retained.........31
Data store status............Started
SSL enabled..................true
Last failover................20150130190334005
Threshold for READONLY mode..2048MB
Registered machines..........MACHINE1.DOMAIN.COM, MACHINE4.DOMAIN.COM
Maximum connections..........150
Owning system URL............https://gisserver_webadaptor.domain.com/server
Portal for ArcGIS URL........https://portal_webadaptor.domain.com/portal
Number of connections........8 connection(s) to managed database
Data store mode..............READWRITE
Is point-in-time recovery enabled...No

Information for tile cache data store ds_wztxj7um
==============================================================
Data location..............C:\arcgisdatastore\nosqldata
Data store status..........Started
Backup location............\\mybackups\scenebackup
Backup schedule............{"schedule-starttime":"01:00:00","schedule-frequency":"Every 1 DAYS"}
Deployment mode............cluster
SSL enabled................true
Member machines............MACHINE1.DOMAIN.COM, MACHINE2.DOMAIN.COM, MACHINE3.DOMAIN.COM
Registered machines........MACHINE1.DOMAIN.COM, MACHINE2.DOMAIN.COM, MACHINE3.DOMAIN.COM
Owning system URL..........https://gisserver_webadaptor.domain.com/server
Portal for ArcGIS URL......https://portal_webadaptor.domain.com/portal

Information for spatiotemporal data store ds_qpko99Cl
==============================================================
Is cluster finalized................Yes
Max rebalance off time..............60 minutes
Automatic rebalance ................On
Threshold for READONLY mode.........1024MB
Backup location.....................\\nwshare2\sbds_bu
Backup schedule.....................{"schedule-starttime":"02:00:00","schedule-frequency":"Every 2 DAYS"}
Member machines.....................MACHINE1.DOMAIN.COM, MACHINE2.DOMAIN.COM, MACHINE3.DOMAIN.COM
Coordinator candidate machines in spatiotemporal cluster..MACHINE1.DOMAIN.COM, MACHINE2.DOMAIN.COM, MACHINE3.DOMAIN.COM
Current coordinator machine in cluster......MACHINE1.DOMAIN.COM
Data machines in spatiotemporal cluster.....MACHINE1.DOMAIN.COM, MACHINE2.DOMAIN.COM, MACHINE3.DOMAIN.COM
Registered machines.................MACHINE1.DOMAIN.COM, MACHINE2.DOMAIN.COM, MACHINE3.DOMAIN.COM
Owning system URL...................https://gisserver_webadaptor.domain.com/server
Portal for ArcGIS URL...............https://portal_webadaptor.domain.com/portal
Data store mode.....................READWRITE

Information for graph store x2b7s0n
==============================================================
Deployment mode.............primaryStandby
Backup location.............\\nwshare3\graphbu
Backup schedule.............{"schedule-starttime":"03:00:00","schedule-frequency":"Every 3 DAYS"}
Registered machines.........MACHINE1.DOMAIN.COM
Owning system URL...........https://gisserver_webadaptor.domain.com/server
Portal for ArcGIS URL.......https://portal_webadaptor.domain.com/portal

Information for object store w1tiknx
==============================================================
Deployment mode.............singleInstance
Backup location.............\\nwshare4\myfiles\ods_bu
Backup schedule.............{"schedule-starttime":"04:00:00","schedule-frequency":"Every 2 DAYS"}
Registered machines.........MACHINE1.DOMAIN.COM
Owning system URL...........https://gisserver.domain.com:6443/server/admin
Portal for ArcGIS URL.......https://portal_webadaptor.domain.com/portal

diskcleanup

This utility is used with relational, tile cache, and spatiotemporal big data stores.

The diskcleanup utility removes temporary files left over from operations such as restoredatastore and upgrading ArcGIS Data Store. Certain files are retained after upgrading that would allow you to troubleshoot a failed upgrade or restore operation. After you confirm that your upgrade or restore operation is successful and the system is working as expected, you can run this tool to remove those temporary files and regain free disk space on the data store machines.

This utility cleans up disk space on one machine at a time. If you need to clean up files on more than one machine in the same data store, you must run the tool on each machine.

Syntax

diskcleanup

Example

To run the diskcleanup utility, you must confirm that you want to proceed.

diskcleanup

You are attempting to cleanup some archived data generated as part of ArcGIS Data Store upgrades or backup-restore operations. Once removed, this data can't be recovered. Do you want to continue (Yes or No)?

listadminusers

This utility is used with all data store types.

The listadminusers utility returns the usernames and passwords for the administrator, replica owner, and geodatabase administrator of a relational data store. It returns the administrator credentials for all other data store types.

Syntax

listadminusers

Examples

In this example, listadminusers is run on a machine where only a relational data store is installed.

listadminusers

Admin users for relational data store ds_abcd1234
=================================================
Database Admin User.... adm_32ret / tT30sbYk22jF
Database Repl User..... dsrepuser / uWn/MV0678h4
GDB Admin User......... sde / iO=Qst751epb

In this example, listadminusers is run on a machine where only a spatiotemporal big data store is installed.

listadminusers

Admin users for spatiotemporal big data store bds_abcd1234
=================================================
Store admin user.... els_321ret / B1as70fF1

In this example, listadminusers is run on a machine where only a graph store is installed.

listadminusers

Admin users for graph store s2t0ic1
=================================================
Store admin user....root / ypz5kx2c5tk4fequ

In this example, listadminusers is run on a machine where only an object store is installed.

listadminusers

Admin users for object store w1tiknx
=================================================
Store admin user....n6o96nl53vzkm36d / bpvifyjz73xwhot4

listbackups

This utility is used with all data store types.

When run for relational data stores, the listbackups utility only functions on the primary data store machine.

Run the listbackups utility to determine the following:

The time a backup operation started
Whether a backup completed or is still running
Whether the backup was created using the backupdatastore utility or created automatically by ArcGIS Data Store
Which backup files are viable. If the backup file is not returned by the listbackups utility, it cannot be used to restore the data store. For example, backup files created with an earlier ArcGIS Data Store release may not work to restore the data store.
How many backup files you have, to determine whether you need to delete any
Confirm backup file names before running the deletebackup utility

When you run the listbackups utility, specify the backup location for which you want to see the list of backup files. If you do not specify a location, the listbackups utility returns backups for the default backup location.

Syntax

listbackups [--store {relational | tileCache | spatiotemporal | graph | object}] [--location "<location_arguments>"]

If you do not specify a data store type (--store), the utility defaults to relational and returns the backups for the relational data store running on that machine. If the relational data store is not present on the machine where you run the utility, the utility will return an error message.

Use the --location option to discover information for backups in a specific registered backup location. If you do not specify a location, information is returned for the default backup location. Provide one of the following arguments with the --location option:


Argument	Description
name=	Provide the name of the backup location. You specified this name when you configured the backup location or, if you didn't specify a name, ArcGIS Data Store assigned a default name.
location=	Specify the path to the shared file directory, S3 bucket, or Blob storage container that you registered as a backup location.

Examples

In this example, backups are listed for the default backup location of a relational data store:

listbackups --store relational

Backup_Name              Status           Backup_Time         Mode
=======================================================================
phase1proj_bu            BackupComplete   2023-03-08 14:12    manual
phase2proj_bu            BackupComplete   2023-02-21 11:43    manual
ds_gdt1omh-2023020130    BackupComplete   2023-02-01 03:00    scheduled

Backups located at: '\\myserver.net.com\dsbackups'

In this example, spatiotemporal big data store backups are listed for the backup location named sbdsbu:

listbackups --store spatiotemporal --location "name=sbdsbu"

Backup_Name          Status           Backup_Time         Mode
==================================================================
backup1						        BackupComplete   2023-07-11 09:47    manual

Backups located at: '\\myserver.net.com\spatiotemporal'

listdatasources

This utility is used with spatiotemporal big data stores.

Due to a bug in 10.8.1, ArcGIS GeoEvent Server map services that use square or hexagon aggregation do not render after upgrading to 10.9 or later. To correct this, you can run the listdatasources utility to get the names of GeoEvent Server map services, and use the service names it returns with the upgradedatasource utility to update the data for individual services.

The listdatasources utility can be run on any machine in the spatiotemporal big data store.

Syntax

listdatasources

Example

Run the listdatasources utility at a command prompt to return a list of GeoEvent Server map services.

listdatasources

listmanageduser

This utility is used with all data store types.

The listmanageduser utility returns the username and password of the account that owns the hosted feature layer data in relational and spatiotemporal big data stores. This utility also returns the username and password of the scene cache owner for tile cache data stores, the owner of the graphs in the graph store, and the owner of videos in the object store.

Syntax

listmanageduser

Examples

In the following example, listmanageduser is run on a machine that contains a relational and tile cache data store. The machine is the primary relational data store.

listmanageduser

Managed user for relational data store ds_abcd1234
===================================================
UserName     Password       Database
gwi_n2Te0    4cXddhZhve=Y   db_qv5e1

Managed user for tile cache data store tcs_e41f0rj2
===================================================
UserName     Password
usr_n8778    y47ccno913

In this example, listmanageduser is run on a spatiotemporal big data store machine.

listmanageduser

Managed user for spatiotemporal big data store bds_6udbx4321
=============================================================
UserName     Password
fmr_o1He3    5vZggkPbaw+T

In the following example, listmanageduser is run on a graph store machine.

listmanageduser

Managed user for graph store s2t0ic1 
================================================ 
UserName   Password 
mu_vwmp8c6 m5c2so76y3b0qczf

In the following example, listmanageduser is run on an object store machine.

listmanageduser

Managed user for object store w1tiknx
=============================================================
Store credential........n6o96nl53vzkm36d / bpvifyjz73xwhot4

registerdatastore

This utility is used with all data store types.

The data store retains information about the machine names of the hosting GIS Server site. If you move the hosting GIS Server site to new machines (for example, if you got new hardware or if the existing GIS Server machines failed), you must unregister the data store from the GIS Server site to remove this information. After you configure GIS Server on a new machine (or machines), register the data store with the GIS Server site using the registerdatastore utility.

Note:

The registerdatastore utility is used to register the data store to the same GIS Server site it was registered to previously. The data store contains the data for the hosted layers on the existing GIS Server site. Registering it to a different GIS Server site does not re-create the hosted layers.

The registerdatastore utility can be run on the primary relational data store machine or graph store machine or the primary machine of a tile cache data store that is running in primary-standby mode. It can be run on any machine in a tile cache data store or object store running in cluster mode or any spatiotemporal big data store machine.

Syntax

registerdatastore <ArcGIS Server URL> <ArcGIS Server site administrator username> <ArcGIS Server site administrator password> --stores {relational | tileCache | spatiotemporal | graph | object}

Though not recommended, if you have multiple different types of data stores installed on the same machine, you can register them at the same time by specifying the data store type separated by a comma (no spaces); for example, type --stores relational,tileCache.

Example

In this example, a relational data store is reregistered to a GIS Server site with the URL https://gisserver.domain.com:6443. The ArcGIS Server primary site administrator username is agsadmin with the password Tan$p0n.

registerdatastore https://gisserver.domain.com:6443 agsadmin Tan$p0n --stores relational

removemachine

This utility is used with relational, tile cache, and spatiotemporal big data stores and graph stores.

Use the removemachine utility to remove a machine from a data store that contains more than one machine. The removemachine utility is used in the following scenarios:

Remove a standby machine from a relational data store or graph store. You can run this utility on the standby machine or from the primary machine in the case where the standby machine is unavailable.
Remove a machine from a tile cache data store. You can run this utility on any machine in the tile cache data store, but you cannot run removemachine on a tile cache data store composed of only one machine.
Remove a machine from a spatiotemporal big data store. You can run this utility on any machine in the spatiotemporal big data store, but you cannot run removemachine on a spatiotemporal big data store composed of only one machine.
If you run this utility on the current coordinator machine, one of the remaining manager-eligible machines in the cluster must take over as the current coordinator. There must be at least two other machines in the cluster that are assigned the manager role for this to happen. Before removing a machine, run the describedatastore utility to identify which machine is the current coordinator and which ones are eligible to become the coordinator.

Syntax

removemachine <machine name> --store {relational | tileCache | spatiotemporal | graph} [--force {true | false}] [--prompt {yes | no}]

You must provide the machine name and the data store type.

Specify true with the --force option only if the registered ArcGIS Server site is unavailable.

By default, you'll be prompted to confirm running the utility. If you do not want to confirm the action, specify no with the --prompt option.

Examples

In this example, the spatiotemporal big data store machine, gefour, is removed from the data store.

removemachine gefour --store spatiotemporal --prompt no

In this example, the hosting server site is unavailable and the relational data store machine, fsdata, is removed from the data store.

removemachine fsdata --store relational --force true --prompt no

replacesslcertificate

This utility is used with all data store types.

You can replace the ArcGIS Data Store self-signed certificate used by the web server to authenticate communication between the hosting server and the data store and between data store machines with a certificate verified and signed by a certifying authority (CA) or domain certificate. You can also replace the self-signed certificate used to communicate between machines over ports for the following data store types:

Relational data store
Tile cache data store
Graph store
Object store

This utility will eventually supercede the updatesslcertificate utility.

See Replace the ArcGIS Data Store SSL certificate for more information.

Syntax

replacesslcertificate <source certificate file name with path> <password for the source certificate file> <alias for the certificate> --option <webserver | relational | graph | object | tileCache>

Examples

In the following example, the self-signed certificate used for webserver authentication is replaced with a CA-signed certificate file (mysignedcert.pfx).

replacesslcertificate C:\myfiles\mysignedcert.pfx "ps4mycert" "mycacert" --option webserver

In the next example, the self-signed certificate used for communication with the relational data store over ports is replaced with a CA-signed certificate (mysecondsignedcert.pfx).

replacesslcertificate C:\myfiles\mysecondsignedcert.pfx "ps4mycert" "relcacert" --option relational

restoredatastore

This utility is used with all data store types.

If you lose access to the data used by your hosted layers, use your backup files and the restoredatastore utility to recover the data store.

If you cannot recover the data store, install ArcGIS Data Store on a new machine, do not configure the data store, and restore the last full backup to the new machine.

If you use a relational data store and want to roll the hosted feature layer data back to a specific time in the past, restore on top of the existing relational data store.

Note:

The relational data store must be configured to support point-in-time recovery, and you can only restore to a previous relational data store state for which you have backup files available. For example, if you only retain backups for five days, you can only recover the data store to a point in time within those five days.

If you need to replace one of the machines in a multimachine tile cache data store, you'll most likely need to rebalance the scene layer caches across the tile cache data store. Part of that process requires you to restore the tile cache data store, setting the replicatedata option to true. See Recover a data store for instructions.

The restoredatastore utility must be run on the primary relational data store machine. The utility can be run on any of the tile cache data store, spatiotemporal big data store, graph store, or object store machines.

Note:

To discover which backup files you can use to restore, run the listbackups utility.

Syntax

restoredatastore [options]

Supported options are listed in the table below:


Option	Description
--store	Indicates the type of data store to restore. Valid values are relational, tileCache, spatiotemporal, graph, or object.
--target	Valid values are most-recent, the timestamp of the backup file in the format <yyy-mm-dd-hh:mm:ss>, or the name of the backup file. All data store types support the backup file name with the target option. A timestamp and most-recent are only supported for relational data stores. When restoring after a crash or to move the relational data store, specify --target most-recent. If restoring a relational data store to a point in time—which requires that the relational data store be configured to allow point-in-time recovery—specify the date and time (in UTC) to which you want to restore the data store. If you have a specific backup file you want to restore, specify the backup file name instead. If you do not specify a target, the most recent backup is restored.
--source-loc	This is the top-level directory where the backup files you want to use to restore the data store are located. This will be the path to a file share location, a backup location name, or an Amazon S3 or Azure Blob storage backup location. Tip: To obtain backup source locations, you can run the configurebackuplocation utility with the --operation option set to list. If you cannot run the configurebackuplocation utility—for example, if the data store machine crashed and you are restoring to a new machine to recover the data store—you can identify the backup source location by the presence of a file named agsds_backup_sig.
--bound	Valid values are true or false. The --bound option is only supported with relational data stores. By default, it is assumed that you are restoring the relational data store to work with the same GIS Server site it was registered with when you created the backup. Only specify --bound false to restore the data store without maintaining the association with the data store's GIS Server site. If you moved the hosted services to a different GIS Server, you can set the --bound option to false and specify the new GIS Server site's URL with the --server-url option when you restore. You could also restore the relational data store unbound from its GIS Server as a last resort if the GIS Server site was lost and could not be recovered; you could restore the data store unbound and configure it with a new federated GIS Server site. However, the layers that used the data in the data store would no longer exist. You would have to connect to the data store database to extract the data to another format and republish it to ArcGIS Enterprise.
--data-dir	This is the ArcGIS Data Store directory on the machine where you are restoring the database. Only use --data-dir if you are restoring the data store to a new machine. When restoring to a new machine, you must also specify the --source-loc option.
--server-url	If you specify --bound true (or omit the --bound option) to keep the data store registered with the same GIS Server site it was registered with when you created the backup, specify the URL of that GIS Server site. If you specify --bound true and have moved your services to a new GIS Server site, use the --server-url option to specify the URL of the new GIS Server site. If you specify a new site URL and have not moved the services to this new server, the data in the data store will not be accessible.
--server-admin	This option is required if you specify --bound true or do not specify the --bound option. Supply the username of the ArcGIS Server administrator.
--server-password	This option is required if you specify --bound true or do not specify the --bound option. Supply the password for the ArcGIS Server administrator.
--loaddata	Supported with tile cache and spatiotemporal big data stores and graph and object stores. Valid values are true or false. Set this option to false when you need to restore the data store to a new set of machines, but the data will not fit on the first machine. This allows you to restore the data store's schema, add more machines to the data store to accommodate all the data, and then run the restoredatastore utility again with --loaddata set to true to restore the data. By default, this option is set to true.
--replicatedata	Supported with tile cache data stores. Valid values are true or false. Set this option to true when you need to rebalance scene cache data after adding a machine to the tile cache data store.
--mode	Valid values are primaryStandby or cluster. When you restore a tile cache data store to a new machine, specify whether you want a two-machine tile cache data store for high availability (primaryStandby) or a scalable multimachine tile cache data store (cluster).
--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

In this example, the most recent backup is in a backup location named rdsbackups and will be restored to the existing data store. Because the default store type is relational, and it remains bound by default to the GIS Server site with which it was registered, you do not have to specify --store relational or --bound true. However, you do have to specify the GIS Server URL and administrator credentials.

restoredatastore --target most-recent --source-loc rdsbackups --server-url https://gisserver.domain.com:6443 --server-admin siteadmin --server-password $Aup.4s

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

In this example, a relational data store that has point-in-time recovery enabled is restored from the relational data store backup location on a network share to the state it was in at 2:30 p.m. (UTC) on July 17, 2014.

restoredatastore --target 2014-07-17-14:30:00 --source-loc \\sharedserver\entbackups\relds --server-url https://gisserver.domain.com:6443 --server-admin siteadmin --server-password $Aup.4s

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

In this example, the relational data store is restored to a new machine using a backup file named movedatastore. When you restore to a new machine, you must specify the location of the backup file and the location of the new ArcGIS Data Store data directory. Because the hosted feature services are still running on the same GIS Server site with which the relational data store is registered, --bound true is not required, but the GIS Server URL and administrator credentials are required.

restoredatastore --target movedatastore --source-loc \\buserver\data\backups --data-dir C:\datastore --server-url https://gisserver.domain.com:6443 --server-admin siteadmin --server-password $Aup.4s

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

In the following example, the tile cache data store is restored to a new machine. When you restore to a new machine, you must specify the location of the backup file and the location of the new ArcGIS Data Store data directory. Because the scene services are still running on the same GIS Server site with which the tile cache data store is registered, --bound true is not required, but the GIS Server URL and administrator credentials are required.

restoredatastore --store tilecache --source-loc \\buserver\scenedata\backups --data-dir C:\datastore --server-url https://gisserver.domain.com:6443 --server-admin siteadmin --server-password $SAup.4s

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

In this example, the tile cache data store is restored from a file named mybackupfilename to rebalance scene cache data after a new machine is added to the tile cache data store.

restoredatastore --store tilecache --target mybackupfilename --serverurl https://gisserver.domain.com:6443 --server-admin siteadmin --server-password myAdminPWd! --replicatedata true

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

In the following example, a spatiotemporal big data store backup file (bds1) is restored from a named backup location (awsloc).

restoredatastore --target bds1 --store spatiotemporal --source-loc name=awsloc --server-url https://gisserver.domain.com:6443 --server-admin siteadmin --server-password $Aup.4s

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

See Recover a data store for steps and an example of restoring a spatiotemporal big data store after hardware failure.

revokeconnection

This utility is used with relational data stores.

If you used the allowconnection utility to temporarily allow another client to connect directly to the relational data store, you can revoke the connection ability by running the revokeconnection utility.

The revokeconnection utility can be run on the primary relational data store machine only.

Syntax

revokeconnection <host name> <username> [<database>]

Example

In this example, the data store database will no longer accept connections from the workcom machine when logged in as user hqo.n_1E7.

revokeconnection workcom hqo.n_1E7

unregisterdatastore

This utility is used with all data store types.

You can use the unregisterdatastore utility to do the following:

Unregister a single-machine data store of any type from the hosting GIS Server site.
You must restart the hosting server after you unregister an object store.
In data stores running in primary-standby mode, you can unregister the primary machine after you remove the standby machine.
For spatiotemporal big data stores and tile cache data stores running in cluster mode, you can unregister the last machine after you remove all the other machines from the cluster.

Note:

If you unregister the data store to permanently remove it from the deployment, delete the hosted layers that use the data before you unregister that data store. For example, if organization members were testing GeoAnalytics Tools and used the spatiotemporal big data store for the layers created by the tools, but determined that the layers could be stored in the relational data store instead, delete the test hosted spatiotemporal feature layers before you unregister the spatiotemporal big data store. If you don't, you will have unusable layer items left in the portal and unusable services running on the hosting server.

When you unregister a machine from the data store, the hosting GIS Server site (or ArcGIS Knowledge Server site in the case of knowledge graphs) can no longer connect to that machine, and all services that contained data from the unregistered data store will no longer function. However, this utility does not delete the data; if you decide you still need the data store, you can use the registerdatastore or configuredatastore utility to add it back.

Syntax

unregisterdatastore --stores {relational | tileCache | spatiotemporal | graph | object} [--prompt {yes | no}]

If you have more than one type of data store installed on the same machine and want to unregister more than one at a time, specify each data store type separated by a comma (no spaces). For example, to unregister a relational and tile cache data store, type --stores relational,tileCache.

Example

Here, the unregisterdatastore utility is run to unregister the relational and tile cache data stores from the GIS Server site. A prompt is returned, which is the default behavior. To suppress the prompt, specify --prompt No.

unregisterdatastore --stores relational,tileCache

You are going to unregister the data store.
Do you want to continue (Yes or No)?Yes

updatebackupretaindays

This utility is used with relational data stores.

ArcGIS Data Store retains relational data store backup files for seven days by default. You can change how often backup files are purged from the backup directory by running the updatebackupretaindays utility.

The updatebackupretaindays utility can be run on the primary relational data store machine only.

Syntax

updatebackupretaindays <number of days>

Example

In the following example, backup file retention time is changed to 10 days:

updatebackupretaindays 10

updatebackupschedule

This utility is used with all data store types.

By default, ArcGIS Data Store creates a full backup of the relational data store every four days. You can change how often a full backup is created by running the updatebackupschedule utility.

There are no default automatic backups for tile cache or spatiotemporal big data stores or graph stores. To set an automatic backup schedule for a spatiotemporal big data store, you must first set a valid backup location.

Specify a start time using 24-hour clock notation, for example, 00:00:00 for midnight and 13:00:00 for 1 p.m. Use the frequency option to specify the number of days between backups. To disable automatic backups, set the frequency to 0. If you disable automatic backups, be sure to run the backupdatastore utility to create backups manually.

You can run the updatebackupschedule utility on the primary relational data store machine. The tool can be run on any tile cache or spatiotemporal big data store machine.

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

Syntax

updatebackupschedule [--store {relational | tileCache | spatiotemporal | graph | object}] [--starttime <local server time>] --frequency <number of days>

If you do not specify a new start time, the existing start time setting does not change. If you do not specify a data store type, relational data store is assumed.

Examples

In this example, full backups of a relational data store will take place at 11 p.m. (local server time) every 10 days:

updatebackupschedule --starttime 23:00:00 --frequency 10

In this example, a backup schedule is set for a tile cache data store. After the initial backup copy of all tile cache data store databases, ArcGIS Data Store copies newly created data store databases to the location specified with the configurebackuplocation every 14 days.

updatebackupschedule --store tileCache --frequency 14

updatesslcertificate

This utility is used with all data store types.

This utility is deprecated at this release. You're encouraged to use the replacesslcertificate utility instead.

You can replace the self-signed certificate used by the web server to authenticate communication between the hosting server and the data store and between data store machines with a certificate verified and signed by a certifying authority (CA) or domain certificate.

This utility does not replace the certificate used to authenticate communication over ports.

Syntax

updatesslcertificate <source certificate file name with path> <password for the source certificate file> <alias for the certificate>

Example

After you receive a CA-signed certificate file, run updatesslcertificate to replace the ArcGIS Data Store self-signed certificate used for webserver communication.

updatesslcertificate C:\myfiles\mysignedcert.pfx "ps4mycert" "mycacert"

upgradedatasource

This utility is used with spatiotemporal big data stores.

Due to a bug in 10.8.1, ArcGIS GeoEvent Server map services that use square or hexagon aggregation do not render after upgrading to 10.9 or later. To correct this, run the upgradedatasource utility to update the indexes associated with the source data for these GeoEvent Server map services.

While indexes are updating, no one can access the map service.

The upgradedatasource utility can be run on any machine in the spatiotemporal big data store.

Syntax

upgradedatasource [<service name>]

Examples

In this example, all GeoEvent Server map service sources are upgraded:

upgradedatasource

In this example, the upgradedatasource utility will update the indexes used by the GeoEvent Server map service recon. The service name was determined using the listdatasources utility.

upgradedatasource recon

Feedback on this topic?