Skip to main content

WebGISDR 工具属性文件

要使用 Web GIS 灾难恢复 (WebGISDR) 工具创建 ArcGIS Enterprise 备份，请打开一个属性文件的副本，然后进行编辑以添加特定于您的站点的信息。 有关详细信息，请参阅创建 ArcGIS Enterprise 备份。

门户属性

在您的 WebGISDR 工具属性文件副本中，提供以下门户属性的信息：

属性

描述

PORTAL_ADMIN_URL = <门户管理 URL>

指定门户的 URL。 使用格式 https://portalhostname.example.com:7443/arcgis，其中 portalhostname.example.com 为安装了 Portal for ArcGIS 的计算机的完全限定名称。

PORTAL_ADMIN_USERNAME = <门户管理员用户名>

指定分配至默认管理员角色的成员的用户名。 它可以是内置帐户或来自 Active Directory 或 LDAP 的帐户。

PORTAL_ADMIN_PASSWORD = <门户管理员密码>

指定管理员账户的密码。

PORTAL_ADMIN_PASSWORD_ENCRYPTED = <true|false>

首次使用管理员密码填充文件时，请将该选项设置为 false。 保存文件后，您的密码将加密，此属性的值将设置为 true 以指示密码已加密。 如果以后需要更改密码，请将此属性设置为 false，提供新的管理员密码，然后保存文件。

备份属性

提供以下备份属性的信息，然后查看您的备份存储提供者所需的其他属性：

属性

描述

BACKUP_RESTORE_MODE = <backup|full|incremental>

指定要创建的备份类型。 默认模式为 backup。 有关详细信息，请参阅备份模式。 要计划完整备份和增量备份，您必须为每种备份模式创建单独的属性文件。

SHARED_LOCATION = <备份文件位置>

如果您要在文件系统上存储备份，则指定要创建 ArcGIS Server、Portal for ArcGIS 和 ArcGIS Data Store 备份文件临时副本的共享位置。

如果您要在云存储中存储备份并且满足以下要求，则无需提供此属性的位置，因为组件将直接写入云存储：

  • 部署中的所有组件位于 12.0 或更高版本中

  • ArcGIS Data Pipelines Server 和 ArcGIS Notebook Server 未与您的组织联合

  • BACKUP_RESTORE_MODE 属性设置为 backup 或 full

如果不满足上述要求，则必须指定共享位置。

安装这些组件的账户和运行 WebGISDR 工具的账户必须具有此位置的读写权限。 确保该位置足以容纳每个组件的备份文件。 虽然经过压缩，但文件仍然相当大，具体取决于数据的数量和类型。 如果有托管场景图层和缓存，并且 INCLUDE_OBJECT_STORE_CACHES 设置为 true，则 ArcGIS Data Store 备份文件可能非常大。

运行这些组件服务的域账户和运行 WebGISDR 工具的账户必须具有此位置的写入权限。 确保该位置足以容纳每个组件的备份文件。 虽然经过压缩，但文件仍然相当大，具体取决于数据的数量和类型。 如果有托管场景图层和缓存，并且 INCLUDE_OBJECT_STORE_CACHES 设置为 true，则 ArcGIS Data Store 备份文件可能非常大。

确保路径中的反斜线已被转义。 例如，C:\backups 将被输入为 C:\\backups，\\fileserver\backups 将被输入为 \\\\fileserver\\backups。

INCLUDE_OBJECT_STORE_CACHES = <true|false>

如果将托管场景或 3D 切片图层发布至门户，并且希望在备份中包含托管存储的对象存储数据，请将此属性设置为 true。 请注意，如果设置为 true，则备份中将包含所有缓存数据，而不仅仅是上次备份后创建的新缓存数据。 如果已知自上次备份以来未创建新的场景或 3D 切片图层缓存，或者未将这些类型的服务发布至门户，则可将此属性设置为 false。

注:

