From 0d96184a7c1c55cbfeb37347d6094fd0a5cf3a68 Mon Sep 17 00:00:00 2001 From: niristius Date: Wed, 28 Aug 2024 08:06:18 +0000 Subject: [PATCH] chore: re-generate README --- README.md | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e16ff40f..59640278 100644 --- a/README.md +++ b/README.md @@ -5465,10 +5465,10 @@ FLAGS -p, --project-id= ID or short ID of a project; this flag is optional if a default project is set in the context -q, --quiet suppress process output and only display a machine-readable summary. - --description= (required) Description of SSH user + --description= (required) Set description for SSH user. --expires= an interval after which the SSH user expires (examples: 30m, 30d, 1y). --password= Password used for authentication - --public-key= Public Key used for authentication + --public-key= Public key used for authentication FLAG DESCRIPTIONS -p, --project-id= @@ -5482,6 +5482,21 @@ FLAG DESCRIPTIONS This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in scripts), you can use this flag to easily get the IDs of created resources for further processing. + + --description= Set description for SSH user. + + Set the description for the given SSH user, which will be displayed in the mStudio as well as with the list command. + + --password= Password used for authentication + + Specify an authentication password. Using a password for authentication prevents this user from also using a public + key for authentication. + + --public-key= Public key used for authentication + + Specifies the public key to use for authentication. The corresponding private key is required locally to connect + through this user. Using a public key for authentication prevents this user from also using a password for + authentication. ``` ## `mw ssh-user delete SSH-USER-ID` @@ -5559,12 +5574,12 @@ ARGUMENTS FLAGS -q, --quiet suppress process output and only display a machine-readable summary. - --description= Description of SSH user + --description= Set description for SSH user. --disable Disable the SSH user. --enable Enable the SSH user. --expires= an interval after which the SSH user expires (examples: 30m, 30d, 1y). --password= Password used for authentication - --public-key= Public Key used for authentication + --public-key= Public key used for authentication DESCRIPTION Update an existing SSH user @@ -5575,6 +5590,10 @@ FLAG DESCRIPTIONS This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in scripts), you can use this flag to easily get the IDs of created resources for further processing. + --description= Set description for SSH user. + + Set the description for the given SSH user, which will be displayed in the mStudio as well as with the list command. + --disable Disable the SSH user. Set the status of the SSH user to active. Access by this user will be enabled. @@ -5582,6 +5601,17 @@ FLAG DESCRIPTIONS --enable Enable the SSH user. Set the status of the SSH user to inactive. Access by this user will be disabled. + + --password= Password used for authentication + + Specify an authentication password. Using a password for authentication prevents this user from also using a public + key for authentication. + + --public-key= Public key used for authentication + + Specifies the public key to use for authentication. The corresponding private key is required locally to connect + through this user. Using a public key for authentication prevents this user from also using a password for + authentication. ``` ## `mw update [CHANNEL]`