Blame IbaTools/man/opacmdall.manPage

Packit 857059
.\" .\" *********************************************************************
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *             Copyright 2015-2019, Intel Corporation                *
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *                       All Rights Reserved.                        *
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *********************************************************************
Packit 857059
Packit 857059
.TH opacmdall 8 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
Packit 857059
.SH NAME
Packit 857059
opacmdall
Packit 857059
Packit 857059
Packit 857059
.PP
Packit 857059
Packit 857059
\fB(Linux and Switch)\fR
Packit 857059
Executes a command on all hosts or Intel(R) Omni-Path Chassis. This powerful command can be used for configuring servers or chassis, verifying that they are running, starting and stopping host processes, and other tasks.
Packit 857059
.PP
Packit 857059
Packit 857059
.B NOTE:
Packit 857059
opacmdall depends on the Linux* convention that utilities return 0 for success and >0 for failure. If opacmdall is used to execute a non-standard utility like diff or a program that uses custom exit codes, then opacmdall may erroneously report "Command execution FAILED" when it encounters a non-zero exit code. However, command output is still returned normally and the error may be safely ignored.
Packit 857059
Packit 857059
.SH Syntax
Packit 857059
opacmdall [-CpqPS] [-f  \fIhostfile\fR] [-F  \fIchassisfile\fR] [-h  \fIhosts\fR]
Packit 857059
.br
Packit 857059
[-H  \fIchassis\fR]
Packit 857059
[-u  \fIuser\fR] [-m  \fImarker\fR] [-T  \fItimelimit\fR]  \fIcmd\fR
Packit 857059
.SH Options
Packit 857059
Packit 857059
.TP 10
Packit 857059
--help
Packit 857059
Packit 857059
Produces full help text.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-C
Packit 857059
Packit 857059
Performs command against chassis. Default is hosts.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-p
Packit 857059
Packit 857059
Runs command in parallel on all hosts/chassis.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-q
Packit 857059
Packit 857059
Quiet mode, do not show command to execute.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-P
Packit 857059
Packit 857059
Outputs the hostname/chassis name as prefix to each output line. This can make script processing of output easier.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-S
Packit 857059
Packit 857059
Securely prompts for password for user on chassis.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-f \fIhostfile\fR
Packit 857059
Packit 857059
Specifies the file with hosts in cluster. Default is /etc/opa/hosts file.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-F \fIchassisfile\fR
Packit 857059
Packit 857059
Specifies the file with chassis in cluster. Default is /etc/opa/chassis file.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h \fIhost\fR
Packit 857059
Packit 857059
Specifies the list of hosts to execute command on.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-H \fIchassis\fR
Packit 857059
Packit 857059
Specifies the list of chassis to execute command on.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-u \fIuser\fR
Packit 857059
Packit 857059
Specifies the user to perform the command as:
Packit 857059
.RS
Packit 857059
Packit 857059
.IP \(bu
Packit 857059
For hosts, the default is current user code.
Packit 857059
.IP \(bu
Packit 857059
For chassis, the default is admin.
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
Packit 857059
.TP 10
Packit 857059
-m \fImarker\fR
Packit 857059
Packit 857059
Specifies the marker for end of chassis command output. If omitted, defaults to chassis command prompt. This may be a regular expression.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-T \fItimelimit\fR
Packit 857059
Packit 857059
Specifies the time limit in seconds when running host commands. Default is -1 (infinite).
Packit 857059
Packit 857059
.SH Examples
Packit 857059
Packit 857059
Packit 857059
.SH Operations on Host
Packit 857059
opacmdall date
Packit 857059
.br
Packit 857059
Packit 857059
opacmdall \[aq]uname -a\[aq]
Packit 857059
.br
Packit 857059
Packit 857059
opacmdall -h \[aq]elrond arwen\[aq] date
Packit 857059
.br
Packit 857059
Packit 857059
HOSTS=\[aq]elrond arwen\[aq] opacmdall date
Packit 857059
Packit 857059
.SH Operations on Chassis
Packit 857059
opacmdall -C \[aq]ismPortStats -noprompt\[aq]
Packit 857059
.br
Packit 857059
Packit 857059
opacmdall -C -H \[aq]chassis1 chassis2\[aq] ismPortStats -noprompt\[aq]
Packit 857059
.br
Packit 857059
Packit 857059
CHASSIS=\[aq]chassis1 chassis2\[aq] opacmdall -C ismPortStats -noprompt\[aq]
Packit 857059
.SH Environment Variables
Packit 857059
Packit 857059
.PP
Packit 857059
The following environment variables are also used by this command:
Packit 857059
.TP 10
Packit 857059
\fBHOSTS\fR
Packit 857059
Packit 857059
List of hosts, used if -h option not supplied.
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBCHASSIS\fR
Packit 857059
Packit 857059
List of chassis, used if -C is used and -H and -F options not supplied.
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBHOSTS\(ulFILE\fR
Packit 857059
Packit 857059
File containing list of hosts, used in absence of -f and -h.
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBCHASSIS\(ulFILE\fR
Packit 857059
Packit 857059
File containing list of chassis, used in absence of -F and -H.
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBFF\(ulMAX\(ulPARALLEL\fR
Packit 857059
Packit 857059
When -p option is used, maximum concurrent operations are performed.
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBFF\(ulSERIALIZE\(ulOUTPUT\fR
Packit 857059
Packit 857059
Serialize output of parallel operations (yes or no).
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBFF\(ulCHASSIS\(ulLOGIN\(ulMETHOD\fR
Packit 857059
Packit 857059
How to log into chassis. Can be Telnet or SSH.
Packit 857059
Packit 857059
.TP 10
Packit 857059
\fBFF\(ulCHASSIS\(ulADMIN\(ulPASSWORD\fR
Packit 857059
Packit 857059
Password for admin on all chassis. Used in absence of -S option.
Packit 857059
Packit 857059
.SH Notes
Packit 857059
Packit 857059
.PP
Packit 857059
All commands performed with opacmdall must be non-interactive in nature. opacmdall waits for the command to complete before proceeding. For example, when running host commands such as rm, the -i option (interactively prompt before removal) should not be used. (Note that this option is sometimes part of a standard bash alias list.) Similarly, when running chassis commands such as fwUpdateChassis, the -reboot option should not be used because this option causes an immediate reboot and therefore the command never returns. Also, the chassis command reboot should not be executed using opacmdall. Instead, use the opachassisadmin reboot command to reboot one or more chassis. For further information about individual chassis CLI commands, consult the
Packit 857059
\fIIntel(R) Omni-Path Fabric Switches Command Line Interface Reference Guide\fR
Packit 857059
Packit 857059
. For further information about Linux* operating system commands, consult the man pages.
Packit 857059
.PP
Packit 857059
When performing opacmdall against hosts, internally SSH is used. The command opacmdall requires that password-less SSH be set up between the host running the Intel(R) Omni-Path Fabric Suite FastFabric Toolset and the hosts opacmdall is operating against. The opasetupssh FastFabric tool can aid in setting up password-less SSH.
Packit 857059
.PP
Packit 857059
When performing opacmdall against a set of chassis, all chassis must be configured with the same admin password. Alternatively, the opasetupssh FastFabric tool can be used to set up password-less SSH to the chassis.
Packit 857059
.PP
Packit 857059
When performing operations against chassis, Intel recommends that you set up SSH keys using opasetupssh. If SSH keys are not set up, Intel recommends that you use the -S option to avoid keeping the password in configuration files.