Skip To Content

Fichier de propriétés de l’outil WebGISDR

Pour créer une sauvegarde ArcGIS Enterprise avec l’outil WebGISDR (Web GIS Disaster Recovery, Récupération d’urgence du SIG Web), ouvrez une copie du fichier de propriétés et modifiez-la pour inclure des informations propres à votre site. Pour plus d’informations, reportez-vous à la rubrique Créer une sauvegarde ArcGIS Enterprise.

Propriétés du portail

Fournissez des informations pour les propriétés de portail suivantes dans votre copie du fichier de propriétés de l’outil WebGISDR :

PropriétéDescription

PORTAL_ADMIN_URL = <URL d’administration du portail>

Spécifiez l’URL du portail. Utilisez le format https://portalhostname.domain.com:7443/arcgis, où portalhostname.domain.com est le nom complet de la machine où Portal for ArcGIS est installé.

PORTAL_ADMIN_USERNAME = <nom d’utilisateur de l’administrateur du portail>

Spécifiez le nom d’utilisateur d’un membre auquel le rôle Administration est attribué.

PORTAL_ADMIN_PASSWORD = <mot de passe de l’administrateur du portail>

Spécifiez le mot de passe du compte d'administrateur.

PORTAL_ADMIN_PASSWORD_ENCRYPTED = <true|false>

Définissez cette option sur false la première fois que vous renseignez le fichier avec votre mot de passe d’administrateur. Lors de l’enregistrement du fichier, votre mot de passe est chiffré et la valeur de cette propriété est définie sur true pour indiquer que le mot de passe a été chiffré. Si vous devez modifier le mot de passe ultérieurement, définissez cette propriété sur false, indiquez votre nouveau mot de passe d’administrateur et enregistrez le fichier.

Propriétés de sauvegarde

Fournissez des informations pour les propriétés de sauvegarde suivantes et passez en revue les propriétés supplémentaires requises pour votre fournisseur de backup store :

PropriétéDescription
BACKUP_RESTORE_MODE = <backup|full|incremental>

Spécifiez le type de sauvegarde que vous souhaitez créer. Le mode par défaut est backup. Reportez-vous à la rubrique Modes de sauvegarde pour plus d’informations. Pour programmer à la fois des sauvegardes complètes et des sauvegardes incrémentielles, vous devez créer un fichier de propriétés distinct pour chaque mode de sauvegarde.

SHARED_LOCATION = <emplacement des fichiers de sauvegarde>

Indiquez un emplacement partagé dans lequel créer une copie temporaire des fichiers de sauvegarde pour ArcGIS Server, Portal for ArcGIS et ArcGIS Data Store. Le compte qui a installé ces composants et le compte qui exécute l’outil WebGISDR doivent disposer d’un accès en lecture et en écriture sur cet emplacement. Vérifiez que l’emplacement est d’une taille suffisante pour contenir les fichiers de sauvegarde de chaque composant. Même si les fichiers sont compressés, ils peuvent être assez volumineux selon la quantité et le type de données dont vous disposez. Si vous possédez des couches de scènes hébergées et des caches et définissez INCLUDE_SCENE_TILE_CACHES sur true, le fichier de sauvegarde ArcGIS Data Store peut être particulièrement volumineux.

Assurez-vous qu’une séquence d’échappement est appliquée aux barres obliquesinverses du chemin d’accès. Par exemple, le chemin d’accès C:\backups serait saisi sous la forme C:\\backups et le chemin d’accès \\fileserver\backups serait saisi sous la forme \\\\fileserver\\backups.

INCLUDE_SCENE_TILE_CACHES = <true|false>

Si vous publiez des couches de scènes hébergées sur votre portail et que vous souhaitez inclure les données des caches de scènes dans la sauvegarde, définissez cette propriété sur true. Gardez à l’esprit que, si ce paramètre est défini sur true, toutes les données des caches de scènes sont intégrées dans la sauvegarde, pas seulement les nouvelles données de cache créées depuis votre dernière sauvegarde. Si vous savez qu’aucun nouveau cache de scènes n’a été créé depuis votre dernière sauvegarde ou si vous ne publiez pas de scènes dans votre portail, vous pouvez définir cette propriété sur false.

BACKUP_STORE_PROVIDER = <Filesystem|AmazonS3|AzureBlob>

Indiquez si vous voulez enregistrer le fichier de sauvegarde webgissite sur le système de fichiers ou sur le stockage Cloud.

