diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 29 | ||||
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/Makefile.in | 1 | ||||
| -rw-r--r-- | doc/UserGuide | 126 | ||||
| -rw-r--r-- | doc/ipmiutil.spec | 4 | ||||
| -rw-r--r-- | doc/iuser.8 | 107 |
6 files changed, 252 insertions, 16 deletions
diff --git a/doc/Makefile b/doc/Makefile index 07c0069..5f0e9ee 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -46,12 +46,12 @@ CONFIG_CLEAN_VPATH_FILES = SOURCES = DIST_SOURCES = DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) -ACLOCAL = ${SHELL} /usr/dev/ipmiutil-3.0.2/missing --run aclocal-1.11 -AMTAR = ${SHELL} /usr/dev/ipmiutil-3.0.2/missing --run tar +ACLOCAL = ${SHELL} /usr/dev/ipmiutil-3.0.3/missing --run aclocal-1.11 +AMTAR = ${SHELL} /usr/dev/ipmiutil-3.0.3/missing --run tar AR = ar -AUTOCONF = ${SHELL} /usr/dev/ipmiutil-3.0.2/missing --run autoconf -AUTOHEADER = ${SHELL} /usr/dev/ipmiutil-3.0.2/missing --run autoheader -AUTOMAKE = ${SHELL} /usr/dev/ipmiutil-3.0.2/missing --run automake-1.11 +AUTOCONF = ${SHELL} /usr/dev/ipmiutil-3.0.3/missing --run autoconf +AUTOHEADER = ${SHELL} /usr/dev/ipmiutil-3.0.3/missing --run autoheader +AUTOMAKE = ${SHELL} /usr/dev/ipmiutil-3.0.3/missing --run automake-1.11 AWK = gawk CC = gcc CCDEPMODE = depmode=gcc3 @@ -99,7 +99,7 @@ LIB_DIR = /usr/lib64 LIPO = LN_S = ln -s LTLIBOBJS = -MAKEINFO = ${SHELL} /usr/dev/ipmiutil-3.0.2/missing --run makeinfo +MAKEINFO = ${SHELL} /usr/dev/ipmiutil-3.0.3/missing --run makeinfo MKDIR_P = /bin/mkdir -p NM = /usr/bin/nm -B NMEDIT = @@ -113,9 +113,9 @@ OTOOL64 = PACKAGE = ipmiutil PACKAGE_BUGREPORT = PACKAGE_NAME = ipmiutil -PACKAGE_STRING = ipmiutil 3.0.2 +PACKAGE_STRING = ipmiutil 3.0.3 PACKAGE_TARNAME = ipmiutil -PACKAGE_VERSION = 3.0.2 +PACKAGE_VERSION = 3.0.3 PATH_SEPARATOR = : PKG_DIR = /root/rpmbuild RANLIB = ranlib @@ -127,11 +127,11 @@ SHR_LINK = libipmiutil.so.1 STRIP = strip SUBDIR_S = doc scripts lib util SYSTEMD_DIR = /usr/share/ipmiutil -VERSION = 3.0.2 -abs_builddir = /usr/dev/ipmiutil-3.0.2/doc -abs_srcdir = /usr/dev/ipmiutil-3.0.2/doc -abs_top_builddir = /usr/dev/ipmiutil-3.0.2 -abs_top_srcdir = /usr/dev/ipmiutil-3.0.2 +VERSION = 3.0.3 +abs_builddir = /usr/dev/ipmiutil-3.0.3/doc +abs_srcdir = /usr/dev/ipmiutil-3.0.3/doc +abs_top_builddir = /usr/dev/ipmiutil-3.0.3 +abs_top_srcdir = /usr/dev/ipmiutil-3.0.3 ac_ct_CC = gcc ac_ct_DUMPBIN = am__include = include @@ -159,7 +159,7 @@ host_vendor = redhat htmldir = ${docdir} includedir = ${prefix}/include infodir = ${datarootdir}/info -install_sh = ${SHELL} /usr/dev/ipmiutil-3.0.2/install-sh +install_sh = ${SHELL} /usr/dev/ipmiutil-3.0.3/install-sh libdir = ${exec_prefix}/lib libexecdir = ${exec_prefix}/libexec localedir = ${datarootdir}/locale @@ -414,6 +414,7 @@ install: ${INSTALL_DATA_SH} idelloem.8 ${manto} ${INSTALL_DATA_SH} idcmi.8 ${manto} ${INSTALL_DATA_SH} ismcoem.8 ${manto} + ${INSTALL_DATA_SH} iuser.8 ${manto} ${INSTALL_DATA_SH} bmclanpet.mib ${datato} cd ${manto}; gzip -f *.8 diff --git a/doc/Makefile.am b/doc/Makefile.am index 832b0d1..632cc49 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -56,6 +56,7 @@ install: ${INSTALL_DATA_SH} idelloem.8 ${manto} ${INSTALL_DATA_SH} idcmi.8 ${manto} ${INSTALL_DATA_SH} ismcoem.8 ${manto} + ${INSTALL_DATA_SH} iuser.8 ${manto} ${INSTALL_DATA_SH} bmclanpet.mib ${datato} cd ${manto}; gzip -f *.8 diff --git a/doc/Makefile.in b/doc/Makefile.in index 7afa686..15917e8 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -414,6 +414,7 @@ install: ${INSTALL_DATA_SH} idelloem.8 ${manto} ${INSTALL_DATA_SH} idcmi.8 ${manto} ${INSTALL_DATA_SH} ismcoem.8 ${manto} + ${INSTALL_DATA_SH} iuser.8 ${manto} ${INSTALL_DATA_SH} bmclanpet.mib ${datato} cd ${manto}; gzip -f *.8 diff --git a/doc/UserGuide b/doc/UserGuide index b35739a..6c2207e 100644 --- a/doc/UserGuide +++ b/doc/UserGuide @@ -1,6 +1,6 @@ IPMIUTIL USER GUIDE - VERSION 3.0.2 + VERSION 3.0.3 An easy-to-use IPMI server management utility @@ -42,6 +42,7 @@ 3.27 IDCMI (ipmiutil dcmi) 3.28 ISMCOEM (ipmiutil smcoem) 3.29 ISELTIME (iseltime) + 3.30 IUSER (ipmiutil user) 4.0 Use Cases 4.1 Usage of IPMI utilities for sensor thresholds 4.2 Usage to configure a system for IPMI LAN @@ -4585,6 +4586,129 @@ WARNINGS See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil and any bug fix list. + +-------------------------------------- +3.30 IUSER (ipmiutil user) + +IUSER(8) IUSER(8) + + + +NAME + ipmiutil_user - handle user functions + + +SYNOPSIS + ipmiutil user [-cmsx -NUPREFTVY] <function> + + +DESCRIPTION + This ipmiutil user subcommand handles IPMI LAN user functions sepa- + rately. + 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. + + +OPTIONS + Command line options are described below. + + -c Canonical, delimited output format + + -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 charac- + ter, if present, indicates SMI addressing if ’s’, or IPMB + addressing if ’i’ or not present. + + -s When getting info, also get the DCMI sensor information. + + -x Causes extra debug messages to be displayed. + + -N nodename + Nodename or IP address of the remote target system. If a node- + name is specified, IPMI LAN interface is used. Otherwise the + local system management interface is used. + + -U rmt_user + Remote username for the nodename given. The default is a null + username. + + -P/-R rmt_pswd + Remote password for the nodename given. The default is a null + password. + + -E Use the remote password from Environment variable IPMI_PASSWORD. + + -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. + + -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. + + -T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2, + 2=MD5, 4=Straight Password, 5=OEM. + + -V Use a specified IPMI LAN privilege level. 1=Callback level, + 2=User level, 3=Operator level, 4=Administrator level (default), + 5=OEM level. + + -Y Yes, do prompt the user for the IPMI LAN remote password. + Alternatives for the password are -E or -P. + + +FUNCTIONS + list [channel] + List the IPMI LAN users with enabled status, privilege level, + and username. Optionally specify a channel number. + + enable <user_num> [channel] + Enable the specified user number and optionally specify an IPMI + LAN channel number. + + disable <user_num>] + Disable the specified user number, so that it has ’No access’. + + + set <user_num> name <username> + Set the username for a specified user number. + + + set <user_num> password <password> + Set the password for a specified user number. + + + 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. + + + help Show the help (usage) message + + +EXAMPLES + ipmiutil user set 2 name user2 + Sets the username for user 2 to "user2". + + + +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) + + +WARNINGS + See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil + and any bug fix list. -------------------------- diff --git a/doc/ipmiutil.spec b/doc/ipmiutil.spec index 6fab0b4..01dbbcf 100644 --- a/doc/ipmiutil.spec +++ b/doc/ipmiutil.spec @@ -3,7 +3,7 @@ # Copyright (c) 2012 Andy Cress # Name: ipmiutil -Version: 3.0.2 +Version: 3.0.3 Release: 1%{?dist} Summary: Easy-to-use IPMI server management utilities License: BSD @@ -123,6 +123,7 @@ rm -rf %{buildroot} %{_sbindir}/ifirewall %{_sbindir}/ifwum %{_sbindir}/ihpm +%{_sbindir}/iuser %{_libdir}/libipmiutil.so.1 %{_datadir}/%{name}/ipmiutil_evt %{_datadir}/%{name}/ipmiutil_asy @@ -168,6 +169,7 @@ rm -rf %{buildroot} %{_mandir}/man8/iekanalyzer.8* %{_mandir}/man8/itsol.8* %{_mandir}/man8/idcmi.8* +%{_mandir}/man8/iuser.8* %doc AUTHORS ChangeLog COPYING NEWS README TODO %doc doc/UserGuide diff --git a/doc/iuser.8 b/doc/iuser.8 new file mode 100644 index 0000000..653e9ec --- /dev/null +++ b/doc/iuser.8 @@ -0,0 +1,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 + |