Skip To Content

WebGISDR ツールのプロパティ ファイル

Web GIS 障害復旧 (WebGISDR) ツールを使用して ArcGIS Enterprise のバックアップを作成するには、プロパティ ファイルのコピーを開き、サイトに固有の情報を含めるようにそのファイルを編集します。 詳細については、「ArcGIS Enterprise バックアップの作成」をご参照ください。

ポータルのプロパティ

WebGISDR ツールのプロパティ ファイルのコピーで次のポータル プロパティに関する情報を指定します。

プロパティ説明

PORTAL_ADMIN_URL = <ポータル管理 URL>

ポータルの URL を指定します。 形式 https://portalhostname.domain.com:7443/arcgis を使用します。ここで、portalhostname.domain.com は、Portal for ArcGIS がインストールされているコンピューターの完全修飾名です。

PORTAL_ADMIN_USERNAME = <ポータル管理者のユーザー名>

管理者ロールに割り当てられたメンバーのユーザー名を指定します。

PORTAL_ADMIN_PASSWORD = <ポータル管理者のパスワード>

管理者アカウントのパスワードを指定します。

PORTAL_ADMIN_PASSWORD_ENCRYPTED = <true|false>

初めてファイルに管理者パスワードを設定するときは、このオプションを false に設定します。 ファイルを保存すると、パスワードが暗号化され、このプロパティの値が true に設定されて、パスワードが暗号化済みであることが示されます。 パスワードを今後変更する必要がある場合は、このプロパティを false に設定し、新しい管理者パスワードを指定して、ファイルを保存します。

バックアップ プロパティ

次のバックアップ プロパティに関する情報を指定し、バックアップ ストア プロバイダーに必要な追加情報を確認します。

プロパティ説明
BACKUP_RESTORE_MODE = <backup|full|incremental>

作成するバックアップのタイプを指定します。 デフォルト モードは backup です。 詳細については、「バックアップ モード」をご参照ください。 完全バックアップと増分バックアップの両方をスケジュール設定するには、バックアップ モードごとに別々のプロパティ ファイルを作成する必要があります。

SHARED_LOCATION = <バックアップ ファイルの場所>

ArcGIS ServerPortal for ArcGIS、および ArcGIS Data Store のバックアップ ファイルの一時コピーが作成される共有場所を指定します。 これらのコンポーネントのサービスを実行するドメイン アカウントと WebGISDR ツールを実行するアカウントには、この場所への書き込み権限が必要です。 この場所が各コンポーネントのバックアップ ファイルを保持するのに十分な大きさであることを確認します。 ファイルは、圧縮されるとはいえ、存在するデータの量とタイプによっては非常に大きなサイズになることがあります。 ホスト シーン レイヤーおよびキャッシュが存在し、INCLUDE_SCENE_TILE_CACHEStrue に設定している場合は特に、ArcGIS Data Store バックアップ ファイルのサイズが大きくなる可能性があります。

パス内のバックスラッシュがエスケープされていることを確認します。 たとえば、C:\backupsC:\\backups として入力され、\\fileserver\backups\\\\fileserver\\backups として入力されます。

INCLUDE_SCENE_TILE_CACHES = <true|false>

ホスト シーン レイヤーをポータルに公開して、シーン キャッシュ データをバックアップに含める場合は、このプロパティを true に設定します。 true に設定した場合は、最後のバックアップ以降に作成された新しいキャッシュ データだけではなく、すべてのシーン キャッシュ データがバックアップに含まれる点に注意してください。 最後のバックアップ以降に新しいシーン キャッシュが作成されていないことがわかっている場合や、シーンをポータルに公開しない場合は、このプロパティを false に設定できます。

BACKUP_STORE_PROVIDER = <Filesystem|AmazonS3|AzureBlob>

webgissite バックアップ ファイルをファイル システムとクラウド ストレージのどちらに保存するかを定義します。

ArcGIS Enterprise のバックアップをオンプレミスのファイル共有場所に格納するには、FileSystem を指定します。WebGISDR ツールを実行すると、BACKUP_LOCATION で指定したファイル共有にバックアップ ファイルが格納されます。

