configurebackuplocation

该实用程序可用于所有 ArcGIS Data Store 类型。

使用 configurebackuplocation 实用程序可以指定 ArcGIS Data Store 将计划备份以及使用 backupdatastore 实用程序创建的备份写入的位置。 您还可以通过 configurebackuplocation 实用程序更改备份位置的属性并移除备份位置。

使用默认的本地备份位置创建关系存储。 为避免数据损失，可通过使用 change 选项注册远程文件共享，以配置默认备份位置。

将不会使用默认备份位置创建时空大数据存储、图存储和对象存储。 开始创建备份前，必须使用 register 选项运行 configurebackuplocation 实用程序，以为这些备份指定文件共享位置、Amazon Simple Storage Service (S3) 存储桶或 Microsoft Azure Blob 存储容器。

注:

时空大数据存储备份文件不能使用本地驱动器。

您可以注册第二个备份位置，以存储使用 backupdatastore 实用程序创建的备份。 可以使用共享文件目录、S3 存储桶或 Azure Blob 存储容器作为备用备份位置。

有关 ArcGIS Data Store 备份的详细信息，请参阅管理 ArcGIS Data Store 备份。

语法

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

必填选项

运行 configurebackuplocation 实用程序时，必须提供以下选项：

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

  指定要配置或查询备份位置的 ArcGIS Data Store 的类型。 默认值为 relational。

• --operation {change | register | unregister | list | setdefault}

  --operation 选项用于指定 configurebackuplocation 实用程序将执行的操作。 默认值为 change。

  以下是对用于 --operation 选项的各参数的说明：

选项	描述
change	使用此参数可更改以下任意内容： 为计划关系存储备份指定其他的共享文件位置。 使用 change 参数设置的位置将始终作为关系存储的默认备份位置。 更改默认关系存储备份位置时，必须提供 --location 选项。 更改备份位置的名称。 更改备份位置的名称时，必须提供 --location 选项及其 name 参数。 更新您在 Azure 或 S3 上为备份位置设置的身份验证信息。 对于 S3，您可以使用 username 和 password 选项更改您之前指定的信息。 对于 Azure，您可以更改 password 值。
register	使用此参数注册备份位置。 使用 register 参数时，必须提供 --location 选项。 您为时空大数据存储、图存储或对象存储定义的首个备份位置将被设置为默认备份位置。 当您为时空大数据存储、对象存储或图存储注册另一个备份位置时，将注册备用备份位置。 对于关系存储，register 参数总会注册一个备用备份位置。 可以使用该备用备份位置来存储使用 backupdatastore 实用程序生成的手动备份。
unregister	可以使用此参数从数据存储中移除备用备份位置。 如果仅注册了一个备份位置，则取消注册参数将完全移除时空大数据存储、对象存储或图存储的备份位置。
list	列出为使用 --store 选项指定的数据存储注册的所有备份位置。 该列表将指示物理备份位置、备份位置的名称以及默认备份位置。
setdefault	如果为图存储、对象存储或时空大数据存储配置了多个备份位置，可使用 setdefault 参数将其中一个备份位置指定为默认位置。 该位置是计划备份的写入位置，如果在不指定备份位置的情况下运行 backupdatastore、listbackups 或 restoredatastore 实用程序，则该位置也会用作默认位置。

位置选项

在以下情况下必须填写 --location 选项：

• 在注册备份位置或更改关系存储的默认初始备份位置时，请指定备份存储位置。

• 要更改现有备份位置的名称，请提供 name 参数和新名称值。

可以在设置默认备份位置或移除备份位置时使用 --location 选项，也可以使用备份名称。

对于时空大数据存储，或要注册关系存储的备用备份位置时，使用 --location 选项指定以下参数（使用该选项时需以分号 (;) 分隔并将整个参数字符串括在双引号 (") 中）：

--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>]"。

下方提供了 --location 选项支持的各参数的说明：

