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

Update readme

Browse source
This commit is contained in:
Micke Nordin 2022-10-24 17:55:33 +02:00
parent acd53fdcfa
commit 9791c72a6e
Signed by untrusted user who does not match committer: micke
GPG key ID: 0DA0A7A5708FE257
1 changed files with 57 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -5,60 +5,69 @@ 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
``` ```
usage: knotctl [-h] [--json | --no-json] {add,delete,list,config,update} ... usage: knotctl [-h] [--json | --no-json] {add,config,delete,list,update} ...
positional arguments: {add,delete,list,config,update}
options: positional arguments:
{add,config,delete,list,update}
options:
-h, --help show this help message and exit -h, --help show this help message and exit
--json, --no-json --json, --no-json
``` ```
### Add ### ADD
``` ```
usage: knotctl add [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] -z ZONE usage: knotctl add [-h] -d DATA -n NAME -r RTYPE -t TTL -z ZONE
options:
options:
-h, --help show this help message and exit -h, --help show this help message and exit
-d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -d DATA, --data DATA
-n NAME, --name NAME -n NAME, --name NAME
-r RTYPE, --rtype RTYPE -r RTYPE, --rtype RTYPE
-t TTL, --ttl TTL
-z ZONE, --zone ZONE -z ZONE, --zone ZONE
``` ```
### Delete ### CONFIG
```
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] usage: knotctl config [-h] [-b BASEURL] [-p PASSWORD] [-u USERNAME]
options:
options:
-h, --help show this help message and exit -h, --help show this help message and exit
-b BASEURL, --baseurl BASEURL -b BASEURL, --baseurl BASEURL
-p PASSWORD, --password PASSWORD -p PASSWORD, --password PASSWORD
-u USERNAME, --username USERNAME -u USERNAME, --username USERNAME
``` ```
### Update ### DELETE
``` ```
usage: knotctl update [-h] -d [DATA ...] -n NAME -r RTYPE -z ZONE usage: knotctl delete [-h] [-d DATA] [-n NAME] [-r RTYPE] -z ZONE
options:
options:
-h, --help show this help message and exit -h, --help show this help message and exit
-d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -d DATA, --data DATA
-n NAME, --name NAME -n NAME, --name NAME
-r RTYPE, --rtype RTYPE -r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE -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
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
```
### UPDATE
```
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
```