ArcGIS Enterprise のバックアップを Amazon S3 または S3 対応のバケット格納場所に格納するには、WebGISDR ツールで生成されたバックアップ ファイルを格納するための専用のバケットを作成し、そのバケットへのアクセスに必要な情報を S3 プロパティに反映します。

ArcGIS Enterprise のバックアップを Microsoft Azure Blob Storage に格納するには、WebGISDR ツールで生成されたバックアップ ファイルを格納するための専用の Azure Blob Storage コンテナーを作成し、そのコンテナーへのアクセスに必要な情報を Azure プロパティに反映します。

ファイル システム ストレージ

Filesystem をバックアップ ストア プロバイダーとして設定する場合は、次のプロパティに関する情報を指定します。

プロパティ説明

BACKUP_LOCATION = <オンプレミスのバックアップ ファイルの場所>

FileSystem をバックアップ ストア プロバイダーとして設定する場合は、webgissite バックアップ ファイルの場所を指定します。

パス内のバックスラッシュがエスケープされていることを確認します。 たとえば、C:\backupsC:\\backups として入力され、\\fileserver\backups\\\\fileserver\\backups として入力されます。

バックアップ ファイルは最初に共有場所に格納されますが、その後でバックアップ場所にコピーされます。 この場所がバックアップ ファイルを保持するのに十分な大きさであることを確認します。 ファイルは、圧縮されるとはいえ、存在するデータの量とタイプによっては非常に大きなサイズになることがあります。 WebGISDR ツールを実行するアカウントには、バックアップ場所への書き込み権限が必要です。

BACKUP_LOCATION をフォルダーに設定した場合は、WebGISDR ツールを実行すると、そのフォルダー内の最新のバックアップ ファイルがインポートされます。 BACKUP_LOCATION をフォルダー内の特定のバックアップ ファイルに設定した場合は、WebGISDR ツールを実行すると、そのファイルがインポートされます。

注意:

エクスポートの際、バックアップのパッケージ化に時間がかかる場合は、BACKUP_LOCATION をローカル パスに設定することを検討してください。 完成したパッケージを目的の場所にコピーすることができます。 ローカル ドライブにバックアップを一時的に格納するのに十分な容量があることを確認します。

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

webgissite のバックアップを圧縮する方法を決定します。 コメント アウトされていない場合のデフォルト値は copy です。 ほとんどの場合は、コメント アウトしておくことができます。

管理者は、バックアップの完了に要する時間を増やして、さらにバックアップを圧縮することができます。

Amazon S3 Store

Amazon S3 をバックアップ ストア プロバイダーとして設定する場合は、次のプロパティに関する情報を指定します。

プロパティ説明

S3_ACCESSKEY = <Amazon Web Services (AWS) アカウントのアクセス キー>

アクセス キーを使用して S3 バケットにアクセスする場合は、このプロパティを AWS アカウントのアクセス キーに設定します。 このアクセス キーで表される IAM ユーザーには、S3_BUCKET プロパティで指定した S3 バケットに対する読み取り権限と書き込み権限が必要です。

S3_SECRETKEY = <AWS アカウントの秘密鍵>

アクセス キーを使用して S3 バケットにアクセスする場合は、このプロパティを AWS アカウントのアクセス キーに関連付けられた秘密鍵に設定します。

S3_ENCRYPTED = false

この設定を false のままにします。 WebGISDR ツールの実行時に S3_CREDENTIALTYPEaccessKey に設定されている場合は、このツールでアクセス キーと秘密鍵が暗号化され、S3_ENCRYPTEDtrue に設定されます。

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 Storage

AzureBlob をバックアップ ストア プロバイダーとして設定する場合は、次のプロパティに関する情報を指定します。

プロパティ説明

AZURE_BLOB_ACCOUNT_NAME = <Azure Storage アカウント>

Azure Blob Storage アカウントの名前を指定します。

ヒント:

この Storage アカウント名は、Cloud Builder[デプロイメント オプション] パネルで [構成およびコンテンツ ストアに Azure Cloud Storage を使用] を選択したときに指定しました。

AZURE_BLOB_CONTAINER_NAME = <Azure Blob Storage コンテナーの名前>

Blob コンテナーの名前を指定します。

