CLI: Update group operation usage

This commit is contained in:
Orsiris de Jong 2024-10-30 16:24:35 +01:00
parent f315754f79
commit 88b641f6c1
2 changed files with 10 additions and 5 deletions

View file

@ -14,7 +14,7 @@
- Group settings for repositories - Group settings for repositories
- Operation center - Operation center
- GUI operation center allowing to mass execute actions on repos / groups - GUI operation center allowing to mass execute actions on repos / groups
- CLI operation center via `--group-operation --repo-group=somegroup` - CLI operation center via `--repo-group=somegroup` or `--repo-name repo1,repo2`
- Implemented retention policies - Implemented retention policies
- Optional time server update to make sure we don't drift before doing retention operations - Optional time server update to make sure we don't drift before doing retention operations
- Operation planifier allows to create scheduled tasks for operations - Operation planifier allows to create scheduled tasks for operations

View file

@ -202,11 +202,16 @@ While admin user experience is important, NPBackup also offers a GUI for end use
`npbackup-cli` has all the functions the GUI has, and can run on any headless server. `npbackup-cli` has all the functions the GUI has, and can run on any headless server.
It also has a `--json` parameter which guarantees parseable output. It also has a `--json` parameter which guarantees parseable output.
`--group-operation [operation]` allows to run an operation on multiple repos. This paramater also requires `--repo-group` or `--repo-name` parameter. For operations requiring arguments, provide the argument to the original operation parameter. You may run operations on multiple repositories, or repositories groups by specifying paramater `--repo-group` or `--repo-name`.
`--repo-name` allows to specify one or multiple comma separated repo names `--repo-name` allows to specify one or multiple comma separated repo names, also allows special `__all__` argument which selects all repositories.
`--repo-group` allows to specify one or multiple comme separated repo group names `--repo-group` allows to specify one or multiple comme separated repo group names, also allows special `__all__` argument which selects all groups.
`npbackup-gui` can also act as cli if run with `--run-as-cli` parameter, allowing to use a single executable for GUI and tasks. Multi-repo example:
```
npbackup-cli --housekeeping --repo-group default_group
```
`npbackup-gui` can also act as cli if run with `--run-as-cli` parameter, allowing to use a single executable as GUI and scheduled tasks.
## Security ## Security