ipng/router-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Allow glob of --host and --yaml; cut release 1.2.1

Browse Source
This commit is contained in:
Pim van Pelt
2025-07-06 23:31:41 +02:00
parent fd74c41fb3
commit 9475d7b5c0
5 changed files with 52 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/DETAILS.md
View File

@ -79,16 +79,20 @@ Files are merged automatically using mergo. Later files override earlier ones:
```bash
# Load multiple files - later files override earlier ones
ipng-router-backup --yaml 00-device-types.yaml --yaml config.yaml --yaml overrides.yaml
# Load files using glob patterns
ipng-router-backup --yaml "*.yaml"
ipng-router-backup --yaml "config/*.yaml"
```
## Command Line Usage
### Required Flags
- **`--yaml`**: Path to YAML configuration file(s) (can be repeated)
- **`--yaml`**: Path to YAML configuration file(s) or glob patterns (can be repeated)
### Optional Flags
- **`--output-dir`**: Output directory (default: `/tmp`)
- **`--host`**: Specific hostname(s) to process (can be repeated)
- **`--host`**: Specific hostname(s) or glob patterns to process (can be repeated)
- **`--password`**: SSH password
- **`--key-file`**: SSH private key file path
- **`--port`**: SSH port (default: `22`)
@ -96,14 +100,14 @@ ipng-router-backup --yaml 00-device-types.yaml --yaml config.yaml --yaml overrid
### Examples
```bash
# Basic usage
ipng-router-backup --yaml config.yaml
# Basic usage with glob patterns
ipng-router-backup --yaml "*.yaml"
# Multiple files
ipng-router-backup --yaml 00-device-types.yaml --yaml config.yaml
# Specific devices only
ipng-router-backup --yaml config.yaml --host asw100 --host core-01
# Devices matching patterns
ipng-router-backup --yaml config.yaml --host "asw*" --host "*switch*"
# Custom output directory
ipng-router-backup --yaml config.yaml --output-dir /backup/network

12
docs/ipng-router-backup.1
View File

@ -18,7 +18,7 @@ The tool supports multiple device types with predefined command sets, SSH agent
.SH OPTIONS
.TP
.BR --yaml " \fICONFIG_FILE\fR"
YAML configuration file(s) (required)
YAML configuration file(s) or glob patterns (required)
.TP
.BR --output-dir " \fIDIRECTORY\fR"
Output directory for command output files (default: /tmp)
@ -33,7 +33,7 @@ SSH private key file path
SSH port number (default: 22)
.TP
.BR --host " \fIHOSTNAME\fR"
Specific host(s) to process (can be repeated, processes all if not specified)
Specific host(s) or glob patterns to process (can be repeated, processes all if not specified)
.TP
.BR --help
Show help message
@ -72,9 +72,9 @@ Password authentication (--password option)
For each device, a text file named after the hostname is created in the specified directory. Each command output is prefixed with "## COMMAND: <command_name>" for easy identification.
.SH EXAMPLES
.TP
Basic usage:
Basic usage with glob patterns:
.EX
ipng-router-backup --yaml /etc/ipng-router-backup/*.yaml
ipng-router-backup --yaml "*.yaml"
.EE
.TP
Custom output directory:
@ -87,9 +87,9 @@ Using password authentication:
ipng-router-backup --yaml config.yaml --password mysecretpass
.EE
.TP
Process specific hosts only:
Process hosts matching patterns:
.EX
ipng-router-backup --yaml config.yaml --host asw100 --host asw120
ipng-router-backup --yaml config.yaml --host "asw*" --host "*switch*"
.EE
.SH FILES
.TP