AZURE_BLOB_CREDENTIALTYPE = <accessKey|servicePrincipal|userAssignedIdentity|sasToken>

Azure BLOB 認証情報タイプを以下のいずれかに設定します。

  • accessKey - Storage アカウントのアクセス キーを使用して、コンテナーにアクセスします。
  • servicePrincipal - Azure ID サービス プリンシパルを使用して、コンテナーにアクセスします。
  • userAssignedIdentity - Azure ユーザー割り当てマネージド ID を使用して、コンテナーにアクセスします。
  • sasToken - 共有アクセス署名を使用して、コンテナーにアクセスします。 これらのトークンは、通常、定期的に失効するため、自動バックアップと自動復元にはお勧めしません。

指定した鍵、トークン、または ID に、AZURE_BLOB_CONTAINER_NAME プロパティで指定した Azure Blob コンテナー リソースの読み取り、書き込み、フィルタリングの権限を付与する必要があります。

AZURE_BLOB_ACCOUNT_KEY = <アカウント キー>

AZURE_BLOB_CREDENTIALTYPEaccessKey に設定した場合は、このプロパティを Azure Blob Storage アカウントに関連付けられたアカウント キーに設定します。

AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED = false

この設定を false のままにします。 WebGISDR ツールの実行時に AZURE_BLOB_CREDENTIALTYPEaccessKey に設定されている場合は、このツールでアクセス キーが暗号化され、AZURE_BLOB_ACCOUNT_KEY_ENCRYPTEDtrue に設定されます。

AZURE_BLOB_SP_TENANT_ID

= <Azure テナント ID>

AZURE_BLOB_CREDENTIAL_TYPEservicePrincipal に設定した場合は、このプロパティをサービス プリンシパルに関連付けられた Azure テナント ID に設定します。

AZURE_BLOB_SP_CLIENT_ID

= <Azure サービス プリンシパル クライアント ID>

AZURE_BLOB_CREDENTIAL_TYPEservicePrincipal に設定したら、このプロパティを Azure サービス プリンシパル クライアント ID に設定します。

AZURE_BLOB_SP_CLIENT_SECRET_KEY

= <Azure サービス プリンシパルの秘密鍵>

AZURE_BLOB_CREDENTIAL_TYPEservicePrincipal に設定したら、このプロパティを Azure サービス プリンシパルの秘密鍵に設定します。

AZURE_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED = false

この設定を false のままにします。 WebGISDR ツールの実行時に AZURE_BLOB_CREDENTIAL_TYPEservicePrincipal に設定されている場合は、このツールでアクセス キーと秘密鍵が暗号化され、AZURE_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED が暗号化済みのアクセス キー値に設定されます。

AZURE_BLOB_USER_MI_CLIENT_ID

= <ユーザー割り当てマネージド ID クライアント ID>

AZURE_BLOB_CREDENTIAL_TYPEuserAssignedIdentity に設定したら、このプロパティをユーザー割り当てマネージド ID クライアント ID に設定します。

AZURE_BLOB_SAS_TOKEN

= <共有アクセス署名トークン>

AZURE_BLOB_CREDENTIAL_TYPEsasToken に設定したら、このプロパティを Azure から生成された共有アクセス署名トークンに設定します。 SAS トークンの有効期間は通常短いため、このオプションは、自動バックアップや自動復元のワークフローには適さない場合があります。

AZURE_BLOB_SAS_TOKEN_ENCRYPTED = false

この設定を false のままにします。 WebGISDR ツールの実行時に AZURE_BLOB_CREDENTIALTYPEsasToken に設定されている場合は、このツールで SAS トークンが暗号化され、AZURE_BLOB_SAS_TOKEN_ENCRYPTEDtrue に設定されます。

AZURE_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <Blob Storage アカウント エンドポイント>

Storage アカウント エンドポイントを指定します。

(オプション) AZURE_BLOB_ENDPOINT_URL = <Blob サービスの URL>

カスタム Blob Storage エンドポイントを使用している場合は、Blob サービス エンドポイント URL を指定します。 カスタム エンドポイントを使用していない場合は、この行のコメントを解除しないでください。 デフォルト URL の形式は https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net です。

AZURE_BLOB_BACKUP_NAME = <バックアップ ファイルの名前>