Pour stocker la sauvegarde ArcGIS Enterprise dans un emplacement de partage de fichiers sur site, spécifiez FileSystem. L’outil WebGISDR stocke les fichiers de sauvegarde dans le partage de fichiers que vous indiquez pour BACKUP_LOCATION.

Pour stocker les sauvegardes ArcGIS Enterprise dans un emplacement de stockage de compartiments Amazon S3 ou compatible avec S3, créez-en un dédié spécifiquement au stockage des fichiers de sauvegarde générés par l’outil WebGISDR et mettez à jour les propriétés S3 selon les informations requises pour accéder au compartiment.

Pour stocker les sauvegardes ArcGIS Enterprise dans un stockage BLOB Microsoft Azure, créez un conteneur de stockage BLOB Azure dédié spécifiquement au stockage des fichiers de sauvegarde générés par l’outil WebGISDR et mettez à jour les propriétés Azure selon les informations requises pour accéder au conteneur.

Stockage du système de fichiers

Si vous définissez Filesystem comme fournisseur de backup store, fournissez les informations correspondant aux propriétés suivantes :

PropriétéDescription

BACKUP_LOCATION = <emplacement du fichier de sauvegarde sur site>

Si vous définissez FileSystem comme fournisseur de backup store, désignez l’emplacement pour le fichier de sauvegarde webgissite.

Assurez-vous qu’une séquence d’échappement est appliquée aux barres obliquesinverses du chemin d’accès. Par exemple, le chemin d’accès C:\backups serait saisi sous la forme C:\\backups et le chemin d’accès \\fileserver\backups serait saisi sous la forme \\\\fileserver\\backups.

Les fichiers de sauvegarde sont initialement stockés dans l’emplacement partagé, mais ils sont ensuite copiés dans l’emplacement de sauvegarde. Vérifiez que l'emplacement est d'une taille suffisante pour contenir le fichier de sauvegarde. Même si le fichier est compressé, il peut être assez volumineux selon la quantité et le type de données dont vous disposez. Le compte qui exécute l’outil WebGISDR doit disposer d’un accès en lecture et en écriture sur l’emplacement de sauvegarde.

Si vous définissez BACKUP_LOCATION sur un dossier, l’outil WebGISDR importe le fichier de sauvegarde le plus récent disponible dans ce dossier. Si vous définissez BACKUP_LOCATION sur un fichier de sauvegarde spécifique dans le dossier, ce fichier est importé par l’outil WebGISDR.

Remarque :

Lors de l’exportation, si l’empaquetage de la sauvegarde dure trop longtemps, pensez à définir BACKUP_LOCATION sur un chemin d’accès local. Vous pouvez ensuite copier le paquetage terminé dans l’emplacement souhaité. Vérifiez que vous disposez d’un espace suffisant sur le disque local pour le stockage temporaire de la sauvegarde.

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

Déterminez la méthode de compression pour la sauvegarde webgissite. La valeur par défaut est copy, si elle n’est pas mise en commentaire. Dans la plupart des cas, les commentaires peuvent être conservés.

En tant qu’administrateur, vous pouvez choisir de compresser davantage les sauvegardes, mais cela augmente le temps de traitement nécessaire.

Stockage Amazon S3

Si vous définissez Amazon S3 comme fournisseur de backup store, fournissez les informations correspondant aux propriétés suivantes :

PropriétéDescription

S3_ACCESSKEY = <clé d’accès de votre compte Amazon Web Services (AWS)>

Si vous prévoyez d’accéder au compartiment S3 à l’aide d’une clé d’accès, définissez cette propriété sur la clé d’accès pour votre compte AWS. L’utilisateur IAM représenté par cette clé d’accès doit disposer d’un accès en lecture et en écriture sur le paquet S3 que vous spécifiez avec la propriété S3_BUCKET.

S3_SECRETKEY = <clé secrète de votre compte AWS>

Si vous prévoyez d’accéder au compartiment S3 à l’aide d’une clé d’accès, définissez cette propriété sur la clé secrète associée à la clé d’accès pour votre compte AWS.

S3_ENCRYPTED = false

Laissez cette propriété définie sur false. Si S3_CREDENTIALTYPE a pour valeur accessKey lorsque vous exécutez l’outil WebGISDR, l’outil chiffrera la clé d’accès et la clé secrète et définira S3_ENCRYPTED sur true.

