Backup‐OPNsenseConfig

Synopsis

Backup the OPNsense config.xml file

Syntax

Backup-OPNsenseConfig [-RRDdata] [[-Password] <String>] [<CommonParameters>]

Description

Returns the contents of the config.xml file from the OPNsense server. This file contains all the configuration details and can be used to backup your OPNsense configuration.

Use the Restore-OPNsenseConfig cmdlet to restore the config.xml file to a previous version.

Parameters

-RRDdata   <SwitchParameter>

Include Round Robin Database data in the XML output.

Required?	false
Position?	named
Default Value?
Pipeline Input?	false

-Password   <String>

Encrypt the result with a choosen password.

Required?	false
Position?	0
Default Value?
Pipeline Input?	false

Examples

Basic example

Backup-OPNsenseConfig | Out-File C:\Backups\config.xml

Advanced example

Backup-OPNsenseConfig -RRDdata -Password 'mySecret' | Out-File C:\Backups\config-encrypted.xml