[wip] Describe actionmap

This commit is contained in:
ljf 2018-08-31 18:28:08 +02:00
parent dfd1a8b1a6
commit 04cc1184e4

View file

@ -920,6 +920,90 @@ backup:
extra:
pattern: *pattern_backup_archive_name
subcategories:
repository:
subcategory_help: Manage backup repositories
actions:
### backup_repository_list()
list:
action_help: List available repositories where put archives
api: GET /backup/repositories
arguments:
name:
help: Name of the repository
extra:
pattern: *pattern_backup_repo_name
### backup_repository_info()
info:
action_help: Show info about a repository
api: GET /backup/repositories
arguments:
-H:
full: --human-readable
help: Print sizes in human readable format
action: store_true
--space-used:
help: Display size used
action: store_true
### backup_repository_add()
add:
action_help: Add a backup repository
api: POST /backup/repository/<name>
configuration:
authenticate: all
authenticator: ldap-anonymous
arguments:
path:
help: Path eventually on another server
extra:
pattern: *pattern_backup_repo_path
-n:
full: --name
help: Name of the repository
extra:
pattern: *pattern_backup_repo_name
-d:
full: --description
help: Short description of the repository
--methods:
help: List of backup methods accepted
nargs: "*"
-q:
full: --quota
help: Quota to configure with this repository
--no-encryption:
help: If distant don't encrypt
### backup_repository_update()
update:
action_help: Update a backup repository
api: PUT /backup/repository/<name>
arguments:
-d:
full: --description
help: Short description of the repository
-q:
full: --quota
help: Quota to configure with this repository
-p:
full: --password
help: Change password
extra:
password: ask__password
pattern: *pattern_password
### backup_repository_remove()
remove:
action_help: Remove a backup repository
api: DELETE /backup/repository/<name>
arguments:
name:
help: Name of the backup repository to remove
extra:
pattern: *pattern_backup_repo_name
#############################
# Monitor #