Add ZIA Configuration Backup PowerShell script

ZScaler/ZIA2EIA/Export-ZIAConfigv2.ps1

@@ -0,0 +1,255 @@
+<#
+.SYNOPSIS
+    Zscaler Internet Access (ZIA) Configuration Backup Script
+    Exports ZIA configurations to JSON files
+
+.DESCRIPTION
+    This PowerShell script connects to the Zscaler OneAPI using API key
+    and exports various configuration types to JSON files for backup purposes.
+
+.PARAMETER ApiKey
+    The ZIA API key/token
+
+.PARAMETER BaseUrl
+    The ZIA OneAPI base URL (defaults to production cloud)
+
+.PARAMETER OutputDirectory
+    The output directory for backup files (defaults to the script directory)
+
+.EXAMPLE
+    .\Export-ZIAConfig.ps1 -ApiKey "your-api-key"
+
+.EXAMPLE
+    .\Export-ZIAConfig.ps1 -ApiKey "your-api-key" -BaseUrl "https://api.zscaler.net/platform/v1" -OutputDirectory "C:\Backups\ZIA"
+#>
+
+[CmdletBinding()]
+param(
+    [Parameter(Mandatory = $true)]
+    [string]$ApiKey,
+    [Parameter(Mandatory = $false)]
+    [string]$BaseUrl = "https://api.zscaler.net/platform/v1",
+    [Parameter(Mandatory = $false)]
+    [string]$OutputDirectory = $PSScriptRoot
+)
+
+class ZIABackup {
+    [string]$ApiKey
+    [string]$BaseUrl
+    [hashtable]$Headers
+
+    ZIABackup([string]$ApiKey, [string]$BaseUrl) {
+        $this.ApiKey = $ApiKey
+        $this.BaseUrl = $BaseUrl
+        $this.Headers = @{
+            "ZAPIKEY" = $this.ApiKey
+            "Content-Type" = "application/json"
+        }
+    }
+
+    [bool] Authenticate() {
+        try {
+            Write-Host "Testing Zscaler OneAPI authentication..." -ForegroundColor Gray
+            $testUrl = "$($this.BaseUrl)/status"
+            $response = Invoke-RestMethod -Uri $testUrl -Headers $this.Headers -Method Get
+            if ($response) {
+                Write-Host "Authentication successful!" -ForegroundColor Green
+                return $true
+            } else {
+                Write-Error "Authentication failed: No response from OneAPI endpoint"
+                return $false
+            }
+        }
+        catch {
+            Write-Error "Authentication failed: $($_.Exception.Message)"
+            return $false
+        }
+    }
+
+    [object] BackupUrlFilteringPolicy() {
+        Write-Host "Backing up URL Filtering Policy..." -ForegroundColor Gray
+        return $this.InvokeZIAApi("/urlFilteringRules")
+    }
+
+    [object] BackupUrlCategories() {
+        Write-Host "Backing up URL Categories..." -ForegroundColor Gray
+        return $this.InvokeZIAApi("/urlCategories")
+    }
+
+    [object] BackupSslInspectionPolicy() {
+        Write-Host "Backing up SSL Inspection Policy..." -ForegroundColor Gray
+        return $this.InvokeZIAApi("/sslInspectionRules")
+    }
+
+    [object] BackupFileTypeControl() {
+        Write-Host "Backing up File Type Control Policy..." -ForegroundColor Gray
+        return $this.InvokeZIAApi("/fileTypeRules")
+    }
+
+    [object] BackupFirewallControl() {
+        Write-Host "Backing up Firewall Control Policy..." -ForegroundColor Gray
+        return $this.InvokeZIAApi("/firewallFilteringRules")
+    }
+
+    [object] InvokeZIAApi([string]$Endpoint) {
+        try {
+            $url = "$($this.BaseUrl)$Endpoint"
+            Write-Host "Making API call to: $url" -ForegroundColor Gray
+            $response = Invoke-RestMethod -Uri $url -Method Get -Headers $this.Headers
+            if ($response) {
+                if ($response -is [array]) {
+                    Write-Host "API call successful - Retrieved $($response.Count) items from $Endpoint" -ForegroundColor Gray
+                } elseif ($response.PSObject.Properties['list'] -and $response.list -is [array]) {
+                    Write-Host "API call successful - Retrieved $($response.list.Count) items from $Endpoint" -ForegroundColor Gray
+                } else {
+                    Write-Host "API call successful - Retrieved data from $Endpoint" -ForegroundColor Gray
+                }
+            } else {
+                Write-Host "API call successful but no data returned from $Endpoint" -ForegroundColor Yellow
+            }
+            return $response
+        }
+        catch {
+            Write-Warning "Failed to retrieve data from $Endpoint : $($_.Exception.Message)"
+            Write-Host "API call error details for $Endpoint" -ForegroundColor Red
+            Write-Host "Error type: $($_.Exception.GetType().Name)" -ForegroundColor Red
+            if ($_.Exception.Response) {
+                Write-Host "HTTP Status Code: $($_.Exception.Response.StatusCode)" -ForegroundColor Red
+                Write-Host "HTTP Status Description: $($_.Exception.Response.StatusDescription)" -ForegroundColor Red
+            }
+            return $null
+        }
+    }
+
+    [bool] FullBackup([string]$OutputDir) {
+        Write-Host "Starting full backup process..." -ForegroundColor Gray
+        if (-not $this.Authenticate()) {
+            Write-Host "Full backup cancelled due to authentication failure" -ForegroundColor Red
+            return $false
+        }
+        # Create output directory with timestamp
+        $timestamp = Get-Date -Format "yyyyMMdd_HHmmss"
+        $backupDir = "$OutputDir`_$timestamp"
+        Write-Host "Creating backup directory: $backupDir" -ForegroundColor Gray
+        if (-not (Test-Path $backupDir)) {
+            New-Item -ItemType Directory -Path $backupDir -Force | Out-Null
+            Write-Host "Backup directory created successfully" -ForegroundColor Gray
+        } else {
+            Write-Host "Backup directory already exists" -ForegroundColor Yellow
+        }
+        Write-Host "Starting ZIA configuration backup..." -ForegroundColor Yellow
+        Write-Host "Backup timestamp: $timestamp" -ForegroundColor Gray
+        # Backup configurations
+        Write-Host "Initializing configuration backup operations..." -ForegroundColor Gray
+        $configs = @{
+            "url_filtering_policy" = $this.BackupUrlFilteringPolicy()
+            "url_categories" = $this.BackupUrlCategories()
+            "ssl_inspection_policy" = $this.BackupSslInspectionPolicy()
+            "file_type_control" = $this.BackupFileTypeControl()
+            "firewall_control" = $this.BackupFirewallControl()
+        }
+        Write-Host "Configuration data collection completed. Starting file export..." -ForegroundColor Gray
+        # Track backup statistics
+        $successCount = 0
+        $failureCount = 0
+        $totalConfigs = $configs.Keys.Count
+        # Save individual files
+        foreach ($configName in $configs.Keys) {
+            $configData = $configs[$configName]
+            if ($configData) {
+                try {
+                    $filename = Join-Path $backupDir "$configName.json"
+                    Write-Host "Writing $configName to file: $filename" -ForegroundColor Gray
+                    $configData | ConvertTo-Json -Depth 10 | Out-File -FilePath $filename -Encoding UTF8
+                    # Verify file was created and get size
+                    if (Test-Path $filename) {
+                        $fileSize = (Get-Item $filename).Length
+                        Write-Host "Saved $configName to $filename (Size: $fileSize bytes)" -ForegroundColor Green
+                        $successCount++
+                    } else {
+                        Write-Warning "File was not created for $configName"
+                        $failureCount++
+                    }
+                }
+                catch {
+                    Write-Warning "Failed to save $configName : $($_.Exception.Message)"
+                    $failureCount++
+                }
+            }
+            else {
+                Write-Warning "No data retrieved for $configName"
+                $failureCount++
+            }
+        }
+        Write-Host "Individual file export completed. Successfully saved: $successCount/$totalConfigs configurations" -ForegroundColor Gray
+        # Save complete backup
+        Write-Host "Creating complete backup file..." -ForegroundColor Gray
+        $completeBackup = @{
+            "timestamp" = $timestamp
+            "backup_type" = "ZIA_Configuration"
+            "configurations" = $configs
+        }
+        try {
+            $completeFilename = Join-Path $backupDir "zia_complete_backup.json"
+            Write-Host "Writing complete backup to: $completeFilename" -ForegroundColor Gray
+            $completeBackup | ConvertTo-Json -Depth 10 | Out-File -FilePath $completeFilename -Encoding UTF8
+            # Verify complete backup file
+            if (Test-Path $completeFilename) {
+                $fileSize = (Get-Item $completeFilename).Length
+                Write-Host "Complete ZIA backup saved to $completeFilename (Size: $fileSize bytes)" -ForegroundColor Green
+            } else {
+                Write-Warning "Complete backup file was not created"
+                return $false
+            }
+        }
+        catch {
+            Write-Error "Failed to create complete backup file: $($_.Exception.Message)"
+            return $false
+        }
+        Write-Host "Backup operation summary:" -ForegroundColor Gray
+        Write-Host "- Total configurations: $totalConfigs" -ForegroundColor Gray
+        Write-Host "- Successful backups: $successCount" -ForegroundColor Gray
+        Write-Host "- Failed backups: $failureCount" -ForegroundColor Gray
+        Write-Host "- Backup directory: $backupDir" -ForegroundColor Gray
+        Write-Host "Backup completed successfully!" -ForegroundColor Green
+        return $true
+    }
+}
+
+# Main execution
+try {
+    Write-Host "ZIA Configuration Backup Script" -ForegroundColor Cyan
+    Write-Host "================================" -ForegroundColor Cyan
+    Write-Host "Script started at: $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss')" -ForegroundColor Gray
+    Write-Host "Validating input parameters..." -ForegroundColor Gray
+    Write-Host "Base URL: $BaseUrl" -ForegroundColor Gray
+    Write-Host "Output Directory: $OutputDirectory" -ForegroundColor Gray
+    Write-Host "API Key: [PROTECTED]" -ForegroundColor Gray
+    Write-Host "Creating ZIA backup instance..." -ForegroundColor Gray
+    $backup = [ZIABackup]::new($ApiKey, $BaseUrl)
+    Write-Host "ZIA backup instance created successfully" -ForegroundColor Gray
+    Write-Host "Initiating backup process..." -ForegroundColor Gray
+    $success = $backup.FullBackup($OutputDirectory)
+    if ($success) {
+        Write-Host "`nBackup process completed successfully!" -ForegroundColor Green
+        Write-Host "Script execution finished at: $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss')" -ForegroundColor Gray
+        exit 0
+    }
+    else {
+        Write-Error "Backup process failed!"
+        Write-Host "Script execution failed at: $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss')" -ForegroundColor Red
+        exit 1
+    }
+}
+catch {
+    Write-Error "Script execution failed: $($_.Exception.Message)"
+    Write-Host "Error occurred at: $(Get-Date -Format 'yyyy-MM-dd HH:mm:ss')" -ForegroundColor Red
+    Write-Host "Error type: $($_.Exception.GetType().Name)" -ForegroundColor Red
+    Write-Host "Error details: $($_.Exception.ToString())" -ForegroundColor Red
+    if ($_.Exception.InnerException) {
+        Write-Host "Inner exception: $($_.Exception.InnerException.Message)" -ForegroundColor Red
+    }
+    Write-Host "Stack trace:" -ForegroundColor Red
+    Write-Host $_.ScriptStackTrace -ForegroundColor Red
+    exit 1
+}