Use PowerShell DSC ArcGIS Module to create ArcGIS Enterprise backups and restores with the WebGISDR tool - Esri/arcgis-powershell-dsc GitHub Wiki

Overview

Starting at version 4.3.0, the PowerShell DSC Module for ArcGIS supports ArcGIS Enterprise exports (backups) and imports (restores) using the Web GIS Disaster Recovery (WebGISDR) tool . To find out what is included in the backup visit ArcGIS Enterprise backups web help documentation.

This functionality not only allows users to deploy their disaster recovery sites using the PowerShell DSC Module for ArcGIS, but it enables them to be able to automatically import backups of ArcGIS Enterprise into their disaster recovery systems or export a backup of an existing ArcGIS Enterprise environment.

Pre-Requisites:

• Create a webgisdr.properties file and store it on the Portal for ArcGIS node.
  • Ensure the ConfigData.Portal.WebGISDR.RunAsAccount.UserName has access to this webgisdr.properties file.
  • Please visit our WebGISDR tool properties file web help documentation for details about the properties included in this file and their descriptions.
• Modify JSON Configuration file to include the ConfigData.Portal.WebGISDR object block. Additional attributes for this object can be found on the variables reference page.
  • Example usage:

    "ConfigData": {
        "Portal": {
            "WebGISDR": {
                "PropertiesFilePath": "[WebGISDR Properties File Path]",
                "TimeoutInMinutes": 3600,
                "RunAsAccount":{
                    "UserName": "[RunAsAccount Username]",
                    "Password": "[RunAsAccount Password]",
                    "isDomainAccount": false
                }
            }   
        }
    }
    

• Ensure all ArcGIS Enterprise components can read/write to the SHARED_LOCATION defined in the webgisdr.properties file.

Perform a Webgisdr Export or Import with PowerShell DSC Module for ArcGIS

Once all the pre-requisites are complete, it's time to run the Invoke-ArcGISConfiguration cmdlet to export or import webgisdr. Depending on which operation you desire, will determine the -Mode argument that will be used in the Invoke-ArcGISConfiguration cmdlet.

For webgisdr export operations, use the -Mode WebGISDRExport argument. For example:

Invoke-ArcGISConfiguration -ConfigurationParametersFile [Path to Configuration json File](/Esri/arcgis-powershell-dsc/wiki/Path-to-Configuration-json-File) -Mode WebGISDRExport -Credential [Config RunAs - Optional] 

For webgisdr import operations, use the -Mode WebGISDRImport argument. For example:

Invoke-ArcGISConfiguration -ConfigurationParametersFile [Path to Configuration json File](/Esri/arcgis-powershell-dsc/wiki/Path-to-Configuration-json-File) -Mode WebGISDRImport -Credential [Config RunAs - Optional]