このプロパティは、ArcGIS Enterprise 組織を復元する場合にのみ使用します。 復元するバックアップ ファイルの名前を指定します。 バックアップ ファイルの名前を指定しないと、最新のバックアップ ファイルが復元されます。

PKI プロパティ

ポータルへのアクセスをセキュリティ保護するように公開鍵基盤 (PKI) ベースのクライアント証明書認証を構成してしている場合は、次のプロパティに関する情報を指定します。

プロパティ説明
IS_PORTAL_PKI_AUTHENTICATED = <true|false>

ポータルへのアクセスをセキュリティ保護するように PKI を構成している場合は、この値を true に設定します。 ポータル認証オプションの詳細

PORTAL_CLIENT_CERTIFICATE_FILE_PATH

= <証明書ファイルの絶対パス>

ポータルの PKI 証明書ファイルの絶対パスを PKCS12 形式で指定します。

PORTAL_CLIENT_CERTIFICATE_PASSWORD

= <証明書のパスワード>

対応する PKI 証明書のパスワードを指定します。

PORTAL_CLIENT_CERTIFICATE_PASSWORD_ENCRYPTED = false

証明書パスワードの値を最初に入力する際には、この値を false のままにします。 この値を保存した後に最初にツールを実行すると、ツールによってパスワードが暗号化され、このプロパティが true に変更されます。

クラウド プロパティのポータル コンテンツ

ポータル コンテンツ ディレクトリを Amazon S3 バケットまたは Azure Blob コンテナーに格納している場合は、コンテンツ ディレクトリ用のバックアップ バケットまたはバックアップ コンテナーを作成する必要があります。 このバケットまたはコンテナーは、ポータル自体が配置されているバケットまたはコンテナーとは異なる必要があります。同じバケットまたはコンテナーに配置すると、バックアップを実行するごとにコンテンツの重複が発生します。

Amazon S3 Store

ArcGIS Enterprise 組織が AWS で実行されており、ポータル コンテンツ ディレクトリが Amazon S3 に格納されている場合は、次のプロパティに関する情報を指定します。

注意:

組織のコンピューターが VPC エンドポイントを使用して Amazon S3 にアクセスしている場合、領域間のコピーは許可されていません。 地理的な冗長性を実装している場合は、スタンバイと同じ領域にバケットを作成し、WebGISDR インポート操作を実行する前に、AWS CLI (または自動プロセス) を使用して、エクスポートされたポータル コンテンツのバックアップ バケットが同期されていることを確認します。 この複製されたバケットは、適切な領域の PORTAL_BACKUP_S3_BUCKET として webgisdr.properties 復元ファイルで指定する必要があります。

プロパティ説明

PORTAL_BACKUP_S3_BUCKET = <バケットの名前>

ポータル コンテンツ ディレクトリを格納する S3 バケットの名前を指定します。

PORTAL_BACKUP_S3_REGION = <バケットが作成された AWS 領域>

バケットが作成された AWS 領域を指定します。

このタイプの実装の詳細については、「Amazon S3 を使用した可用性の高いポータルの構成」をご参照ください。

Azure Blob Storage

ポータル コンテンツ ディレクトリを Azure Blob Storage コンテナーに格納している場合は、次のプロパティに関する情報を提供します。

注意:

これらのプロパティの値は、上記の Azure Blob Storage プロパティ セクションで設定した値と一致している必要があります。そのセクションの定義はここでも適用されます。

プロパティ説明

PORTAL_BACKUP_BLOB_ACCOUNT_NAME = <Azure Storage アカウント>

Azure Blob Storage アカウントの名前を指定します。

PORTAL_BACKUP_BLOB_ACCOUNT_KEY = <アカウント キー>

Azure Blob Storage アカウントに関連付けられているアカウント キーを指定します。

PORTAL_BACKUP_ACCOUNT_KEY_ENCRYPTED = false

最初にアカウント キー値をファイルに追加する場合は、false を指定します。

PORTAL_BACKUP_BLOB_CONTAINER_NAME = <Azure Blob Storage コンテナーの名前>

Blob コンテナーの名前を指定します。

PORTAL_BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <Blob Storage アカウント エンドポイント>

