~ubuntu-branches/ubuntu/vivid/openipmi/vivid

« back to all changes in this revision

Viewing changes to man/ipmicmd.1

  • Committer: Bazaar Package Importer
  • Author(s): Noèl Köthe
  • Date: 2006-09-15 17:56:24 UTC
  • mfrom: (1.1.2 upstream) (2.1.1 etch)
  • Revision ID: james.westby@ubuntu.com-20060915175624-ljk0mg3xtcm65tvm
Tags: 2.0.7-1
* new upstream release from 2006-06-08
  Thanks to John Wright <john.wright hp.com> for initial work
  (closes: Bug#380149)
* updated Standards Version
* new binaries openipmicmd, openipmish, rmcp_ping

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH ipmicmd 8 05/13/03 OpenIPMI "An IPMI Command Interface"
2
 
 
3
 
.SH NAME
4
 
ipmicmd \- An IPMI Command Interface
5
 
 
6
 
.SH SYNOPSIS
7
 
.B ipmicmd
8
 
.RB [ \-k
9
 
.IR "entry-to-execute" ]
10
 
.BI smi\  smi-num
11
 
 
12
 
.B ipmicmd
13
 
.RB [ \-k
14
 
.IR "entry-to-execute" ]
15
 
.BI lan\  IP-addr
16
 
.IR port\  [ IP-addr-2
17
 
.IR port-2 ] 
18
 
.I auth privilege username password
19
 
 
20
 
.SH DESCRIPTION
21
 
The
22
 
.BR ipmicmd
23
 
program allows a user to execute direct IPMI commands.  It can work
24
 
with direct interface with the OpenIPMI driver or with IPMI LAN
25
 
interfaces.
26
 
 
27
 
.SH OPTIONS
28
 
.TP
29
 
.BI \-k\  entry-to-execute
30
 
Execute a single command an exit.
31
 
 
32
 
.TP
33
 
.I "smi-num"
34
 
The SMI number to connect to, for systems with more than on system
35
 
interface.  Generally, this is '\fB0\fP'.
36
 
 
37
 
.TP
38
 
.I "IP-addr"
39
 
The IP address of the LAN interface.
40
 
 
41
 
.TP
42
 
.I "port"
43
 
The UDP port of the LAN interface, general \fB623\fP.
44
 
 
45
 
.TP
46
 
.I "IP-addr-2"
47
 
Some systems support multiple IP connections, this specified the
48
 
second address and is optional.  If specified, OpenIPMI will use both
49
 
IP addresses and fail over to the working one if one of them fails.
50
 
 
51
 
.TP
52
 
.I "port-2"
53
 
The port for the second IP connection, generally \fB623\fP.
54
 
 
55
 
.TP
56
 
.I "auth"
57
 
The authorization to use for the connection, either "\fBnone\fP",
58
 
"\fBstraight\fP", "\fBmd5\fP", or "\fBmd2\fP".
59
 
 
60
 
.TP
61
 
.I "privilege"
62
 
The privilege to use for the connection, either "\fBcallback\fP", "\fBuser\fP",
63
 
"\fBoperator\fP", or "\fBadmin\fP".  Note that some IPMI operations will fail
64
 
without the correct privilege.
65
 
 
66
 
.TP
67
 
.I "username"
68
 
The user name to use for the connection.  If using this anonymous
69
 
user, this should be the empty string "".
70
 
 
71
 
.TP
72
 
.I "password"
73
 
The password to use for the connection.
74
 
 
75
 
 
76
 
.SH COMMANDS
77
 
 
78
 
Once up, you can execute commands in the user interface.  Note that
79
 
commands and responses are asynchronous, you issue a command and the
80
 
interface returns immediately.  When the response comes back, it will
81
 
be dumped on your console.  That's a little strange looking, but IPMI
82
 
is ansychronous underneath.  Note that the \fB\-k\fP option is synchronous,
83
 
it will wait for the response or a timeout before returning.
84
 
 
85
 
.TP
86
 
\fB0f\fP \fIlun\fP \fInetfn\fP \fIcmd\fP [\fIdata1\fP [\fIdata2\fP ...]]
87
 
Send a command to the BMC you are connected to.
88
 
 
89
 
.TP
90
 
\fIchannel\fP [\fBipmb\fP] \fIIPMB-addr\fP \fIlun\fP \fInetfn\fP \fIcmd\fP [\fIdata1\fP [\fIdata2\fP ...]]
91
 
Send a command to a device on the IPMB bus.  The "\fBipmb\fP" string is optional.
92
 
 
93
 
.TP
94
 
\fIchannel\fP \fB00\fP \fIIPMB-addr\fP \fIlun\fP \fInetfn\fP \fIcmd\fP [\fIdata1\fP [\fIdata2\fP ...]]
95
 
Send a broadcast command to a device on the IPMB bus.
96
 
 
97
 
.TP
98
 
\fIchannel\fP \fBlan\fP \fIhandle\fP \fIremote-swid\fP \fIlocal-swid\fP \fIlun\fP \fInetfn\fP \fIcmd\fP [\fIdata1\fP [\fIdata\fP ...]]
99
 
Send a command to a device over a LAN channel.  Note that this not the
100
 
same as a LAN connection.  This sends a message through a local BMC to
101
 
a remote system that is hooked up with a LAN connection.
102
 
 
103
 
.TP
104
 
\fBtest_lat\fP \fIcount\fP \fIcommand\fP
105
 
Executes the given \fIcommands\fP (one of the previous commands) \fIcount\fP times
106
 
and gives the average time per command to execute.  Note that "\fIcount\fP"
107
 
is hexadecimal.
108
 
 
109
 
.TP
110
 
.B help
111
 
Display some help.
112
 
 
113
 
.TP
114
 
\fBregcmd\fP \fInetfn\fP \fIcmd\fP
115
 
Register to receive the given command.  If the driver receives an
116
 
external command, it will print it out.  This only works with system
117
 
interface connections, it will not work on LAN connections.
118
 
 
119
 
.TP
120
 
\fBunregcmd\fP \fInetfn\fP \fIcmd\fP
121
 
Remove a command registration.
122
 
 
123
 
.SH "SEE ALSO"
124
 
.BR ipmi_ui (1),
125
 
.BR ipmilan (8)
126
 
 
127
 
.SH "KNOWN PROBLEMS"
128
 
The asychronous nature of the program can be annoying.
129
 
 
130
 
.SH AUTHOR
131
 
.PP
132
 
Corey Minyard <cminyard@mvista.org>