diff --git a/README.md b/README.md index 6e0f23f522df76e5ca1f9167ca4948291da2202d..7af18f95213b5c635a7795fbe5e48f54a833a63e 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/client_cli/cmdLogin/login.go b/src/client_cli/cmdLogin/login.go index b8e0da87ab5870ca5958a9cf7ec9df1f207209b3..a34fcd8f658cd9f4c999c3a808eadf2cf2020ec4 100644 --- a/src/client_cli/cmdLogin/login.go +++ b/src/client_cli/cmdLogin/login.go @@ -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() { diff --git a/src/client_cli/cmdTemplate/templateCreate.go b/src/client_cli/cmdTemplate/templateCreate.go index da25513b505eee1dccb34b61e4ffa7abd932a5fe..48b608f1f5cd3583b5f776733e1f5e80b4707864 100644 --- a/src/client_cli/cmdTemplate/templateCreate.go +++ b/src/client_cli/cmdTemplate/templateCreate.go @@ -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() { diff --git a/src/client_cli/cmdTemplate/templateDel.go b/src/client_cli/cmdTemplate/templateDel.go index f722979bc1ea711af72cffb7d9e4aedd18e79133..b4c6fda155d9b6309c35c79cde37bb52bbb189b4 100644 --- a/src/client_cli/cmdTemplate/templateDel.go +++ b/src/client_cli/cmdTemplate/templateDel.go @@ -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() { diff --git a/src/client_cli/cmdTemplate/templateList.go b/src/client_cli/cmdTemplate/templateList.go index 455afa3c015e25668a7332d115ac82aadf5be900..49c3916d60cd569f38fa8c1849bac9d77526f57b 100644 --- a/src/client_cli/cmdTemplate/templateList.go +++ b/src/client_cli/cmdTemplate/templateList.go @@ -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() { diff --git a/src/client_cli/cmdUser/userAdd.go b/src/client_cli/cmdUser/userAdd.go index 8be5e050046256df4f9d2649e3b17a750f0828fb..bba0dddf956f80b1517a72817eede0a430f2f4ff 100644 --- a/src/client_cli/cmdUser/userAdd.go +++ b/src/client_cli/cmdUser/userAdd.go @@ -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() { diff --git a/src/client_cli/cmdUser/userDel.go b/src/client_cli/cmdUser/userDel.go index c6f6d0cdd8a16e5fd34ac0ccac32f1db8d25982e..2f57f5d969d13360ff847ac7d86c1eb2934554ba 100644 --- a/src/client_cli/cmdUser/userDel.go +++ b/src/client_cli/cmdUser/userDel.go @@ -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() { diff --git a/src/client_cli/cmdUser/userList.go b/src/client_cli/cmdUser/userList.go index 55902fa8add3e051c33dad794a817fc134d03aa6..5b0712d92a68c450a6fa6a2868ce3044f82cb6ee 100644 --- a/src/client_cli/cmdUser/userList.go +++ b/src/client_cli/cmdUser/userList.go @@ -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() { diff --git a/src/client_cli/cmdUser/userSetCaps.go b/src/client_cli/cmdUser/userSetCaps.go index 2d49448145875979b7b5bc1bc867492ba7bb0998..ea6eacad3894889f0e3a6becf30427900e6f6b56 100644 --- a/src/client_cli/cmdUser/userSetCaps.go +++ b/src/client_cli/cmdUser/userSetCaps.go @@ -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() { diff --git a/src/client_cli/cmdUser/userUpdatePwd.go b/src/client_cli/cmdUser/userUpdatePwd.go index 5f6f749cec1ce0b89eb457bde9d863be01d5b626..52661ea51bc7776f048b46dab2cbee3090dc1827 100644 --- a/src/client_cli/cmdUser/userUpdatePwd.go +++ b/src/client_cli/cmdUser/userUpdatePwd.go @@ -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() { diff --git a/src/client_cli/cmdUser/userWhoami.go b/src/client_cli/cmdUser/userWhoami.go index cfed13b8422416f99e0bfe8081f7744bca54b231..4e0f12d8e800a4962700f8227ad3ee852ab5a471 100644 --- a/src/client_cli/cmdUser/userWhoami.go +++ b/src/client_cli/cmdUser/userWhoami.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmAttach.go b/src/client_cli/cmdVM/vmAttach.go index 26076a538ed60be7d698a8d8866ef15b4551a8c9..d9ea72a00224955c2222b9c0c6c5d57e27b53234 100644 --- a/src/client_cli/cmdVM/vmAttach.go +++ b/src/client_cli/cmdVM/vmAttach.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmCreate.go b/src/client_cli/cmdVM/vmCreate.go index 203aa38f909746d35d708625b600d5254e5c42ae..e6d486860fed31b8d42674a361a2c8f42138b7d8 100644 --- a/src/client_cli/cmdVM/vmCreate.go +++ b/src/client_cli/cmdVM/vmCreate.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmDel.go b/src/client_cli/cmdVM/vmDel.go index ae4ba723259a7dc87312e37b359910a7ed967c66..033d82903507f49cd0f6e2eef7f3f75b70f0d94a 100644 --- a/src/client_cli/cmdVM/vmDel.go +++ b/src/client_cli/cmdVM/vmDel.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmDelAccess.go b/src/client_cli/cmdVM/vmDelAccess.go index 862d2261f50cc54b9d55f3af59bcd370ceedafca..dc09edab8513bcf977d0e8b600335c4a438ca8f6 100644 --- a/src/client_cli/cmdVM/vmDelAccess.go +++ b/src/client_cli/cmdVM/vmDelAccess.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmEdit.go b/src/client_cli/cmdVM/vmEdit.go index aa8ba536be7d86f61551d49fa2465922bfebf799..c9260fd1bd6418cd52b1750830ba68d5e3a2bd5b 100644 --- a/src/client_cli/cmdVM/vmEdit.go +++ b/src/client_cli/cmdVM/vmEdit.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmList.go b/src/client_cli/cmdVM/vmList.go index 844604b0993fa166534e599d902c70757b3edf92..89040868300ad2f4b689d9c03e8aecb0e0538b4b 100644 --- a/src/client_cli/cmdVM/vmList.go +++ b/src/client_cli/cmdVM/vmList.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmListAttach.go b/src/client_cli/cmdVM/vmListAttach.go index e8fb3e98bddcc26b16bfbb0ac74f85e6d1d984b3..7837e9b4f18dce7a8b5dadc9d4ce5e93f830bcb7 100644 --- a/src/client_cli/cmdVM/vmListAttach.go +++ b/src/client_cli/cmdVM/vmListAttach.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmListDel.go b/src/client_cli/cmdVM/vmListDel.go index 864604704c6b9d0e7f1798d218178854bbd15aad..8b794875349a1de8aa2d6991c2d7f8783c130cf8 100644 --- a/src/client_cli/cmdVM/vmListDel.go +++ b/src/client_cli/cmdVM/vmListDel.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmListEdit.go b/src/client_cli/cmdVM/vmListEdit.go index ca022463267781c1fef5224a41afbe99e6cc684d..949e58522d30e4fda18dc9b7bb110df561bc915b 100644 --- a/src/client_cli/cmdVM/vmListEdit.go +++ b/src/client_cli/cmdVM/vmListEdit.go @@ -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() { diff --git a/src/client_cli/cmdVM/vmListEditAccess.go b/src/client_cli/cmdVM/vmListEditAccess.go index 2d9789199d3559cfdf833a115f6b3623b9b90168..d6b79fcc7ba9f42c46346ff5f676239022c53622 100644 --- a/src/client_cli/cmdVM/vmListEditAccess.go +++ b/src/client_cli/cmdVM/vmListEditAccess.go @@ -9,7 +9,7 @@ func (cmd *ListEditAccess)GetName() string { } func (cmd *ListEditAccess)GetDesc() string { - return "List VMs that can have their VM access edited" + return "List VMs that can have their VM access edited (regex matching)." } func (cmd *ListEditAccess)PrintUsage() { diff --git a/src/client_cli/cmdVM/vmListStart.go b/src/client_cli/cmdVM/vmListStart.go index 70a7daa648cee87f5881b76932ba38994f909bd9..259b5e6f3dee85e8a4b02cb200d0e998a9b9458e 100644 --- a/src/client_cli/cmdVM/vmListStart.go +++ b/src/client_cli/cmdVM/vmListStart.go @@ -9,7 +9,7 @@ func (cmd *ListStart)GetName() string { } func (cmd *ListStart)GetDesc() string { - return "List VMs that can be started" + return "List VMs that can be started (regex matching)." } func (cmd *ListStart)PrintUsage() { diff --git a/src/client_cli/cmdVM/vmListStop.go b/src/client_cli/cmdVM/vmListStop.go index 19b473d553ee5a386d540c8e5fcb521b53dc7624..b1ab5f27f7e32afd223b52f2f7a391971330ccc9 100644 --- a/src/client_cli/cmdVM/vmListStop.go +++ b/src/client_cli/cmdVM/vmListStop.go @@ -9,7 +9,7 @@ func (cmd *ListStop)GetName() string { } func (cmd *ListStop)GetDesc() string { - return "List VMs that can be stopped" + return "List VMs that can be stopped (regex matching)." } func (cmd *ListStop)PrintUsage() { diff --git a/src/client_cli/cmdVM/vmSetAccess.go b/src/client_cli/cmdVM/vmSetAccess.go index f0e675a50dbafbe060ee88e3b0a913ac88feb822..c8ce79531347583b192e1a8e0975b1f6f8a164c5 100644 --- a/src/client_cli/cmdVM/vmSetAccess.go +++ b/src/client_cli/cmdVM/vmSetAccess.go @@ -14,7 +14,7 @@ func (cmd *SetAccess)GetName() string { } func (cmd *SetAccess)GetDesc() string { - return "Set the VM Access for a given user" + return "Set the VM access for a given user." } func (cmd *SetAccess)PrintUsage() { diff --git a/src/client_cli/cmdVM/vmStart.go b/src/client_cli/cmdVM/vmStart.go index 49f751e5a21408c49106bf3dae5d7bb85c44d84d..a80a72b3e86b2908295cb21cf82f3a70f29659a8 100644 --- a/src/client_cli/cmdVM/vmStart.go +++ b/src/client_cli/cmdVM/vmStart.go @@ -14,7 +14,7 @@ func (cmd *Start)GetName() string { } func (cmd *Start)GetDesc() string { - return "Start one or more VMs." + return "Start one or more VMs (regex matching)." } func (cmd *Start)PrintUsage() { diff --git a/src/client_cli/cmdVM/vmStop.go b/src/client_cli/cmdVM/vmStop.go index 072cb80cb366c8792661a2ddd0cddebaaddd0eea..c1dfe81b9165ee722549677e9d56c0ffcf50b85c 100644 --- a/src/client_cli/cmdVM/vmStop.go +++ b/src/client_cli/cmdVM/vmStop.go @@ -14,7 +14,7 @@ func (cmd *Stop)GetName() string { } func (cmd *Stop)GetDesc() string { - return "Stop one or more VMs." + return "Stop one or more VMs (regex matching)." } func (cmd *Stop)PrintUsage() {