WebGISDR tool output file

The WebGISDR tool supports an output file that will record the results of the operation as JSON that can be parsed to determine whether the backup is located, if any components failed, and how long each component took.

The output file can be parsed by using, for example, the ConvertFrom-Json cmdlet in PowerShell or Python. The JSON structure will contain a section for the operation that was run, whether the operation succeeded or failed, the elapsed time of the operation, and the location of the backup that was created or restored. It will also contain a results object that will store the results of each component.

Output file format

The following table describes the key-value pairs for the parent JSON object in the output file:

Key	Value
backupLocation	Path to the backup that was created or restored.
backupLocationType	Where the backup is stored, either on the file system or cloud storage.
messages	Any informational messages regarding the backup or restore operation. This will store the reason why the restore failed.
operation	The operation that was run, either backup or restore.
results	A JSON array that stores the results of each component backups.
status	The result of the operation, either success or failure.
elapsedTime	The total duration of the operation.
zipTime	The time taken to zip the backup. Applicable when storing the backup file on the file system.
unzipTime	The time taken to unzip the backup. Applicable when storing the backup file on the file system.
uploadTime	The time taken to upload the backup to cloud storage. Applicable when storing the backup file in cloud storage.
downloadTime	The time taken to download the backup from cloud storage. Applicable when storing the backup file in cloud storage.

The following table describes the key-value pairs for each component:

Key	Value
name	The name of the component.
messages	Any informational messages regarding the backup or restore operation. This will store the reason why the restore failed.
URL	The URL for the component.
status	The result of the operation, either success or failure.
elapsedTime	The total duration of the operation for the component.

Sample outputs

The following is an example of a backup of a base deployment with an additional federated server:

{
	"backupLocation": "\\\\backupServer\\backups\\full\\20221123-133229-PST-FULL.webgissite",
	"backupLocationType": "FileSystem",
	"messages": "",
	"operation": "restore",
	"results": [{
			"name": "Portal for ArcGIS",
			"messages": "",
			"URL": "https://portal.domain.com/portal",
			"status": "success",
			"elapsedTime": "00hr:07min:55sec"
		},
		{
			"name": "ArcGIS Server",
			"messages": "",
			"URL": "https://server.domain.com/server",
			"status": "success",
			"elapsedTime": "00hr:01min:07sec"
		},
		{
			"name": "ArcGIS Server",
			"messages": "",
			"URL": "https://server.domain.com/server",
			"status": "success",
			"elapsedTime": "00hr:01min:10sec"
		},
		{
			"storeType": "relational",
			"name": "ArcGIS Data Store",
			"messages": "",
			"URL": "https://datastore.domain.com:2443/arcgis",
			"status": "success",
			"elapsedTime": "00hr:03min:20sec"
		},
		{
			"storeType": "tileCache",
			"name": "ArcGIS Data Store",
			"messages": "",
			"URL": "https://datastore.domain.com:2443/arcgis",
			"status": "success",
			"elapsedTime": "00hr:00min:15sec"
		}
	],
	"status": "success",
	"elapsedTime": "00hr:13min:24sec",
	"zipTime": "00hr:00min:16sec"
}