Storage アカウント エンドポイントを指定します。

(オプション) PORTAL_BACKUP_BLOB_ENDPOINT_URL = <カスタム Blob サービスの URL>

カスタム Blob ストレージ エンドポイントを使用している場合は、Blob サービス エンドポイント URL を指定します。 カスタム エンドポイントを使用していない場合は、この行のコメントを解除しないでください。 デフォルト URL の形式は https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net です。

次の例にあるプロパティ ファイルには、それぞれのバックアップ ストア プロバイダー オプションのシナリオが含まれています。

  • この例では、URL が https://portalhostname.domain.com:7443/arcgis のポータル、そのポータルのホスティング サーバーおよびフェデレーション サーバーのサービスと設定、ArcGIS Data Store リレーショナル データ ストアに格納されたホスト フィーチャ レイヤー データのバックアップが最初に \\\\myserver\\tempbackups 内のファイルに出力されます。 これらのファイルは別々に圧縮されて 1 つのバックアップ ファイル (entbackup) に格納された後、\\mybuserver\\wgbackups にコピーされます。 INCLUDE_SCENE_TILE_CACHESfalse に設定されているため、ArcGIS Data Store タイル キャッシュ データ ストアのシーン レイヤー キャッシュは含まれません。

    
    PORTAL_ADMIN_URL = https://portalhostname.domain.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_SCENE_TILE_CACHES = false
    
    BACKUP_STORE_PROVIDER = FileSystem
    BACKUP_LOCATION = \\\\mybuserver\\wgbackups\\entbackup
  • この例では、URL が https://portalonaws.mydomain.com:7443/gis のポータル、そのポータルのコンテンツ ディレクトリ (S3 バケット portalcontent に格納されている)、そのポータルのホスティング サーバーおよびフェデレーション サーバーのサービスと設定、リレーショナル データ ストアおよびタイル キャッシュ データ ストアに格納されたデータのバックアップが AWS 領域 eu-west-1 内の S3 バケット entbackups に出力されます。 バックアップ ファイルの名前は fullbackup06June です。 IAM ロールは、AWS アカウントへのアクセスに使用されます。

    
    PORTAL_ADMIN_URL = https://portalonaws.mydomain.com:7443/arcgis
    PORTAL_ADMIN_USERNAME = entadmin
    PORTAL_ADMIN_PASSWORD = p0rtl.a.p
    PORTAL_ADMIN_PASSWORD_ENCRYPTED = false
    
    BACKUP_RESTORE_MODE = backup
    SHARED_LOCATION = \\fileserver\backups
    INCLUDE_SCENE_TILE_CACHES = true
    BACKUP_STORE_PROVIDER = AmazonS3
    
    S3_BUCKET = entbackups
    S3_CREDENTIAL_TYPE = IAMRole
    S3_REGION = eu-west-1
    S3_BACKUP_NAME = fullbackup06June
    
    PORTAL_BACKUP_S3_BUCKET = contentbackups
    PORTAL_BACKUP_S3_REGION =eu-west-1
  • この例は、Microsoft Azure Blob ストレージを対象にしています。 URL が https://portalonazure.domain.com:7443/arcgis のポータル、そのポータルのコンテンツ ディレクトリ、そのポータルのホスティング サーバーおよびフェデレーション サーバーのサービスと設定、リレーショナルおよびタイル キャッシュ データ ストアに格納されたデータのバックアップが Azure Blob の drbackups に出力されます。

    
    PORTAL_ADMIN_URL = https://portalonazure.domain.com:7443/arcgis
    PORTAL_ADMIN_USERNAME = entadmin
    PORTAL_ADMIN_PASSWORD = p0rtl.a.p
    
    BACKUP_RESTORE_MODE = backup
    SHARED_LOCATION = \\fileserver\backups
    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
    
    PORTAL_BACKUP_BLOB_ACCOUNT_NAME = entbackups
    PORTAL_BACKUP_BLOB_ACCOUNT_KEY = <key>
    PORTAL_BACKUP_BLOB_ACCOUNT_KEY_ENCRYPTED = false
    PORTAL_BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = core.windows.net
    PORTAL_BACKUP_BLOB_CONTAINER_NAME = contentbackups