Blame IbaTools/man/opashowallports.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 opashowallports 8 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
Packit 857059
.SH NAME
Packit 857059
opashowallports
Packit 857059
Packit 857059
Packit 857059
.PP
Packit 857059
Packit 857059
\fB(Switch and Host)\fR
Packit 857059
Displays basic port state and statistics for all host nodes, chassis, or externally-managed switches.
Packit 857059
.PP
Packit 857059
Packit 857059
.B NOTE:
Packit 857059
opareport and opareports are more powerful Intel(R) Omni-Path Fabric Suite FastFabric commands. For general fabric analysis, use opareport or opareports with options such as -o errors and -o slowlinks to perform an efficient analysis of link speeds and errors.
Packit 857059
Packit 857059
Packit 857059
.SH Syntax
Packit 857059
opashowallports [-C] [-f  \fIhostfile\fR] [-F  \fIchassisfile\fR] [-h \[aq]\fIhosts\fR\[aq]]
Packit 857059
.br
Packit 857059
Packit 857059
[-H \[aq]\fIchassis\fR\[aq]] [-S]
Packit 857059
.SH Options
Packit 857059
Packit 857059
.TP 10
Packit 857059
--help
Packit 857059
Packit 857059
Produces full help text.
Packit 857059
.TP 10
Packit 857059
-C
Packit 857059
Packit 857059
Performs operation against chassis. Default is host.
Packit 857059
.TP 10
Packit 857059
-f \fIhostfile\fR
Packit 857059
Packit 857059
Specifies the file containing the list of hosts in cluster. Default is /etc/opa/hosts file.
Packit 857059
.TP 10
Packit 857059
-F \fIchassisfile\fR
Packit 857059
Packit 857059
Specifies the file containing the list of chassis in cluster. Default is /etc/opa/chassis file.
Packit 857059
.TP 10
Packit 857059
-h \fIhosts\fR
Packit 857059
Packit 857059
Specifies the list of hosts for which to show ports.
Packit 857059
.TP 10
Packit 857059
-H \fIchassis\fR
Packit 857059
Packit 857059
Specifies the list of chassis for which to show ports.
Packit 857059
.TP 10
Packit 857059
-S
Packit 857059
Packit 857059
Securely prompts for password for admin on chassis.
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\(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 Example
Packit 857059
opashowallports
Packit 857059
.br
Packit 857059
Packit 857059
opashowallports -h \[aq]elrond arwen\[aq]
Packit 857059
.br
Packit 857059
Packit 857059
HOSTS=\[aq]elrond arwen\[aq] opashowallports
Packit 857059
.br
Packit 857059
Packit 857059
opashowallports -C
Packit 857059
.br
Packit 857059
Packit 857059
opashowallports -H \[aq]chassis1 chassis2\[aq]
Packit 857059
.br
Packit 857059
Packit 857059
CHASSIS=\[aq]chassis1 chassis2\[aq] opashowallports -C
Packit 857059
.SH Notes
Packit 857059
Packit 857059
.PP
Packit 857059
When performing opashowallports against hosts, internally SSH is used. The command opashowallports requires that password-less SSH be set up between the host running the Intel(R) Omni-Path Fabric Suite FastFabric Toolset and the hosts opashowallports is operating against. The opasetupssh FastFabric tool can aid in setting up password-less SSH.
Packit 857059
.PP
Packit 857059
When performing operations against chassis, Intel recommends that you set up SSH keys (see
Packit 857059
\fIopasetupssh\fR
Packit 857059
). If SSH keys are not set up, Intel recommends that you use the -S option, to avoid keeping the password in configuration files.
Packit 857059
.PP
Packit 857059
When performing opashowallports against externally-managed switches, a node with Intel(R) Omni-Path Fabric Suite FastFabric Toolset installed is required. Typically, this is the node from which opashowallports is being run.