micke/knotctl
1
0
Fork 0
Code Issues 1 Pull requests 1 Projects Releases 10 Packages Wiki Activity Actions

Expand readme

Browse source
This commit is contained in:
Micke Nordin 2022-10-24 13:28:51 +02:00
parent 448306869f
commit 0db9475256
Signed by untrusted user who does not match committer: micke
GPG key ID: 0DA0A7A5708FE257
1 changed files with 27 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -2,4 +2,30 @@
This is a commandline tool for knotapi
https://gitlab.nic.cz/knot/knot-dns-rest
https://gitlab.nic.cz/knot/knot-dns-rest
## Usage
```
usage: knotctl [-h] [--json | --no-json] {add,delete,list,config,update} ... positional arguments: {add,delete,list,config,update} options: -h, --help show this help message and exit --json, --no-json
```
### Add
```
usage: knotctl add [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] -z ZONE options: -h, --help show this help message and exit -d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE
```
### Delete
```
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 ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE
```
### List
```
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 ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE
```
### Config
```
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
```
### Update
```
usage: knotctl update [-h] -d [DATA ...] -n NAME -r RTYPE -z ZONE options: -h, --help show this help message and exit -d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE
```