S3_BUCKET = <nom du compartiment S3>

C’est le nom du paquet Amazon S3 dans lequel vous voulez stocker votre fichier de sauvegarde ArcGIS Enterprise.

S3_CREDENTIALTYPE = <IAMRole|accessKey>

Définissez cette propriété sur IAMRole si vous comptez accéder au compartiment S3 à l’aide d’un rôle IAM AWS. Définissez la propriété sur accessKey si vous comptez accéder au compartiment S3 à l’aide d’un utilisateur IAM AWS avec une clé d’accès. Le rôle ou utilisateur IAM doit disposer d’un accès en lecture et en écriture sur le paquet S3 que vous spécifiez avec la propriété S3_BUCKET.

S3_REGION = <région AWS dans laquelle vous avez créé le compartiment S3>

Spécifiez la région AWS dans laquelle vous avez créé le compartiment S3.

S3_BACKUP_NAME = <nom du fichier de sauvegarde>

Cette propriété est uniquement utilisée lorsque vous restaurez une organisation ArcGIS Enterprise. Spécifiez le nom du fichier de sauvegarde que vous voulez restaurer. Si vous n'indiquez pas le nom du fichier de sauvegarde, le dernier fichier de sauvegarde est restauré.

stockage Azure Blob

Si vous définissez AzureBlob comme fournisseur de backup store, fournissez les informations correspondant aux propriétés suivantes :

PropriétéDescription

AZURE_BLOB_ACCOUNT_NAME = <compte de stockage Azure>

Définissez le nom du compte de stockage BLOB Azure.

Conseil :

Vous avez indiqué le nom de ce compte de stockage lorsque vous avez choisi l’option Use Azure Cloud Storage for the configuration and content store (Utiliser le stockage cloud Azure pour l’emplacement de configuration et de contenu) dans le volet Deployment Options (Options de déploiement) de Cloud Builder.

AZURE_BLOB_CONTAINER_NAME = <nom de votre conteneur de stockage BLOB Azure>

Indiquez le nom du conteneur BLOB.

AZURE_BLOB_CREDENTIALTYPE = <accessKey|servicePrincipal|userAssignedIdentity|sasToken>

Définissez le type d’informations d’identification BLOB Azure sur l’une des valeurs suivantes :

  • accessKey : accédez au conteneur à l’aide d’une clé d’accès de compte de stockage.
  • servicePrincipal : accédez au conteneur à l’aide d’un principal de service Azure AD.
  • userAssignedIdentity : accédez au conteneur à l’aide d’une identité managée affectée par un utilisateur Azure.
  • sasToken : accédez au conteneur à l’aide d’une signature d’accès partagée. En général, ces jetons expirent régulièrement et ne sont donc pas recommandés pour la sauvegarde et la restauration automatiques.

La clé, l’identité ou le jeton spécifié doit disposer d’un accès en lecture, en écriture et en filtrage à la ressource de conteneur BLOB Azure que vous spécifiez avec la propriété AZURE_BLOB_CONTAINER_NAME.

AZURE_BLOB_ACCOUNT_KEY = <clé du compte>

Si AZURE_BLOB_CREDENTIALTYPE a pour valeur accessKey, définissez cette propriété sur la clé de compte associée à votre compte Azure Blob Storage.

AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED = false

Laissez cette propriété définie sur false. Si la propriété AZURE_BLOB_CREDENTIALTYPE a pour valeur accessKey lorsque vous exécutez l’outil WebGISDR, l’outil chiffrera la clé d’accès et la clé secrète et définira AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED sur true.

AZURE_BLOB_SP_TENANT_ID

= <ID client Azure>

Si AZURE_BLOB_CREDENTIAL_TYPE a pour valeur servicePrincipal, définissez cette propriété sur l’ID client Azure associé au principal de service.

AZURE_BLOB_SP_CLIENT_ID

= <ID client du principal de service Azure>

Si AZURE_BLOB_CREDENTIAL_TYPE a pour valeur servicePrincipal, définissez cette propriété sur l’ID client du principal de service Azure.

AZURE_BLOB_SP_CLIENT_SECRET_KEY

= <clé secrète du principal de service Azure>

Si AZURE_BLOB_CREDENTIAL_TYPE a pour valeur servicePrincipal, définissez cette propriété sur la clé secrète du principal de service Azure.

