Skip to content

Commit 2a45002

Browse files
Update documentation for foreman-rake permissions:reset (#4327)
Co-authored-by: Aneta Šteflová Petrová <[email protected]>
1 parent 88b5187 commit 2a45002

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

guides/common/modules/proc_resetting-the-administrative-user-password.adoc

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,44 @@
44
= Resetting the administrative user password
55

66
[role="_abstract"]
7-
Use the following procedures to reset the administrative password to randomly generated characters or to set a new administrative password.
7+
You can reset the administrative password to randomly generated characters or set a new administrative password for a specific user.
8+
This might be useful when you forget the password, when the administrative user is deleted, or for assigning administrative privileges to a user.
89

910
.Procedure
10-
. To reset the administrative user password:
11-
.. Log in to the base operating system where {ProjectServer} is installed.
12-
.. Enter the following command to reset the password:
11+
. Log in to the base operating system where your {ProjectServer} is installed.
12+
. Reset the administrative user password:
13+
* To set a randomly generated administrative user password:
1314
+
1415
[options="nowrap", subs="+quotes,verbatim,attributes"]
1516
----
1617
# foreman-rake permissions:reset
1718
Reset to user: admin, password: qwJxBptxb7Gfcjj5
1819
----
19-
.. Use this password to reset the password in the {ProjectWebUI}.
20-
.. Edit the `~/.hammer/cli.modules.d/foreman.yml` file on {ProjectServer} to add the new password:
20+
21+
* To set a new administrative user password:
2122
+
2223
[options="nowrap", subs="+quotes,verbatim,attributes"]
2324
----
24-
# vi ~/.hammer/cli.modules.d/foreman.yml
25+
# foreman-rake permissions:reset username=_My_User_Name_ password=_My_New_Password_
2526
----
2627
+
28+
Replace `_My_User_Name_` with the username of the user whose password you want to reset.
29+
+
2730
[NOTE]
2831
====
29-
Unless you update the `~/.hammer/cli.modules.d/foreman.yml` file, you cannot use the new password with Hammer CLI.
32+
Be aware of the following behaviors:
33+
34+
* If you enter a username that does not exist, the `foreman-rake` utility creates a new administrative user with the defined password.
35+
* If you enter a username of a user without administrative privileges, that user gains administrative privileges.
36+
* If you do not enter a username, the password resets for the `admin` user by default.
3037
====
31-
. To set a new administrative user password
32-
.. Log in to the base operating system where {ProjectServer} is installed.
33-
.. To set the password, enter the following command:
34-
+
35-
[options="nowrap", subs="+quotes,verbatim,attributes"]
36-
----
37-
# foreman-rake permissions:reset password=_new_password_
38-
----
39-
.. Edit the `~/.hammer/cli.modules.d/foreman.yml` file on {ProjectServer} to add the new password:
38+
39+
. To use the new password with the Hammer CLI, add the password and username to the `~/.hammer/cli.modules.d/foreman.yml` file on your {ProjectServer}:
4040
+
4141
[options="nowrap", subs="+quotes,verbatim,attributes"]
4242
----
4343
# vi ~/.hammer/cli.modules.d/foreman.yml
4444
----
45-
+
46-
[NOTE]
47-
====
48-
Unless you update the `~/.hammer/cli.modules.d/foreman.yml` file, you cannot use the new password with Hammer CLI.
49-
====
45+
46+
.Verification
47+
* Use the new password to log in to the {ProjectWebUI}.

0 commit comments

Comments
 (0)