参数	描述
type=	此参数为必填项。 定义备份使用的位置类型。 指定 fs 可将备份存储在文件共享中。 对于关系存储，默认备份位置必须是文件共享。 指定 s3 可将备份存储在 Amazon S3 存储桶中。 指定 azure 可将备份存储在 Azure Blob 存储容器中。
location=	此参数为必填项。 如需共享文件，请指定文件路径。 对于 Amazon S3 存储桶，请指定存储桶的名称和路径。 对于 Blob 存储容器，请指定容器名称和容器的路径。 当您使用此参数更改初始默认关系存储备份位置时，指定的位置不能是现有的已注册备份位置。
name=	可为备份位置分配一个名称。 例如，如果备份位置是文件路径，如 \\sharedserver_sharedfolders_datastorebackups，则可为该位置指定一个名称，如 dsbackupsfolder。 在运行 backupdatastore、listbackups 或 restoredatastore 实用程序时，请提供此名称，而不是位置路径。 如果在配置数据存储备份位置时没有提供名称，则 ArcGIS Data Store 会分配一个默认名称。
username=	将 type= 参数设置为 azure 或 s3 时，此参数为必填项。 对于 S3 存储桶，请提供 Amazon Web Services (AWS) 账户的访问密钥 ID。 对于 Azure Blob 存储容器，请提供能访问该 Blob 存储容器的 Microsoft Azure 存储账户名称。
password=	将 type= 参数设置为 azure 或 s3 时，此参数为必填项。 对于 S3 存储桶，请提供 AWS 账户的密钥。 对于 Azure Blob 存储容器，请提供使用 username 参数指定的 Azure 账户的密钥。
endpointsuffix=	如果将 type= 参数设置为 azure，则可以使用 endpointsuffix 参数表示 Azure Blob 存储容器的位置。 默认情况下，endpointsuffix 假定为 core.windows.net。 如果容器在 Microsoft Azure Government 云端环境中，请设置 endpointsuffix=core.usgovcloudapi.net。 如果容器在私有云中，请将 endpointsuffix 设置为 Azure 私有云的端点后缀。
region=	将 type= 参数设置为 s3 时，此参数为必填项。 您必须提供地区代码。 例如，如果存储桶部署在亚太（悉尼）地区，请将该地区设置为 ap-southeast-2。 有关地区代码，请参阅 AWS 文档。

其他选项

您可以为 configurebackuplocation 实用程序提供的其他选项如下：

选项	描述
--force	此选项仅配合关系存储使用，可用于更改默认备份位置，即使现有默认备份位置不可用时也是如此。 有效值为 true 或 false。 更改关系存储的默认备份位置时，ArcGIS Data Store 会将现有备份文件从旧位置复制到新位置。 如果 ArcGIS Data Store 无法访问旧位置，则无法复制文件。 在之前版本中，这可能会造成 configurebackuplocation 工具运行失败。 要继续更改默认备份位置，而不复制现有备份文件，请指定 --force true。 此选项的默认值为 false，这意味着如果 ArcGIS Data Store 无法访问现有默认位置，则您无法更改默认备份位置。
--prompt	有效值为 yes 或 no。 您运行该实用程序时，系统将提示您确认指定的操作。 如果自动使用此实用程序，可将 --prompt 选项设置为 no，否则必须要回应提示消息，脚本才会继续。

示例

下面几节提供了更改、设置或列出数据存储的备份位置的示例。

更改关系存储的默认备份位置

在第一个示例中，关系存储的备份位置设置为计算机 myshare 上名为 fsdata_bu 的目录。

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

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

添加关系存储的备份位置

在此示例中，将在 Azure 上为同一个关系存储注册第二个备份位置。

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

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

You are going to change the backup location of the data store. Existing backups will be copied to the new location and it could take a few moments.
Please do not interrupt the process once it has started.
Do you want to continue (Yes or No)? Yes

设置图存储的备份位置

在此示例中，为图存储注册了网络共享上的备份位置。 fshare 名称会分配到备份位置。

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

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

添加备份位置并设置默认位置

在此示例中，将为时空大数据存储指定第二个备份位置。 其他备份位置位于 Azure 存储中。

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

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

在本示例中，将在 AWS 上为同一个时空大数据存储指定欧洲（西班牙）地区中的第二个备份位置。 awsloc 名称会分配到备份位置。

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

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

在此示例中，使用备份位置的名称 (awsloc) 将 S3 存储桶设置为时空大数据存储的默认备份位置。

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

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

获取数据存储的所有备份位置的列表

在此示例中，列出了时空大数据存储的所有备份位置。

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

configurebackuplocation --operation list --store spatiotemporal

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

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