Blame IbaTools/man/opagetvf.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 opagetvf 1 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
Packit 857059
.SH NAME
Packit 857059
opagetvf
Packit 857059
Packit 857059
Packit 857059
.PP
Packit 857059
Used for scripting application use of vFabrics, such as for mpirun parameters. You can query by VF Name, VF Index, Service ID, MGID, PKey, or SL. Fetches the Virtual Fabric info in a delimited format. Returns exactly one matching VF. When multiple VFs match the query, it prefers non-default VFs in which the calling server is a full member. If multiple choices remain, it returns the one with the lowest VF Index. Uses the same algorithm as the Distributed SA Plug-in (DSAP).
Packit 857059
.PP
Packit 857059
The tool can be used with additional scripts to help set PKey, SL, MTU, and Rate when running MPI jobs. Internally, this tool is based on the opasaquery -o vfinfocsv command. For more information, see
Packit 857059
\fIopasaquery\fR
Packit 857059
.
Packit 857059
.SH Syntax
Packit 857059
opagetvf [-h  \fIhfi\fR] [-p  \fIport\fR] [-e] [-d  \fIvfname\fR | -S  \fIserviceId\fR | -m  \fImcgid\fR |
Packit 857059
.br
Packit 857059
Packit 857059
-i  \fIvfIndex\fR | -k  \fIpkey\fR | -L  \fIsl\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
-h \fIhfi\fR
Packit 857059
Packit 857059
Specifies the HFI to send by. Default is first HFI.
Packit 857059
.TP 10
Packit 857059
-p \fIport\fR
Packit 857059
Packit 857059
Specifies the port to send by. Default is first active port.
Packit 857059
.TP 10
Packit 857059
-e
Packit 857059
Packit 857059
Outputs MTU and rate as enum values.
Packit 857059
.TP 10
Packit 857059
-d \fIvfname\fR
Packit 857059
Packit 857059
Queries by VirtualFabric Name.
Packit 857059
.TP 10
Packit 857059
-S \fIserviceId\fR
Packit 857059
Packit 857059
Queries by Application ServiceId.
Packit 857059
.TP 10
Packit 857059
-m \fIgid\fR
Packit 857059
Packit 857059
Queries by Application Multicast GID.
Packit 857059
.TP 10
Packit 857059
-i \fIvfindex\fR
Packit 857059
Packit 857059
Queries by VirtualFabric Index.
Packit 857059
.TP 10
Packit 857059
-k \fIpkey\fR
Packit 857059
Packit 857059
Queries by VirtualFabric PKey.
Packit 857059
.TP 10
Packit 857059
-L \fISL\fR
Packit 857059
Packit 857059
Queries by VirtualFabric SL.
Packit 857059
.SH Examples
Packit 857059
opagetvf -d \[aq]Compute\[aq]
Packit 857059
.br
Packit 857059
Packit 857059
opagetvf -h 2 -p 2 -d \[aq]Compute\[aq]
Packit 857059
.SH Sample Outputs
Packit 857059
Packit 857059
.PP
Packit 857059
The output is of the form: name:index:pkey:sl:mtu:rate:optionflag::mcastSl as shown in the following example.
Packit 857059
.PP
Packit 857059
Option flag (bitmask) values include:
Packit 857059
.IP \(bu
Packit 857059
0x00 Indicates no bits are set. Specifically, no QoS, no Security, and no flow control disabled (which means flow control is enabled).
Packit 857059
.IP \(bu
Packit 857059
0x01 Security
Packit 857059
.IP \(bu
Packit 857059
0x02 QoS
Packit 857059
.IP \(bu
Packit 857059
0x04 Flow Control Disable
Packit 857059
.PP
Packit 857059
Packit 857059
.br
Packit 857059
# opagetvf -d Default
Packit 857059
.br
Packit 857059
Packit 857059
Default:0:0xffff:0:unlimited:unlimited:0x0::
Packit 857059
Packit 857059
.br