[activemq-artemis] branch master updated: NO-JIRA fix user command parameter docs

[jb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jbertram pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git


The following commit(s) were added to refs/heads/master by this push:
     new fb60795  NO-JIRA fix user command parameter docs
fb60795 is described below

commit fb60795b59f24da9e01cade972721da1dda90803
Author: Justin Bertram <jb...@apache.org>
AuthorDate: Wed Feb 5 08:36:16 2020 -0600

    NO-JIRA fix user command parameter docs
---
 .../java/org/apache/activemq/artemis/cli/commands/user/AddUser.java     | 2 +-
 .../java/org/apache/activemq/artemis/cli/commands/user/ListUser.java    | 2 +-
 .../java/org/apache/activemq/artemis/cli/commands/user/RemoveUser.java  | 2 +-
 .../java/org/apache/activemq/artemis/cli/commands/user/ResetUser.java   | 2 +-
 docs/user-manual/en/masking-passwords.md                                | 2 +-
 docs/user-manual/en/security.md                                         | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/AddUser.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/AddUser.java
index a105bcd..d3be8da 100644
--- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/AddUser.java
+++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/AddUser.java
@@ -25,7 +25,7 @@ import org.apache.commons.lang3.StringUtils;
 
 /**
  * Adding a new user, example:
- * ./artemis user add --username guest --role admin --password ***
+ * ./artemis user add --user guest --role admin --password ***
  */
 @Command(name = "add", description = "Add a new user")
 public class AddUser extends PasswordAction {
diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ListUser.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ListUser.java
index b18deba..658abb5 100644
--- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ListUser.java
+++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ListUser.java
@@ -25,7 +25,7 @@ import org.apache.activemq.artemis.spi.core.security.jaas.PropertiesLoginModuleC
 
 /**
  * list existing users, example:
- * ./artemis user list --username guest
+ * ./artemis user list --user guest
  */
 @Command(name = "list", description = "List existing user(s)")
 public class ListUser extends UserAction {
diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/RemoveUser.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/RemoveUser.java
index c49e36b..caeb7bf 100644
--- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/RemoveUser.java
+++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/RemoveUser.java
@@ -22,7 +22,7 @@ import org.apache.activemq.artemis.spi.core.security.jaas.PropertiesLoginModuleC
 
 /**
  * Remove a user, example:
- * ./artemis user rm --username guest
+ * ./artemis user rm --user guest
  */
 @Command(name = "rm", description = "Remove an existing user")
 public class RemoveUser extends UserAction {
diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ResetUser.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ResetUser.java
index 162aea6..be97ab9 100644
--- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ResetUser.java
+++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/user/ResetUser.java
@@ -25,7 +25,7 @@ import org.apache.commons.lang3.StringUtils;
 
 /**
  * Reset a user's password or roles, example:
- * ./artemis user reset --username guest --role admin --password ***
+ * ./artemis user reset --user guest --role admin --password ***
  */
 @Command(name = "reset", description = "Reset user's password or roles")
 public class ResetUser extends PasswordAction {
diff --git a/docs/user-manual/en/masking-passwords.md b/docs/user-manual/en/masking-passwords.md
index c9ec2b4..028ce6a 100644
--- a/docs/user-manual/en/masking-passwords.md
+++ b/docs/user-manual/en/masking-passwords.md
@@ -103,7 +103,7 @@ add the user/password to. This command will not work from the Artemis home
 used to create the instance. For example:
 
 ```sh
-./artemis user add --username guest --password guest --role admin
+./artemis user add --user guest --password guest --role admin
 ```
 
 This will use the default codec to perform a "one-way" hash of the password
diff --git a/docs/user-manual/en/security.md b/docs/user-manual/en/security.md
index 98eb124..77c69e6 100644
--- a/docs/user-manual/en/security.md
+++ b/docs/user-manual/en/security.md
@@ -538,7 +538,7 @@ follow the syntax `ENC(<hash>)`. Hashed passwords can easily be added to
 *instance*. This command will not work from the Artemis home.
 
 ```sh
-./artemis user add --username guest --password guest --role admin
+./artemis user add --user guest --password guest --role admin
 ```
 
 This will use the default codec to perform a "one-way" hash of the password