对象存储备份仅支持 12.0 版本的完整备份。 如果将此属性设置为 true 并创建部署的增量备份，则将创建对象存储的完整备份。

INCLUDE_GRAPH_STORE_DATA = <true|false>

如果您正在使用知识图谱服务并且希望在备份中包含图谱存储数据，请将此属性设置为 true。 在创建备份之前，您必须为图谱存储配置备份位置。 请注意，如果设置为 true，则备份中将包含所有图谱数据，而不仅仅是上次备份后创建的新图谱数据。

BACKUP_STORE_PROVIDER = <Filesystem|AmazonS3|AzureBlob>

定义是将 webgissite 备份文件保存在文件系统还是云存储中。

要将您的 ArcGIS Enterprise 备份存入本地文件共享位置，请指定 FileSystem，然后 WebGISDR 工具将把您的备份文件存入您为 BACKUP_LOCATION 指定的文件共享位置。

要将 ArcGIS Enterprise 备份存储在 Amazon S3 存储段存储位置，请创建一个专门存储由 WebGISDR 工具生成的备份文件的存储段，并使用访问您的存储段所需的信息更新 S3 属性。

如果您想将您的 ArcGIS Enterprise 备份存入 Azure Blob 存储，请创建一个专为存储由 WebGISDR 工具生成的备份文件的 Azure Blob 存储容器，并使用访问您的容器所需的信息更新 Azure 属性。

文件系统存储

如果您将 Filesystem 设置为备份存储提供者，则请提供以下属性的信息：

属性

描述

BACKUP_LOCATION = <备份文件本地位置>

如果您将 FileSystem 设置为备份存储提供者，则请指定 webgissite 备份文件的位置。

确保路径中的反斜线已被转义。 例如，C:\backups 将被输入为 C:\\backups，\\fileserver\backups 将被输入为 \\\\fileserver\\backups。

备份文件最初将被存入共享位置，但是将被复制到备份位置。 确保该位置足以容纳备份文件。 虽然经过压缩，但文件仍然相当大，具体取决于数据的数量和类型。 运行 WebGISDR 工具的账户必须具有备份位置的读写权限。

备份文件最初将被存入共享位置，但是将被复制到备份位置。 确保该位置足以容纳备份文件。 虽然经过压缩，但文件仍然相当大，具体取决于数据的数量和类型。 运行 WebGISDR 工具的账户必须具有备份位置的写入权限。

如果您将 BACKUP_LOCATION 设置为文件夹，则 WebGISDR 工具将导入最新的备份文件，可通过文件的上次修改时间戳确定该文件。 不使用备份文件名确定恢复的备份。 如果您将 BACKUP_LOCATION 设置为文件夹中的特定备份文件，则 WebGISDR 工具将导入该文件。

注:

在导出期间，打包备份可能要花费很长时间，请考虑将 BACKUP_LOCATION 设置为本地路径。 然后，您可以将操作完成的包复制到所需位置。 确保本地驱动器上有足够的空间，用于临时存储备份。

COMPRESSION_METHOD = <copy|fastest|fast|normal|maximum|ultra>

确定 webgissite 备份的压缩方法。 如果未注释掉默认值，则该值为 copy。 在大多数情况下，可将其保留为已注释掉的状态。

作为管理员，您可以选择进一步压缩备份，但这会导致完成备份所需的时间增加。

Amazon S3 存储

如果您将 Amazon S3 设置为备份存储提供者，则请提供以下属性的信息：

属性

描述

S3_ACCESSKEY = <Amazon Web Services (AWS) 帐户的访问密钥>

如果您将使用访问密钥访问 S3 存储段，请将此属性设置为您的 AWS 帐户的访问密钥。 该访问密钥所代表的 IAM 用户必须对您使用 S3_BUCKET 属性指定的 S3 存储段具有读写权限。

= <您的 AWS 帐户的密钥>S3_SECRETKEY

