Skip to content
Snippets Groups Projects
Commit 7e41041b authored by Florent Gluck's avatar Florent Gluck
Browse files

Updated README.md so it is up-to-date.

parent 46ca7192
No related branches found
No related tags found
No related merge requests found
Showing
with 44 additions and 44 deletions
......@@ -35,31 +35,31 @@ Usage: nexus-client CMD
CMD is the Command to run. Except for "login", all Commands require an access token.
The access token is read from the env. variable "NEXUS_TOKEN".
List of supported Commands:
login Login and obtain an access token
whoami Display the current user's details
passwd Update the current user's password
user_list List one or all users
user_add Add a user
user_del Delete one or more users
user_setcaps Set a user's capabilities
vmlist List one or more VMs
vmlist_start List VMs that can be started
vmlist_attach List VMs that can be attached to
vmlist_stop List VMs that can be stopped
vmlist_edit List VMs that can be edited
vmlist_editaccess List VMs that can have their VM access edited
vmlist_del List VMs that can be deleted
vm_start Start a VM
vm_stop Stop a VM
vm_attach Attach to a VM in order to see its desktop
vm_create Create a VM
vm_edit Create a VM
vm_del Delete one or more VMs
vm_setaccess Set a VM Access for a given user
vm_delaccess Delete VM Access for a given user
tpl_list List one or more templates
tpl_create Create a template
tpl_del Delete one or more templates
login Login and obtain an access token.
whoami Display the authenticated user's details.
passwd Update the current user's password.
user_list List users (regex matching).
user_add Add a user.
user_del Delete one or more users.
user_setcaps Set a user's capabilities.
vmlist List VMs that can be listed (regex matching).
vmlist_start List VMs that can be started (regex matching).
vmlist_attach List VMs that can be attached to (regex matching).
vmlist_stop List VMs that can be stopped (regex matching).
vmlist_edit List VMs that can be edited (regex matching).
vmlist_editaccess List VMs that can have their VM access edited (regex matching).
vmlist_del List VMs that can be deleted (regex matching).
vm_start Start one or more VMs (regex matching).
vm_stop Stop one or more VMs (regex matching).
vm_attach Attach to a VM in order to use its desktop environment.
vm_create Create one or more VMs.
vm_edit Edit a VM's properties: name, cpus, ram or nic (regex matching).
vm_del Delete one or more VMs (regex matching).
vm_setaccess Set the VM access for a given user.
vm_delaccess Delete the VM access for a given user.
tpl_list List available templates (regex matching).
tpl_create Create a template.
tpl_del Delete one or more templates.
```
### Compiling nexus-client
......
......@@ -19,7 +19,7 @@ func (cmd *Login)GetName() string {
}
func (cmd *Login)GetDesc() string {
return "Login and obtain an access token"
return "Login and obtain an access token."
}
func (cmd *Login)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *Create)GetName() string {
}
func (cmd *Create)GetDesc() string {
return "Create a template"
return "Create a template."
}
func (cmd *Create)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *Del)GetName() string {
}
func (cmd *Del)GetDesc() string {
return "Delete one or more templates"
return "Delete one or more templates."
}
func (cmd *Del)PrintUsage() {
......
......@@ -9,7 +9,7 @@ func (cmd *List)GetName() string {
}
func (cmd *List)GetDesc() string {
return "List available templates"
return "List available templates (regex matching)."
}
func (cmd *List)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *Add)GetName() string {
}
func (cmd *Add)GetDesc() string {
return "Add a user"
return "Add a user."
}
func (cmd *Add)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *Del)GetName() string {
}
func (cmd *Del)GetDesc() string {
return "Delete one or more users"
return "Delete one or more users."
}
func (cmd *Del)PrintUsage() {
......
......@@ -9,7 +9,7 @@ func (cmd *List)GetName() string {
}
func (cmd *List)GetDesc() string {
return "List users"
return "List users (regex matching)."
}
func (cmd *List)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *SetCaps)GetName() string {
}
func (cmd *SetCaps)GetDesc() string {
return "Set a user's capabilities"
return "Set a user's capabilities."
}
func (cmd *SetCaps)PrintUsage() {
......
......@@ -19,7 +19,7 @@ func (cmd *UpdatePwd)GetName() string {
}
func (cmd *UpdatePwd)GetDesc() string {
return "Update the current user's password"
return "Update the current user's password."
}
func (cmd *UpdatePwd)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *Whoami)GetName() string {
}
func (cmd *Whoami)GetDesc() string {
return "Display the authenticated user's details"
return "Display the authenticated user's details."
}
func (cmd *Whoami)PrintUsage() {
......
......@@ -21,7 +21,7 @@ func (cmd *Attach)GetName() string {
}
func (cmd *Attach)GetDesc() string {
return "Attach to a VM in order to use its desktop environment"
return "Attach to a VM in order to use its desktop environment."
}
func (cmd *Attach)PrintUsage() {
......
......@@ -15,7 +15,7 @@ func (cmd *Create)GetName() string {
}
func (cmd *Create)GetDesc() string {
return "Create one or more VMs"
return "Create one or more VMs."
}
func (cmd *Create)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *Del)GetName() string {
}
func (cmd *Del)GetDesc() string {
return "Delete one or more VMs."
return "Delete one or more VMs (regex matching)."
}
func (cmd *Del)PrintUsage() {
......
......@@ -14,7 +14,7 @@ func (cmd *DelAccess)GetName() string {
}
func (cmd *DelAccess)GetDesc() string {
return "Delete the VM Access for a given user"
return "Delete the VM access for a given user."
}
func (cmd *DelAccess)PrintUsage() {
......
......@@ -24,7 +24,7 @@ func (cmd *Edit)GetName() string {
}
func (cmd *Edit)GetDesc() string {
return "Edit a VM's properties (name, cpus, ram or nic)"
return "Edit a VM's properties: name, cpus, ram or nic (regex matching)."
}
func (cmd *Edit)PrintUsage() {
......
......@@ -9,7 +9,7 @@ func (cmd *List)GetName() string {
}
func (cmd *List)GetDesc() string {
return "List VMs that can be listed"
return "List VMs that can be listed (regex matching)."
}
func (cmd *List)PrintUsage() {
......
......@@ -9,7 +9,7 @@ func (cmd *ListAttach)GetName() string {
}
func (cmd *ListAttach)GetDesc() string {
return "List VMs that can be attached to"
return "List VMs that can be attached to (regex matching)."
}
func (cmd *ListAttach)PrintUsage() {
......
......@@ -9,7 +9,7 @@ func (cmd *ListDel)GetName() string {
}
func (cmd *ListDel)GetDesc() string {
return "List VMs that can be deleted"
return "List VMs that can be deleted (regex matching)."
}
func (cmd *ListDel)PrintUsage() {
......
......@@ -9,7 +9,7 @@ func (cmd *ListEdit)GetName() string {
}
func (cmd *ListEdit)GetDesc() string {
return "List VMs that can be edited"
return "List VMs that can be edited (regex matching)."
}
func (cmd *ListEdit)PrintUsage() {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment