pfSense_API Alternatives

pfSense_API reviews and mentions

• pfSense configuration backup
  2 projects | /r/PowerShell | 18 Jun 2022

  <# .Synopsis Get pfSense configuration .DESCRIPTION Get a copy of pfsense configuration XML file. .EXAMPLE $splat = @{ Uri = 'https://30.20.10.0:54321' Username = 'admin' Password = 'pfsense' } $session = Connect-PfSense @splat Get-PfSenseConfig -Session $session .EXAMPLE # You can pipe both commands to save you some typing $splat = @{ Uri = 'https://30.20.10.0:54321' Username = 'admin' Password = 'pfsense' } Connect-PfSense @splat | Get-PfSenseConfig .EXAMPLE # If you want to save the file with filename supplied by pfSense $splat = @{ Uri = 'https://30.20.10.0:54321' Username = 'admin' Password = 'pfsense' } Connect-PfSense @splat -SkipCertificateCheck | Get-PfSenseConfig -Object | % { $_.config | Set-Content $_.filename } .INPUTS Session object from Connect-PfSense .OUTPUTS String .NOTES Based on the work of Chris, https://github.com/masters274/pfSense_API MIT license. Author: poshftw, 2022 #> function Get-PfSenseConfig { [CmdletBinding()] [Alias()] [OutputType([string])] Param ( # Session object from Connect-PfSense [Parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0)] $Session, # Output as an object @{FileName, Config} [switch]$Object ) $wrUri = '{0}/diag_backup.php' -f $Session.Uri $webRequestSplat = @{ ErrorAction = 'Stop' } if ($Session.SkipCertificateCheck) { $webRequestSplat.Add('SkipCertificateCheck', $true) } try { $request = Invoke-WebRequest -Uri $wruri -Method Get -WebSession $Session.Session @webRequestSplat $Body = @{ __csrf_magic = $request.InputFields[0].Value donotbackuprrd = 'yes' download = 'Download configuration as XML' } $request = Invoke-WebRequest -Uri $wrUri -Method Post -Body $Body -WebSession $Session.Session @webRequestSplat # check received data if ($request.Headers['Content-Type'] -match 'application/octet-stream') { # pfsense supplies filename by itself # but dear Redmond, why do we need those ugly join hacks? $null = $request.Headers['Content-Disposition'] -join '' -match 'filename=(?.+\.xml)' $filename = $Matches['filename'] #convert from bytes $Encoder = [System.Text.Encoding]::ASCII $Config = $Encoder.GetString($request.Content) if ($Object) { [PSCustomObject][ordered]@{ Filename = $filename Config = $Config } } else{ $Config } } elseif ($request.Headers['Content-Type'] -match 'html') { $thisErrorMessage = ("Operation failed, probably wrong credentials: {0}" -f $Error[0]) } else { $thisErrorMessage = ("Unknown error has occured: {0}" -f $Error[0]) } } catch { $Error[0] Write-Error -Message $thisErrorMessage } }