如果您将使用访问密钥访问 S3 存储段，请将此属性设置为与您的 AWS 帐户的访问密钥相关联的密钥。

S3_ENCRYPTED = false

将此设置保留为 false。 当您运行 WebGISDR 工具时，如果将 S3_CREDENTIALTYPE 设置为 accessKey，则工具将加密访问密钥和密钥，并将 S3_ENCRYPTED 设置为 true。

S3_BUCKET = <S3 存储段的名称>

这是您想要存储 ArcGIS Enterprise 备份文件的 Amazon S3 存储段的名称。

S3_CREDENTIALTYPE = <IAMRole|accessKey>

如果您要使用 AWS IAM 角色访问 S3 存储段，请将此属性设置为 IAMRole。 如果您要使用 AWS IAM 用户身份通过访问密钥访问 S3 存储段，请将其设置为 accessKey。 该 IAM 角色或用户必须对您通过 S3_BUCKET 属性指定的 S3 存储段具有读写权限。

S3_REGION = <已创建 S3 存储段的 AWS 区域>

指定您在其中创建了 S3 存储段的 AWS 区域。

S3_BACKUP_NAME = <备份文件名称>

仅当您恢复 ArcGIS Enterprise 组织时会使用此属性。 指定要恢复的备份文件的名称。 如果您不指定备份文件的名称，则将恢复最新的备份文件。

Azure Blob 存储

如果您将 AzureBlob 设置为备份存储提供者，则请提供以下属性的信息：

属性

描述

AZURE_BLOB_ACCOUNT_NAME = <Azure 存储帐户>

指定 Azure Blob 存储帐户名称。

提示：

当您在 Cloud Builder 的部署选项面板上选择使用 Azure 云存储进行配置和内容存储选项时，您指定了此存储帐户名称。

AZURE_BLOB_CONTAINER_NAME = <Azure Blob 存储容器的名称>

指定 Blob 容器名称。

AZURE_BLOB_CREDENTIALTYPE = <accessKey|servicePrincipal|userAssignedIdentity|sasToken>

将 Azure Blob 凭据类型设置为以下选项之一：

  • accessKey - 使用存储帐户访问密钥访问容器。

  • servicePrincipal - 使用 Azure AD 服务主体访问容器。

  • userAssignedIdentity - 使用 Azure 用户分配的托管标识访问容器。

  • sasToken - 使用共享访问签名访问容器。 这些令牌通常会定期过期，因此不建议用于自动备份和恢复。

指定的密钥、令牌或标识必须对使用 AZURE_BLOB_CONTAINER_NAME 属性指定的 Azure Blob 容器资源具有读取、写入和筛选访问权限。

AZURE_BLOB_ACCOUNT_KEY = <帐户密钥>

如果将 AZURE_BLOB_CREDENTIALTYPE 设置为 accessKey，将此属性设置为与 Azure Blob 存储帐户相关联的帐户密钥。

AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED = false

将此设置保留为 false。 当您运行 WebGISDR 工具时，如果将 AZURE_BLOB_CREDENTIALTYPE 设置为 accessKey，则该工具将加密访问密钥，并将 AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED 设置为 true。

AZURE_BLOB_SP_TENANT_ID

= <Azure 租户 ID>

如果将 AZURE_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，将此属性设置为与服务主体相关联的 Azure 租户 ID。

AZURE_BLOB_SP_CLIENT_ID

= <Azure 服务主体客户端 ID>

如果将 AZURE_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，将此属性设置为 Azure 服务主体客户端 ID。

AZURE_BLOB_SP_CLIENT_SECRET_KEY

= <Azure 服务主体密钥>

如果将 AZURE_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，将此属性设置为 Azure 服务主体密钥。

AZURE_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED = false

将此设置保留为 false。 当您运行 WebGISDR 工具时，如果将 AZURE_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，则该工具将加密访问密钥和密钥，并将 AZURE_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED 设置为加密访问密钥值。

