summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorG Dutton <35460590+gdttn@users.noreply.github.com>2019-09-02 14:22:55 +0100
committerAlexander Amelkin <mocbuhtig@amelkin.msk.ru>2019-09-03 23:40:48 +0300
commit4dc962b6141c3d513470b7afc9613d36e33c2375 (patch)
treefa954bf8dcb818b2f09224aef51e3c50fff6c892
parent6940a6717ae3929297c0608fab2275da37940c97 (diff)
downloadipmitool-4dc962b6141c3d513470b7afc9613d36e33c2375.tar.gz
doc: Update man page regarding `user set password`
Document password length argument to "set password", as per usage info. Since we don't check whether we're using IPMI1.5/2.0 when setting the password, ipmitool can't reject 20-char passwords being sent to 16-char interfaces, so the behaviour is somewhat undefined. For 20-chars, it's now clearer and long passwords will be rejected. Man page changed to reflect the above.
-rw-r--r--doc/ipmitool.1.in17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/ipmitool.1.in b/doc/ipmitool.1.in
index cac7132..8f54a59 100644
--- a/doc/ipmitool.1.in
+++ b/doc/ipmitool.1.in
@@ -259,11 +259,15 @@ system. It is thus recommended that IPMI password management only be done
over IPMIv2.0 \fIlanplus\fP interface or the system interface on the
local station.
-For IPMI v1.5, the maximum password length is 16 characters.
-Passwords longer than 16 characters will be truncated.
+For IPMI v1.5, the maximum password length is 16 characters; longer
+passwords might be truncated or rejected by the server, or rejected
+by
+.BR ipmitool .
+
+For IPMI v2.0, the maximum password length is 20 characters; longer
+passwords will be rejected by
+.BR ipmitool .
-For IPMI v2.0, the maximum password length is 20 characters;
-longer passwords are truncated.
.SH "COMMANDS"
.TP
\fIhelp\fP
@@ -3526,12 +3530,13 @@ Displays a list of user information for all defined userids.
Sets the username associated with the given userid.
.TP
-\fIpassword\fP <\fBuserid\fR> [<\fBpassword\fR>]
+\fIpassword\fP <\fBuserid\fR> [<\fBpassword\fR> [<\fB16|20\fR>]]
.br
Sets the password for the given userid. If no password is given,
the password is cleared (set to the NULL password). Be careful when
-removing passwords from administrator\-level accounts.
+removing passwords from administrator\-level accounts. If specified,
+16 or 20 determines the maximum password length.
.RE
.TP
\fIdisable\fP <\fBuserid\fR>