AZURE_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED = false

Laissez cette propriété définie sur False. Si la propriété AZURE_BLOB_CREDENTIAL_TYPE est définie sur servicePrincipal lorsque vous exécutez l'outil WebGISDR, ce dernier chiffre la clé d'accès et la clé secrète et définit AZURE_BLOB_SP_CLIENT_SECRET_KEY_ENCRYPTED sur la valeur de la clé d’accès chiffrée.

AZURE_BLOB_USER_MI_CLIENT_ID

= <ID client d’identité managée affectée par l’utilisateur>

Si AZURE_BLOB_CREDENTIAL_TYPE a pour valeur userAssignedIdentity, définissez cette propriété sur l’ID client d’identité managée affectée par l’utilisateur.

AZURE_BLOB_SAS_TOKEN

= <jeton de signature d’accès partagé>

Si AZURE_BLOB_CREDENTIAL_TYPE a pour valeur sasToken, définissez cette propriété sur le jeton de signature d’accès partagé généré depuis Azure. Les jetons SAS ayant généralement une durée de vie éphémère, cette option n’est pas recommandée pour les processus de sauvegarde et de restauration.

AZURE_BLOB_SAS_TOKEN_ENCRYPTED = false

Laissez cette propriété définie sur False. Si AZURE_BLOB_CREDENTIALTYPE a pour valeur sasToken lorsque vous exécutez l’outil WebGISDR, l’outil chiffrera le jeton SAS et définira AZURE_BLOB_SAS_TOKEN_ENCRYPTED sur true.

AZURE_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <extrémité du compte de stockage blob>

Indiquez l’extrémité du compte de stockage.

(Facultatif) AZURE_BLOB_ENDPOINT_URL = <URL de service BLOB>

Spécifiez l’URL de l’extrémité de service BLOB si vous utilisez une extrémité de stockage BLOB personnalisée. Si vous n’utilisez pas d’extrémité personnalisée, ne supprimez pas les marques de commentaire sur cette ligne. L’URL par défaut est au format https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net.

AZURE_BLOB_BACKUP_NAME = <nom du fichier de sauvegarde>

Cette propriété est uniquement utilisée lorsque vous restaurez une organisation ArcGIS Enterprise. Spécifiez le nom du fichier de sauvegarde que vous voulez restaurer. Si vous n'indiquez pas le nom du fichier de sauvegarde, le dernier fichier de sauvegarde est restauré.

Propriétés PKI

Si vous avez configuré une authentification de certificat client reposant sur une infrastructure à clé publique (PKI) pour sécuriser l’accès à votre portail, fournissez les informations requises pour les propriétés suivantes :

PropriétéDescription
IS_PORTAL_PKI_AUTHENTICATED = <true|false>

Si vous avez configuré une infrastructure à clé publique (PKI) pour sécuriser l’accès à votre portail, définissez cette valeur sur true. En savoir plus sur les options d’authentification du portail.

PORTAL_CLIENT_CERTIFICATE_FILE_PATH

= <chemin complet du fichier de certificat>

Indiquez le chemin complet du fichier correspondant au certificat PKI du portail au format PKCS12.

PORTAL_CLIENT_CERTIFICATE_PASSWORD

= <mot de passe du certificat>

Fournissez le mot de passe du certificat PKI.

PORTAL_CLIENT_CERTIFICATE_PASSWORD_ENCRYPTED = false

Lorsque vous saisissez pour la première fois le mot de passe du certificat, conservez la valeur false. Lors de la première exécution de l’outil après avoir enregistré cette valeur, l’outil chiffre le mot de passe et modifie cette propriété en true.

Contenu du portail dans les propriétés Cloud

Si vous stockez votre répertoire de contenu du portail dans un compartiment Amazon S3 ou un conteneur BLOB Azure, vous devez créer un compartiment ou un conteneur de sauvegarde pour le répertoire de contenu. Il ne doit pas s’agir du même compartiment que celui où se trouve le portail, sinon une duplication du contenu se produit à chaque sauvegarde.

Stockage Amazon S3

Si votre organisation ArcGIS Enterprise s’exécute sur AWS et que votre répertoire de contenu du portail est stocké dans Amazon S3, fournissez les informations correspondant aux propriétés suivantes :

Remarque :