AZURE_BLOB_USER_MI_CLIENT_ID

= <用户分配的托管标识客户端 ID>

如果将 AZURE_BLOB_CREDENTIAL_TYPE 设置为 userAssignedIdentity，将此属性设置为用户分配的托管标识客户端 ID。

AZURE_BLOB_SAS_TOKEN

= <共享访问签名令牌>

如果将 AZURE_BLOB_CREDENTIAL_TYPE 设置为 sasToken，将此属性设置为 Azure 生成的共享访问签名令牌。 由于 SAS 令牌的生命周期通常很短，因此对于自动备份和恢复工作流来说，此选项可能不是首选。

AZURE_BLOB_SAS_TOKEN_ENCRYPTED = false

将此设置保留为 false。 当您运行 WebGISDR 工具时，如果将 AZURE_BLOB_CREDENTIALTYPE 设置为 sasToken，则该工具将加密 SAS 令牌，并将 AZURE_BLOB_SAS_TOKEN_ENCRYPTED 设置为 true。

AZURE_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <Blob 存储帐户端点>

指定存储账户端点。

（可选）AZURE_BLOB_ENDPOINT_URL = <Blob 服务 URL>

如果您使用自定义 Blob 存储端点，则请指定 Blob 服务端点 URL。 如果您未使用自定义端点，请不要取消注释此行。 默认 URL 的格式为 https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net。

AZURE_BLOB_BACKUP_NAME = <备份文件名称>

仅当您恢复 ArcGIS Enterprise 组织时才会使用此属性。 指定要恢复的备份文件的名称。 如果您不指定备份文件的名称，则将恢复最新的备份文件。

AZURE_BLOB_SP_AUTHORITY_HOST = <标识主机>

如果 AZURE_BLOB_CREDENTIAL_TYPE 已设置为 servicePrincipal，并且在未使用 login.microsoftonline.com（默认）的租户中运行，请定义用于验证服务主体的正确授权主机，例如 login.microsoftonline.us。

PORTAL_BACKUP_BLOB_SP_AUTHORITY_HOST = <标识主机>

如果 AZURE_BLOB_CREDENTIAL_TYPE 已设置为 servicePrincipal，并且在未使用 login.microsoftonline.com（默认）的租户中运行，请定义用于验证服务主体的正确授权主机，例如 login.microsoftonline.us。

PKI 属性

如果您已配置基于公钥基础设置 (PKI) 的客户端证书身份验证以保护对门户的访问，请提供以下属性的信息：

属性

描述

IS_PORTAL_PKI_AUTHENTICATED = <true|false>

如果您已配置 PKI 以保护对门户的访问，请将此值设置为 true。 了解有关门户身份验证选项的详细信息。

PORTAL_CLIENT_CERTIFICATE_FILE_PATH

= <证书的完整文件路径>

指定 PKCS12 格式的门户 PKI 证书的完整文件路径。

PORTAL_CLIENT_CERTIFICATE_PASSWORD

= <证书密码>

指定 PKI 证书的相应密码。

PORTAL_CLIENT_CERTIFICATE_PASSWORD_ENCRYPTED = false

首次输入证书密码值时，请将此值保留为 false。 保存此值后首次运行工具时，该工具将对密码进行加密并将此属性更改为 true。

门户内容存储在云中的属性

如果要将门户内容或托管站点的对象存储存储在 Amazon S3 存储段或 Azure Blob 容器中，则必须创建备份存储段或容器以备份这些对象。 该存储段或容器不应该与门户内容或对象存储本身所在的存储段或容器相同；否则，每次执行备份时都会出现重复内容。

Amazon S3 存储

如果您的 ArcGIS Enterprise 组织在 AWS 上运行，且门户内容目录存储在 Amazon S3 中，请提供以下属性的信息：

注:

