summaryrefslogtreecommitdiff
path: root/doc/iuser.8
blob: 653e9ec84edb65992b78dd123400f0adc6c0cc56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
.TH IUSER 8 "Version 1.0: 23 Feb 2017"
.SH NAME
ipmiutil_user \- handle user functions

.SH SYNOPSIS
.B "ipmiutil user [-cmsx -NUPREFTVY] <function>

.SH DESCRIPTION
This
.I ipmiutil user
subcommand handles IPMI LAN user functions separately.
These functions can also be handled from ipmiutil lan -q, -u, -p, -v.

This utility can use either the /dev/ipmi0 driver from OpenIPMI,
the /dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,
direct user-space IOs, or the IPMI LAN interface if \-N.

.SH OPTIONS
Command line options are described below.
.IP "-c"
Canonical, delimited output format
.IP "-m 002000"
Target a specific MC (e.g. bus 00, sa 20, lun 00).
This could be used for PICMG or ATCA blade systems.
The trailing character, if present, indicates SMI addressing if 's',
or IPMB addressing if 'i' or not present.
.IP "-s"
When getting info, also get the DCMI sensor information.
.IP "-x"
Causes extra debug messages to be displayed.
.IP "-N nodename"
Nodename or IP address of the remote target system.  If a nodename is
specified, IPMI LAN interface is used.  Otherwise the local system
management interface is used.
.IP "-U rmt_user"
Remote username for the nodename given.  The default is a null username.
.IP "-P/-R rmt_pswd"
Remote password for the nodename given.  The default is a null password.
.IP "-E"
Use the remote password from Environment variable IPMI_PASSWORD.
.IP "-F drv_t"
Force the driver type to one of the followng:
imb, va, open, gnu, landesk, lan, lan2, lan2i, kcs, smb.
Note that lan2i means lan2 with intelplus.
The default is to detect any available driver type and use it.
.IP "-J"
Use the specified LanPlus cipher suite (0 thru 17): 0=none/none/none,
1=sha1/none/none, 2=sha1/sha1/none, 3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128,
5=sha1/sha1/xrc4_40, 6=md5/none/none, ... 14=md5/md5/xrc4_40.
Default is 3.
.IP "-T"
Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2, 2=MD5, 4=Straight Password, 5=OEM.
.IP "-V"
Use a specified IPMI LAN privilege level. 1=Callback level, 2=User level, 3=Operator level, 4=Administrator level (default), 5=OEM level.
.IP "-Y"
Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are \-E or \-P.

.SH FUNCTIONS

.IP "list [channel]"
List the IPMI LAN users with enabled status, privilege level, and username.
Optionally specify a channel number.

.IP "enable <user_num> [channel]"
Enable the specified user number and optionally specify an IPMI LAN channel number.
.IP "disable <user_num>]"
Disable the specified user number, so that it has 'No access'.

.IP "set <user_num> name <username>"
Set the username for a specified user number.

.IP "set <user_num> password <password>"
Set the password for a specified user number.

.IP "set <user_num> priv <priv_level> [channel]"
Set the privilege level for a specified user number, where the privilege level is 4=Admin, 3=Operator, 2=User.  Also optionally specify a channel number.

.IP "help"
Show the help (usage) message

.SH "EXAMPLES"
ipmiutil user set 2 name user2 
.br
Sets the username for user 2 to "user2". 


.SH "SEE ALSO"
ipmiutil(8) ialarms(8) iconfig(8) idiscover(8) ievents(8) ifru(8) igetevent(8) ihealth(8) ilan(8) ireset(8) isel(8) isensor(8) iserial(8) isol(8) iwdt(8)

.SH WARNINGS
See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil and any bug fix list.

.SH COPYRIGHT
Copyright (C) 2017  Andy Cress
.PP
See the file COPYING in the distribution for more details
regarding redistribution.
.PP
This utility is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY.

.SH AUTHOR
.PP
Andy Cress <arcress at users.sourceforge.net>
.br