Si les machines de votre organisation accèdent à Amazon S3 à l’aide d’une extrémité VPC, la copie entre les régions n’est pas autorisée. Lorsque vous implémentez une redondance géographique, créez un compartiment dans la même région comme compartiment de secours et vérifiez que le compartiment de sauvegarde du contenu du portail exporté est synchronisé avec l’interface de ligne de commande AWS (ou un processus automatisé) avant d’exécuter l’opération d’importation WebGISDR. Ce compartiment répliqué doit être spécifié dans le fichier de restauration webgisdr.properties comme PORTAL_BACKUP_S3_BUCKET avec la région appropriée.

PropriétéDescription

PORTAL_BACKUP_S3_BUCKET = <nom du compartiment>

Spécifiez le nom du compartiment S3 dans lequel vous voulez stocker votre répertoire de contenu du portail.

PORTAL_BACKUP_S3_REGION = <région AWS où le compartiment a été créé>

Spécifiez la région AWS où le compartiment a été créé.

Pour en savoir plus sur ce type d’implémentation, reportez-vous à la rubrique Configurer un portail haute disponibilité avec Amazon S3.

stockage Azure Blob

Si vous stockez votre répertoire de contenu du portail dans un conteneur de stockage BLOB Azure, fournissez les informations correspondant aux propriétés suivantes :

Remarque :

Les valeurs de ces propriétés doivent correspondre à celles définies dans la section des propriétés de stockage BLOB Azure ci-dessus. Les définitions de cette section s’appliquent également ici.

PropriétéDescription

PORTAL_BACKUP_BLOB_ACCOUNT_NAME = <compte de stockage Azure>

Définissez le nom du compte de stockage BLOB Azure.

PORTAL_BACKUP_BLOB_ACCOUNT_KEY = <clé du compte>

Spécifiez la clé du compte associée à votre compte de stockage blob Azure.

PORTAL_BACKUP_ACCOUNT_KEY_ENCRYPTED = false

Lorsque vous ajoutez les valeurs de clé du compte au fichier pour la première fois, indiquez false.

PORTAL_BACKUP_BLOB_CONTAINER_NAME = <nom de votre conteneur de stockage BLOB Azure>

Indiquez le nom du conteneur BLOB.

PORTAL_BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <extrémité du compte de stockage BLOB>

Indiquez l’extrémité du compte de stockage.

(Facultatif) PORTAL_BACKUP_BLOB_ENDPOINT_URL = = <URL du service BLOB personnalisé>

Si vous utilisez une extrémité de stockage BLOB personnalisée, spécifiez l’URL de l’extrémité de service BLOB. Si vous n’utilisez pas d’extrémité personnalisée, ne supprimez pas les marques de commentaire sur cette ligne. L’URL par défaut est au format https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net.

Exemples

Les fichiers de propriétés d’exemple suivants contiennent des scénarios pour chaque option de fournisseur de backup store.

  • Dans cet exemple, une sauvegarde du portail à l’URL https://portalhostname.domain.com:7443/arcgis, plus les services et paramètres de ses serveurs d’hébergement et fédérés, ainsi que les données des couches d’entités hébergées stockées dans le data store relationnel ArcGIS Data Store, sont initialement générés dans des fichiers sur \\\\myserver\\tempbackups. Chaque fichier est compressé dans un seul fichier de sauvegarde (entbackup) et copié sur \\mybuserver\\wgbackups. Les caches des couches de scènes provenant du data store de cache tuilé ArcGIS Data Store ne sont pas inclus, car INCLUDE_SCENE_TILE_CACHES est défini sur false.

    
    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
  • Dans cet exemple, une sauvegarde du portail à l’URL https://portalonaws.mydomain.com:7443/gis, de son répertoire de contenu (stocké dans le paquet S3 portalcontent), des services et paramètres de ses serveurs d’hébergement et fédérés, ainsi que des données stockées dans les data stores relationnels et de caches tuilés est générée dans le paquet S3 entbackups de la région eu-west-1 d’AWS. Le nom du fichier de sauvegarde est fullbackup06June. Un rôle IAM est utilisé pour accéder au compte 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
  • Cet exemple est destiné au stockage blob Microsoft Azure. Une sauvegarde du portail à l’URL https://portalonazure.domain.com:7443/arcgis, de son répertoire de contenu, des services et paramètres de ses serveurs d’hébergement et fédérés, ainsi que des données stockées dans les data stores relationnels et de caches tuilés est générée dans le BLOB Azure 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