如果组织的计算机使用 VPC 终端节点访问 Amazon S3，则不允许跨区域复制。 在实施地理冗余时，在与备用组织相同的区域中创建一个存储段，并确保在运行 WebGISDR 导入操作之前使用 AWS CLI（或自动化过程）同步导出的门户内容备份存储段。 此复制存储段需在 webgisdr.properties 恢复文件中指定为具有适当区域的 BACKUP_S3_BUCKET。

属性

描述

BACKUP_S3_BUCKET = <存储段的名称>

指定要在其中存储门户内容目录的 S3 存储段的名称。

BACKUP_S3_REGION = <用于创建存储段的 AWS 区域>

指定用于创建存储段的 AWS 区域。

要了解有关此实施类型的详细信息，请参阅通过 Amazon S3 配置高可用性门户。

Azure Blob 存储

如果要将门户内容目录存储在 Azure Blob 存储容器中，请提供以下属性的信息：

注:

这些属性的值应与以上 Azure Blob 存储属性部分中的设置值相匹配；该部分的定义也适用于此处。

属性

描述

BACKUP_BLOB_ACCOUNT_NAME = <Azure 存储帐户>

指定 Azure Blob 存储帐户名称。

BACKUP_BLOB_CONTAINER_NAME = <Azure Blob 存储容器的名称>

指定 Blob 容器名称。

BACKUP_BLOB_CREDENTIAL_TYPE = <accessKey|servicePrincipal|userAssignedIdentity|sasToken>

设置 Azure Blob 凭据类型。

BACKUP_BLOB_ACCOUNT_KEY = <帐户密钥>

如果将 BACKUP_BLOB_CREDENTIAL_TYPE 设置为 accessKey，将此属性设置为与 Azure Blob 存储帐户相关联的帐户密钥。

BACKUP_ACCOUNT_KEY_ENCRYPTED = false

当首次将帐户密钥值添加至文件时，请指定 false。

BACKUP_BLOB_SP_TENANT_ID = <Azure 租户 ID>

如果将 BACKUP_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，将此属性设置为与服务主体相关联的 Azure 租户 ID。

BACKUP_BLOB_SP_CLIENT_ID = <Azure 服务主体客户端 ID>

如果将 BACKUP_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，将此属性设置为 Azure 服务主体客户端 ID。

BACKUP_BLOB_SP_CLIENT_SECRET_KEY = <Azure 服务主体密钥>

如果将 BACKUP_BLOB_CREDENTIAL_TYPE 设置为 servicePrincipal，将此属性设置为 Azure 服务主体密钥。

BACKUP_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED = false

当首次将服务主体值添加至文件时，请指定 false。

BACKUP_BLOB_SP_AUTHORITY_HOST = <授权主机>

如果 BACKUP_BLOB_CREDENTIAL_TYPE 已设置为 servicePrincipal，并且在未使用 login.microsoftonline.com（默认）的租户中运行，请定义用于验证服务主体的正确授权主机，例如 login.microsoftonline.us。

BACKUP_BLOB_USER_MI_CLIENT_ID = <客户端 ID>

如果将 BACKUP_BLOB_CREDENTIAL_TYPE 设置为 userAssignedIdentity，将此属性设置为用户分配的托管标识客户端 ID。

BACKUP_BLOB_SAS_TOKEN = <SAS 令牌>

如果将 BACKUP_BLOB_CREDENTIAL_TYPE 设置为 sasToken，将此属性设置为 Azure 生成的共享访问签名令牌。 由于 SAS 令牌的生命周期通常很短，因此对于自动备份和恢复工作流来说，此选项可能不是首选。

BACKUP_BLOB_SAS_TOKEN_ENCRYPTED = false

当首次将 SAS 令牌值添加至文件时，请指定 false。

BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <Blob 存储帐户端点>

指定存储账户端点。

（可选）BACKUP_BLOB_ENDPOINT_URL = <自定义 Blob 服务 URL>

