Knowledge base

Für Opnsense kann man vieles über die Rest-API steuern. Um das Download der Config via Rest-API zu ermöglichen muss man das Plugin "os-api-backup" installieren.

Für den Benutzer root erstellt man einen neuen API-Key. Dabei erhält man man Key und Secret, diese trägt man in folgendes Powershellscript ein:

add-type @"
using System.Net;
using System.Security.Cryptography.X509Certificates;
public class TrustAllCertsPolicy : ICertificatePolicy {
    public bool CheckValidationResult(
        ServicePoint srvPoint, X509Certificate certificate,
        WebRequest request, int certificateProblem) {
        return true;
    }
}
"@
[System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy

$key="rlvyQT7hQxDfCPe/JkZAozToIIeB4qSA0pYEjE9RIy6CxeJY5jTUGQtEUPyZC+5Uy32WCFh/5rtmh7nZ"
$secret="Eud10bBJTXhqDdLo4GfIWRMuSmiKEUTPoIp/JmHNlXpjzd2VA7RR1GLMUgEyKASIrWYDFBKm0zEtnEcO"

$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("$($key):$($secret)"))
$Header = @{
    Authorization = "Basic $base64AuthInfo"
}

$Parameters = @{
    Method      = "GET"
    Uri         = "https://192.168.1.1/api/backup/backup/download"
    Headers     = $Header
}
$download = Invoke-RestMethod @Parameters
$download.Save("c:\opnsense\backup\download.xml")

Jetzt kann man mit via Powershell die Werte auslesen da der Rückgabewert ein XML ist. Z.b. seine ersten OpenVPN Settings:

$download.opnsense.openvpn.'openvpn-server'[0]

• Dokumentation: https://docs.opnsense.org/development/api/plugins/backup.html