GraceSolutions
68e6819131
- Added Get-OPNSenseConfig cmdlet that retrieves the OPNSense configuration as an XML document - Updated Restore-OPNSenseConfig to accept an XML document from the pipeline or as a parameter - Changed Export-OPNSenseConfig and Import-OPNSenseConfig to use System.IO.FileInfo for the Path parameter - Removed Backup-OPNSenseConfig cmdlet (use Get-OPNSenseConfig instead) - Updated documentation and examples
1.7 KiB
Export-OPNSenseConfig
SYNOPSIS
Exports the OPNSense firewall configuration.
SYNTAX
Export-OPNSenseConfig -Path <FileInfo> [-Force]
DESCRIPTION
The Export-OPNSenseConfig cmdlet exports the OPNSense firewall configuration to a file.
EXAMPLES
Example 1: Export the configuration to a file
$path = New-Object System.IO.FileInfo "C:\Backups\opnsense-config.xml"
Export-OPNSenseConfig -Path $path
This example exports the OPNSense firewall configuration to a file.
PARAMETERS
-Path
The path to save the configuration file. Must be a FileInfo object with an .xml extension.
Type: FileInfo
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Overwrites the file if it exists.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
None
NOTES
This cmdlet requires a connection to an OPNSense firewall. Use Connect-OPNSense to establish a connection. If the directory specified in the Path parameter does not exist, it will be created.
RELATED LINKS
Get-OPNSenseConfig Import-OPNSenseConfig Restore-OPNSenseConfig