如果您使用自定义 Blob 存储端点，则请指定 Blob 服务端点 URL。 如果您未使用自定义端点，请不要取消注释此行。 默认 URL 的格式为 https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net

示例

以下示例属性文件包含每个备份存储提供者选项的应用场景。

  • 在本示例中，URL 为 https://portalhostname.example.com:7443/arcgis 的门户的备份，及其托管与联合服务器的服务和设置，以及存储在 ArcGIS Data Store 关系存储中的托管要素图层数据最初将输出至 \\\\myserver\\tempbackups 中的文件。 单独的文件将被压缩成单个备份文件 (entbackup) 并复制到 \\mybuserver\\wgbackups。 不会包括 ArcGIS Data Store 对象存储中的场景图层缓存，因为 INCLUDE_OBJECT_STORE_CACHES 设置为 false。

    PORTAL_ADMIN_URL = https://portalhostname.example.com:7443/arcgis
PORTAL_ADMIN_USERNAME = admin
PORTAL_ADMIN_PASSWORD = Th3.Ad.Pass
PORTAL_ADMIN_PASSWORD_ENCRYPTED = false
BACKUP_RESTORE_MODE = backup
SHARED_LOCATION = \\\\myserver\\tempbackups
INCLUDE_OBJECT_STORE_CACHES = false
BACKUP_STORE_PROVIDER = FileSystem
BACKUP_LOCATION = \\\\mybuserver\\wgbackups\\entbackup

  • 在本示例中，URL 为 https://portalonaws.example.com:7443/argis 的门户的备份、其内容目录（储存在 S3 存储段 portalcontent 中）、托管与联合服务器的服务和设置，以及关系存储和对象存储中存储的数据将输出至 AWS 区域 eu-west-1 中的 S3 存储段 entbackups。 备份文件名为 fullbackup06June。 IAM 角色用于访问 AWS 帐户。

    PORTAL_ADMIN_URL = https://portalonaws.example.com:7443/arcgis
PORTAL_ADMIN_USERNAME = entadmin
PORTAL_ADMIN_PASSWORD = p0rtl.a.p
PORTAL_ADMIN_PASSWORD_ENCRYPTED = false
BACKUP_RESTORE_MODE = backup
INCLUDE_OBJECT_STORE_CACHES = true
BACKUP_STORE_PROVIDER = AmazonS3
S3_BUCKET = entbackups
S3_CREDENTIALTYPE = IAMRole
S3_REGION = eu-west-1
S3_BACKUP_NAME = fullbackup06June
BACKUP_S3_BUCKET = contentbackups
BACKUP_S3_REGION = eu-west-1

  • 此示例适用于 Microsoft Azure Blob 存储。 URL 为 https://portalonazure.example.com:7443/arcgis 的门户的备份、其内容目录、托管与联合服务器的服务和设置，以及在关系存储和对象存储中存储的数据将输出至 Azure Blob drbackups。

    PORTAL_ADMIN_URL = https://portalonazure.example.com:7443/arcgis
PORTAL_ADMIN_USERNAME = entadmin
PORTAL_ADMIN_PASSWORD = p0rtl.a.p
BACKUP_RESTORE_MODE = backup
INCLUDE_OBJECT_STORE_CACHES = true
BACKUP_STORE_PROVIDER = AzureBlob
AZURE_BLOB_ACCOUNT_NAME = entbackups
AZURE_BLOB_ACCOUNT_KEY = <key>
AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED =false
AZURE_BLOB_ACCOUNT_ENDPOINT_SUFFIX = core.windows.net
AZURE_BLOB_CONTAINER_NAME = drbackups
BACKUP_BLOB_ACCOUNT_NAME = entbackups
BACKUP_BLOB_ACCOUNT_KEY = <key>
BACKUP_BLOB_ACCOUNT_KEY_ENCRYPTED = false
BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = core.windows.net
BACKUP_BLOB_CONTAINER_NAME = contentbackups