knotctl/README.md

74 lines
1.6 KiB
Markdown
Raw Normal View History

2022-10-24 09:10:09 +00:00
# knotctl
This is a commandline tool for knotapi
2022-10-24 13:28:51 +02:00
https://gitlab.nic.cz/knot/knot-dns-rest
## Usage
```
2022-10-24 17:55:33 +02:00
usage: knotctl [-h] [--json | --no-json] {add,config,delete,list,update} ...
positional arguments:
{add,config,delete,list,update}
options:
-h, --help show this help message and exit
--json, --no-json
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
### ADD
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
usage: knotctl add [-h] -d DATA -n NAME -r RTYPE -t TTL -z ZONE
options:
-h, --help show this help message and exit
-d DATA, --data DATA
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-t TTL, --ttl TTL
-z ZONE, --zone ZONE
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
### CONFIG
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
usage: knotctl config [-h] [-b BASEURL] [-p PASSWORD] [-u USERNAME]
options:
-h, --help show this help message and exit
-b BASEURL, --baseurl BASEURL
-p PASSWORD, --password PASSWORD
-u USERNAME, --username USERNAME
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
### DELETE
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
usage: knotctl delete [-h] [-d DATA] [-n NAME] [-r RTYPE] -z ZONE
options:
-h, --help show this help message and exit
-d DATA, --data DATA
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
### LIST
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
usage: knotctl list [-h] [-d DATA] [-n NAME] [-r RTYPE] [-z ZONE]
options:
-h, --help show this help message and exit
-d DATA, --data DATA
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
### UPDATE
2022-10-24 13:28:51 +02:00
```
2022-10-24 17:55:33 +02:00
usage: knotctl update [-h] -d DATA -n NAME -r RTYPE -t TTL -z ZONE
options:
-h, --help show this help message and exit
-d DATA, --data DATA
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-t TTL, --ttl TTL
-z ZONE, --zone ZONE
2022-10-24 13:28:51 +02:00
```