A simple tool to fetch backups from the pfSense firewall
Project description
Usage
pfsense-backup is a simple tool to fetch configuration backups from the pfSense firewall.
Arguments
- -h, --help
show the help message and exit.
- -c FILE, --config FILE
the configuration file (default: ~/.config/pfsense-backup/config.yml)
- -o FILE, --output FILE
the output file. The file name can contain strftime directives. If the argument is specified, directory, name and keep fields of the configuration are ignored.
Configuration file
The pfsense-backup needs a configuration file (default ~/.config/pfsense-backup/config.yml). As the file contains secrets, take care to set reasonable permissions. The file is in the YAML format.
Configuration file
pfsense:
url: https://pfsense
user: admin
password: ...
ssl_verify: true|false|/path/to/custom_cert.pem
output:
directory: .
name: "pfsense-%Y%m%d-%H%M.xml"
keep: 12
All fields except password are optional.
host is a host name or an IP address.
name specifies the name of the output file. strftime directives are allowed.
keep removes all but the most recent *.xml files from the directory, that in this case has to be specified and has to be an absolute path.
directory has to already exist. As the backup is not encrypted and contains secrets the permissions should be set accordingly.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pfsense_backup-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00965f1b3de058f08a07f7e417f53bb5a16035de2d94d310213aeda2f1b6d807 |
|
MD5 | 5a80432218b1ee79f307fb989e0cd1fb |
|
BLAKE2b-256 | f14b725854ddd66791613bcee4d4a5ceeec0bad5cd5b0960814f36efe5c13b99 |