Skip to content
Snippets Groups Projects

WIP: Develop

Merged Malte Bauch requested to merge develop into master
1 file
+ 31
8
Compare changes
  • Side-by-side
  • Inline
+ 31
8
@@ -6,6 +6,8 @@ The goSDN CLI allows for management of the goSDN controller, and through it dire
## Command tree overview:
+ `gosdnc`
+ `login`
+ `logout`
+ `change`
+ `commit`
+ `confirm`
@@ -18,7 +20,6 @@ The goSDN CLI allows for management of the goSDN controller, and through it dire
+ `remove (alias rm)`
+ `set`
+ `show`
+ `init`
+ `list (alias ls)`
+ `pnd`
+ `create`
@@ -26,19 +27,24 @@ The goSDN CLI allows for management of the goSDN controller, and through it dire
+ `list (alias ls)`
+ `remove (alias rm)`
+ `use`
+ `userCreate`
+ `userDelete`
+ `userGet`
+ `userGetAll`
+ `userUpdate`
***
## Usage
To use the CLI, the `init` command must be called once,
with the `--controller` parameter specifying the target goSDN controller.
This value is persisted for all following commands and can be changed by calling `init` again.
If the parameter is not specified, the default `gosdn-develop.apps.ocp.fbi.h-da.de:55055` will be used.
To use the CLI, the `login` command must be called, with the `--controller` parameter specifying the target goSDN controller (\<IP:Port\>) and providing correct credentials.
The set controller address and recieved access token will be persisted for all following commands and can be changed by calling `login` again. If the `--controller` parameter is not specified, the default set in gosdnc.toml (`gosdn-develop.apps.ocp.fbi.h-da.de:55055`) will be used.
Command help is available via the --help flag for each command, or via the `gosdnc help` command.
### Examples
To initialize the CLI for a locally running goSDN controller:
`gosdnc init --controller 127.0.0.1:55055`
`gosdnc login --controller 127.0.0.1:55055 --u name --p password`
#### Device
@@ -75,4 +81,21 @@ To get the UUID information:
`gosdnc list`
To switch to the created PND:
`gosdnc pnd use *appropriate UUID here*`
\ No newline at end of file
`gosdnc pnd use *appropriate UUID here*`
#### User
To create an additional user:
`gosdnc userCreate --u name --p password --r role`
To delete an existing user:
`gosdnc userDelete --u name`
To fetch information about a user:
`gosdnc userGet --u name`
To fetch all available users:
`gosdnc userGetAll`
To update an existing user:
`gosdnc userUpdate --i <UUID of user> --u name --p password --r role`
Loading