Blame IbaTools/man/opagenesmchassis.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 opagenesmchassis 8 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
Packit 857059
.SH NAME
Packit 857059
opagenesmchassis
Packit 857059
Packit 857059
Packit 857059
.PP
Packit 857059
Generates a list of chassis IPv4 and IPv6 addresses and/or TCP names where the Embedded Subnet Manager (ESM) is running, in a format acceptable for inclusion in the /etc/opa/esm\(ulchassis file. This tool uses opagenchassis output to iterate through all the chassis.
Packit 857059
.SH Syntax
Packit 857059
opagenesmchassis [-u user] [-S] [-t  \fIportsfile\fR] [-p  \fIports\fR]
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
-u \fIuser\fR
Packit 857059
Packit 857059
Performs command as user. For chassis, the default is admin.
Packit 857059
.TP 10
Packit 857059
-S
Packit 857059
Packit 857059
Securely prompts for password for user on chassis.
Packit 857059
.TP 10
Packit 857059
-t \fIportsfile\fR
Packit 857059
Packit 857059
Specifies the file with a list of local HFI ports used to access fabric(s) for analysis.
Packit 857059
.br
Packit 857059
Default is /etc/opa/ports
Packit 857059
.TP 10
Packit 857059
-p \fIports\fR
Packit 857059
Packit 857059
Specifies the list of local HFI ports used to access fabrics.
Packit 857059
Packit 857059
.IP
Packit 857059
Default is first active port. The first HFI in the system is 1. The first port on an HFI is 1. Uses the format hfi:port,
Packit 857059
.br
Packit 857059
for example:
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
0:0
Packit 857059
First active port in system.
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
0:y
Packit 857059
Port \fIy\fR within system.
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
x:0
Packit 857059
First active port on HFI \fIx\fR.
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
x:y
Packit 857059
HFI \fIx\fR, port \fIy\fR.
Packit 857059
Packit 857059
.RE
Packit 857059
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
\fBFF\(ulCHASSIS\(ulADMIN\(ulPASSWORD\fR
Packit 857059
Packit 857059
Password for chassis, used in absence of -S.
Packit 857059
.TP 10
Packit 857059
\fBPORTS\fR
Packit 857059
Packit 857059
List of ports, used in absence of -t and -p.
Packit 857059
.TP 10
Packit 857059
\fBPORTS\(ulFILE\fR
Packit 857059
Packit 857059
File containing list of ports, used in absence of -t and -p.
Packit 857059
.SH Examples
Packit 857059
opagenesmchassis
Packit 857059
.br
Packit 857059
Packit 857059
opagenesmchassis -S -p \[aq]1:1 1:2 2:1 2:2\[aq]
Packit 857059
.PP
Packit 857059
Alternatively, while editing the file, use a vi command to include the output such as:
Packit 857059
.br
Packit 857059
:r! opagenesmchassis