ibroute

title: ibroute(8)

text:
# ibroute(8)

## Name
ibroute - query InfiniBand switch forwarding tables

## SYNOPSIS
ibroute [options] [<dest dr_path|lid|guid> [<startlid> [<endlid>]]]

## DESCRIPTION
ibroute uses SMPs to display the forwarding tables (unicast (LinearForwardingTable or LFT) or multicast (MulticastForwardingTable or MFT)) for the specified switch LID and the optional lid (mlid) range. The default range is all valid entries in the range 1...FDBTop.

## OPTIONS
-a, --all

show all lids in range, even invalid entries

-n, --no_dests

do not try to resolve destinations

-M, --Multicast

show multicast forwarding tables In this case, the range parameters are specifying the mlid range.

### Addressing Flags
-D, --Direct The address specified is a directed route

```
Examples:

   [options] -D [options] "0"          # self port

   [options] -D [options] "0,1,2,1,4"  # out via port 1, then 2, ...

   (Note the second number in the path specified must match the port being

   used.  This can be specified using the port selection flag '-P' or the

   port found through the automatic selection process.)
```

-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

--node-name-map <node-name-map> Specify a node name map.

This file maps GUIDs to more user friendly names. See FILES section.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

## EXAMPLES
Unicast examples

```
ibroute 4               # dump all lids with valid out ports of switch with lid 4
ibroute -a 4            # same, but dump all lids, even with invalid out ports
ibroute -n 4            # simple dump format - no destination resolution
ibroute 4 10            # dump lids starting from 10 (up to FDBTop)
ibroute 4 0x10 0x20     # dump lid range
ibroute -G 0x08f1040023 # resolve switch by GUID
ibroute -D 0,1          # resolve switch by direct path
```

Multicast examples

```
ibroute -M 4                # dump all non empty mlids of switch with lid 4
ibroute -M 4 0xc010 0xc020  # same, but with range
ibroute -M -n 4             # simple dump format
```

## SEE ALSO
ibtracert (8)

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


ibrouters

package: infiniband-diags

title: ibrouters(8)

text:
# ibrouters(8)

## Name
IBROUTERS - show InfiniBand router nodes in topology

## SYNOPSIS
ibrouters [options] [<topology-file>]

## DESCRIPTION
ibrouters is a script which either walks the IB subnet topology or uses an already saved topology file and extracts the router nodes.

## OPTIONS
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

-h, --help show the usage message

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

## SEE ALSO
ibnetdiscover(8)

## DEPENDENCIES
ibnetdiscover, ibnetdiscover format

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >

branch: sisyphus


ibstat

title: ibstat(8)

text:
# ibstat(8)

## Name
ibstat - query basic status of InfiniBand device(s)

## SYNOPSIS
ibstat [options] <ca_name> [portnum]

## DESCRIPTION
ibstat is a binary which displays basic information obtained from the local IB driver. Output includes LID, SMLID, port state, link width active, and port physical state.

It is similar to the ibstatus utility but implemented as a binary rather than a script. It has options to list CAs and/or ports and displays more information than ibstatus.

## OPTIONS
-l, --list_of_cas

list all IB devices

-s, --short

short output

-p, --port_list

show port list

ca_name

InfiniBand device name

portnum

port number of InfiniBand device

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## EXAMPLES

```
ibstat            # display status of all ports on all IB devices
ibstat -l         # list all IB devices
ibstat -p         # show port guids
ibstat mthca0 2   # show status of port 2 of 'mthca0'
```

## SEE ALSO
ibstatus (8)

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


ibstatus

title: ibstatus(8)

text:
# ibstatus(8)

## Name
ibstatus - query basic status of InfiniBand device(s)

## SYNOPSIS
ibstatus [-h] [devname[:port]]...

## DESCRIPTION
ibstatus is a script which displays basic information obtained from the local IB driver. Output includes LID, SMLID, port state, link width active, and port physical state.

## OPTIONS
-h, --help show the usage message

devname

InfiniBand device name

portnum

port number of InfiniBand device

## EXAMPLES

```
ibstatus                    # display status of all IB ports
ibstatus mthca1             # status of mthca1 ports
ibstatus mthca1:1 mthca0:2  # show status of specified ports
```

## SEE ALSO
ibstat (8)

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


ibswitches

title: ibswitches(8)

text:
# ibswitches(8)

## Name
IBSWITCHES - show InfiniBand switch nodes in topology

## SYNOPSIS
ibswitches [options] [<topology-file>]

## DESCRIPTION
ibswitches is a script which either walks the IB subnet topology or uses an already saved topology file and extracts the switch nodes.

## OPTIONS
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

-h, --help show the usage message

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

## SEE ALSO
ibnetdiscover(8)

## DEPENDENCIES
ibnetdiscover, ibnetdiscover format

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


ibsysstat

title: ibsysstat(8)

summary: system status on an InfiniBand address

text:
# ibsysstat(8)

## Name
ibsysstat - system status on an InfiniBand address

## SYNOPSIS
ibsysstat [options] <dest lid | guid> [<op>]

## DESCRIPTION
ibsysstat uses vendor mads to validate connectivity between IB nodes and obtain other information about the IB node. ibsysstat is run as client/server. Default is to run as client.

## OPTIONS
Current supported operations:

```
ping \- verify connectivity to server (default)
host \- obtain host information from server
cpu  \- obtain cpu information from server
```

-o, --oui

use specified OUI number to multiplex vendor mads

-S, --Server

start in server mode (do not return)

### Addressing Flags
-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


ibtracert

title: ibtracert(8)

summary: trace InfiniBand path

text:
# ibtracert(8)

## Name
ibtracert - trace InfiniBand path

## SYNOPSIS
ibtracert [options] [<lid|guid> [<startlid> [<endlid>]]]

## DESCRIPTION
ibtracert uses SMPs to trace the path from a source GID/LID to a destination GID/LID. Each hop along the path is displayed until the destination is reached or a hop does not respond. By using the -m option, multicast path tracing can be performed between source and destination nodes.

## OPTIONS
-n, --no_info

simple format; don't show additional information

-m

show the multicast trace of the specified mlid

-f, --force

force route to destination port

### Addressing Flags
-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

--ports-file <ports-file> Specify a ports file.

This file contains multiple source and destination lid or guid pairs. See FILES section.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--node-name-map <node-name-map> Specify a node name map.

This file maps GUIDs to more user friendly names. See FILES section.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

### PORTS FILE FORMAT
The ports file can be used to specify multiple source and destination pairs. They can be lids or guids. If guids, use the -G option to indicate that.

Generically:

```
# comment
<src> <dst>
```

Example:

```
73 207
203 657
531 101
> OR <
0x0008f104003f125c 0x0008f104003f133d
0x0008f1040011ab07 0x0008f104004265c0
0x0008f104007c5510 0x0008f1040099bb08
```

## EXAMPLES
Unicast examples

```
ibtracert 4 16                                  # show path between lids 4 and 16
ibtracert -n 4 16                               # same, but using simple output format
ibtracert -G 0x8f1040396522d 0x002c9000100d051  # use guid addresses
```

Multicast example

```
ibtracert -m 0xc000 4 16    # show multicast path of mlid 0xc000 between lids 4 and 16
```

## SEE ALSO
ibroute (8)

## AUTHOR
Hal Rosenstock

<<hal.rosenstock@gmail.com>>

Ira Weiny

< <ira.weiny@intel.com> >


infiniband-diags

title: infiniband-diags(8)

summary: Diagnostics for InfiniBand Fabrics

text:
# infiniband-diags(8)

## Name
infiniband-diags - Diagnostics for InfiniBand Fabrics

## DESCRIPTION
infiniband-diags is a set of utilities designed to help configure, debug, and maintain infiniband fabrics. Many tools and utilities are provided. Some with similar functionality.

The base utilities use directed route MAD's to perform their operations. They may therefore work even in unconfigured subnets. Other, higher level utilities, require LID routed MAD's and to some extent SA/SM access.

## THE USE OF SMPs (QP0)
Many of the tools in this package rely on the use of SMPs via QP0 to acquire data directly from the SMA. While this mode of operation is not technically in compliance with the InfiniBand specification, practical experience has found that this level of diagnostics is valuable when working with a fabric which is broken or only partially configured. For this reason many of these tools may require the use of an MKey or operation from Virtual Machines may be restricted for security reasons.

## COMMON OPTIONS
Most OpenIB diagnostics take some of the following common flags. The exact list of supported flags per utility can be found in the documentation for those commands.

### Addressing Flags
The -D and -G option have two forms:

-D, --Direct The address specified is a directed route

```
Examples:

   [options] -D [options] "0"          # self port

   [options] -D [options] "0,1,2,1,4"  # out via port 1, then 2, ...

   (Note the second number in the path specified must match the port being

   used.  This can be specified using the port selection flag '-P' or the

   port found through the automatic selection process.)
```

-D, --Direct <dr_path> The address specified is a directed route

```
Examples:

   -D "0"          # self port

   -D "0,1,2,1,4"  # out via port 1, then 2, ...

   (Note the second number in the path specified must match the port being

   used.  This can be specified using the port selection flag '-P' or the

   port found through the automatic selection process.)
```

-G, --Guid The address specified is a Port GUID

--port-guid, -G <port_guid> Specify a port_guid

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--outstanding_smps, -o <val>

Specify the number of outstanding SMP's which should be issued during the scan Default: 2

--node-name-map <node-name-map> Specify a node name map.

This file maps GUIDs to more user friendly names. See FILES section.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## COMMON FILES
The following config files are common amongst many of the utilities.

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

### TOPOLOGY FILE FORMAT
The topology file format is human readable and largely intuitive. Most identifiers are given textual names like vendor ID (vendid), device ID (device ID), GUIDs of various types (sysimgguid, caguid, switchguid, etc.). PortGUIDs are shown in parentheses (). For switches, this is shown on the switchguid line. For CA and router ports, it is shown on the connectivity lines. The IB node is identified followed by the number of ports and a quoted the node GUID. On the right of this line is a comment (#) followed by the NodeDescription in quotes. If the node is a switch, this line also contains whether switch port 0 is base or enhanced, and the LID and LMC of port 0. Subsequent lines pertaining to this node show the connectivity. On the left is the port number of the current node. On the right is the peer node (node at other end of link). It is identified in quotes with nodetype followed by - followed by NodeGUID with the port number in square brackets. Further on the right is a comment (#). What follows the comment is dependent on the node type. If it it a switch node, it is followed by the NodeDescription in quotes and the LID of the peer node. If it is a CA or router node, it is followed by the local LID and LMC and then followed by the NodeDescription in quotes and the LID of the peer node. The active link width and speed are then appended to the end of this output line.

An example of this is:

```
#
# Topology file: generated on Tue Jun  5 14:15:10 2007
#
# Max of 3 hops discovered
# Initiated from node 0008f10403960558 port 0008f10403960559
Non-Chassis Nodes
vendid=0x8f1
devid=0x5a06
sysimgguid=0x5442ba00003000
switchguid=0x5442ba00003080(5442ba00003080)
Switch  24 "S-005442ba00003080"         # "ISR9024 Voltaire" base port 0 lid 6 lmc 0
[22]    "H-0008f10403961354"[1](8f10403961355)         # "MT23108 InfiniHost Mellanox Technologies" lid 4 4xSDR
[10]    "S-0008f10400410015"[1]         # "SW-6IB4 Voltaire" lid 3 4xSDR
[8]     "H-0008f10403960558"[2](8f1040396055a)         # "MT23108 InfiniHost Mellanox Technologies" lid 14 4xSDR
[6]     "S-0008f10400410015"[3]         # "SW-6IB4 Voltaire" lid 3 4xSDR
[12]    "H-0008f10403960558"[1](8f10403960559)         # "MT23108 InfiniHost Mellanox Technologies" lid 10 4xSDR
vendid=0x8f1
devid=0x5a05
switchguid=0x8f10400410015(8f10400410015)
Switch  8 "S-0008f10400410015"          # "SW-6IB4 Voltaire" base port 0 lid 3 lmc 0
[6]     "H-0008f10403960984"[1](8f10403960985)         # "MT23108 InfiniHost Mellanox Technologies" lid 16 4xSDR
[4]     "H-005442b100004900"[1](5442b100004901)        # "MT23108 InfiniHost Mellanox Technologies" lid 12 4xSDR
[1]     "S-005442ba00003080"[10]                # "ISR9024 Voltaire" lid 6 1xSDR
[3]     "S-005442ba00003080"[6]         # "ISR9024 Voltaire" lid 6 4xSDR
vendid=0x2c9
devid=0x5a44
caguid=0x8f10403960984
Ca      2 "H-0008f10403960984"          # "MT23108 InfiniHost Mellanox Technologies"
[1](8f10403960985)     "S-0008f10400410015"[6]         # lid 16 lmc 1 "SW-6IB4 Voltaire" lid 3 4xSDR
vendid=0x2c9
devid=0x5a44
caguid=0x5442b100004900
Ca      2 "H-005442b100004900"          # "MT23108 InfiniHost Mellanox Technologies"
[1](5442b100004901)     "S-0008f10400410015"[4]         # lid 12 lmc 1 "SW-6IB4 Voltaire" lid 3 4xSDR
vendid=0x2c9
devid=0x5a44
caguid=0x8f10403961354
Ca      2 "H-0008f10403961354"          # "MT23108 InfiniHost Mellanox Technologies"
[1](8f10403961355)     "S-005442ba00003080"[22]                # lid 4 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR
vendid=0x2c9
devid=0x5a44
caguid=0x8f10403960558
Ca      2 "H-0008f10403960558"          # "MT23108 InfiniHost Mellanox Technologies"
[2](8f1040396055a)     "S-005442ba00003080"[8]         # lid 14 lmc 1 "ISR9024 Voltaire" lid 6 4xSDR
[1](8f10403960559)     "S-005442ba00003080"[12]                # lid 10 lmc 1 "ISR9024 Voltaire" lid 6 1xSDR
```

When grouping is used, IB nodes are organized into chassis which are numbered. Nodes which cannot be determined to be in a chassis are displayed as "Non-Chassis Nodes". External ports are also shown on the connectivity lines.

## Utilities list

### Basic fabric connectivity
See: ibnetdiscover, iblinkinfo

### Node information
See: ibnodes, ibswitches, ibhosts, ibrouters

### Port information
See: ibportstate, ibaddr

### Switch Forwarding Table info
See: ibtracert, ibroute, dump_lfts, dump_mfts, check_lft_balance, ibfindnodesusing

### Performance counters
See: ibqueryerrors, perfquery

### Local HCA info
See: ibstat, ibstatus

### Connectivity check
See: ibping, ibsysstat

### Low level query tools
See: smpquery, smpdump, saquery, sminfo

### Fabric verification tools
See: ibidsverify

## Backwards compatibility scripts
The following scripts have been identified as redundant and/or lower performing as compared to the above scripts. They are provided as legacy scripts when --enable-compat-utils is specified at build time.

ibcheckerrors, ibclearcounters, ibclearerrors, ibdatacounters ibchecknet, ibchecknode, ibcheckport, ibcheckportstate, ibcheckportwidth, ibcheckstate, ibcheckwidth, ibswportwatch, ibprintca, ibprintrt, ibprintswitch, set_nodedesc.sh

## AUTHORS
Ira Weiny

< <ira.weiny@intel.com> >


perfquery

title: perfquery(8)

text:
# perfquery(8)

## Name
perfquery - query InfiniBand port counters on a single port

## SYNOPSIS
perfquery [options] [<lid|guid> [[port(s)] [reset_mask]]]

## DESCRIPTION
perfquery uses PerfMgt GMPs to obtain the PortCounters (basic performance and error counters), PortExtendedCounters, PortXmitDataSL, PortRcvDataSL, PortRcvErrorDetails, PortXmitDiscardDetails, PortExtendedSpeedsCounters, or PortSamplesControl from the PMA at the node/port specified. Optionally shows aggregated counters for all ports of node. Finally it can, reset after read, or just reset the counters.

Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortRcvDataSL, components that represent Data (e.g. PortXmitData and PortRcvData) indicate octets divided by 4 rather than just octets.

Note: Inputting a port of 255 indicates an operation be performed on all ports.

Note: For PortCounters, ExtendedCounters, and resets, multiple ports can be specified by either a comma separated list or a port range. See examples below.

## OPTIONS
-x, --extended

show extended port counters rather than (basic) port counters. Note that extended port counters attribute is optional.

-X, --xmtsl

show transmit data SL counter. This is an optional counter for QoS.

-S, --rcvsl

show receive data SL counter. This is an optional counter for QoS.

-D, --xmtdisc

show transmit discard details. This is an optional counter.

-E, --rcverr

show receive error details. This is an optional counter.

-D, --xmtdisc

show transmit discard details. This is an optional counter.

-T, --extended_speeds

show extended speeds port counters. This is an optional counter.

--oprcvcounters

show Rcv Counters per Op code. This is an optional counter.

--flowctlcounters

show flow control counters. This is an optional counter.

--vloppackets

show packets received per Op code per VL. This is an optional counter.

--vlopdata

show data received per Op code per VL. This is an optional counter.

--vlxmitflowctlerrors

show flow control update errors per VL. This is an optional counter.

--vlxmitcounters

show ticks waiting to transmit counters per VL. This is an optional counter.

--swportvlcong

show sw port VL congestion. This is an optional counter.

--rcvcc

show Rcv congestion control counters. This is an optional counter.

--slrcvfecn

show SL Rcv FECN counters. This is an optional counter.

--slrcvbecn

show SL Rcv BECN counters. This is an optional counter.

--xmitcc

show Xmit congestion control counters. This is an optional counter.

--vlxmittimecc

show VL Xmit Time congestion control counters. This is an optional counter.

-c, --smplctl

show port samples control.

-a, --all_ports

show aggregated counters for all ports of the destination lid, reset all counters for all ports, or if multiple ports are specified, aggregate the counters of the specified ports. If the destination lid does not support the AllPortSelect flag, all ports will be iterated through to emulate AllPortSelect behavior.

-l, --loop_ports

If all ports are selected by the user (either through the -a option or port 255) or multiple ports are specified iterate through each port rather than doing than aggregate operation.

-r, --reset_after_read

reset counters after read

-R, --Reset_only

only reset counters

### Addressing Flags
-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

## EXAMPLES

```
perfquery                # read local port performance counters
perfquery 32 1           # read performance counters from lid 32, port 1
perfquery -x 32 1        # read extended performance counters from lid 32, port 1
perfquery -a 32          # read perf counters from lid 32, all ports
perfquery -r 32 1        # read performance counters and reset
perfquery -x -r 32 1     # read extended performance counters and reset
perfquery -R 0x20 1      # reset performance counters of port 1 only
perfquery -x -R 0x20 1   # reset extended performance counters of port 1 only
perfquery -R -a 32       # reset performance counters of all ports
perfquery -R 32 2 0x0fff # reset only error counters of port 2
perfquery -R 32 2 0xf000 # reset only non-error counters of port 2
perfquery -a 32 1-10     # read performance counters from lid 32, port 1-10, aggregate output
perfquery -l 32 1-10     # read performance counters from lid 32, port 1-10, output each port
perfquery -a 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, aggregate output
perfquery -l 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, output each port
```

## AUTHOR
Hal Rosenstock

< <hal.rosenstock@gmail.com> >


saquery

title: saquery(8)

text:
# saquery(8)

## Name
saquery - query InfiniBand subnet administration attributes

## SYNOPSIS
saquery [options] [<name> | <lid> | <guid>]

## DESCRIPTION
saquery issues the selected SA query. Node records are queried by default.

## OPTIONS
-p

get PathRecord info

-N

get NodeRecord info

-D, --list

get NodeDescriptions of CAs only

-S

get ServiceRecord info

-I

get InformInfoRecord (subscription) info

-L

return the Lids of the name specified

-l

return the unique Lid of the name specified

-G

return the Guids of the name specified

-O

return the name for the Lid specified

-U

return the name for the Guid specified

-c

get the SA's class port info

-s

return the PortInfoRecords with isSM or isSMdisabled capability mask bit on

-g

get multicast group info

-m

get multicast member info. If a group is specified, limit the output to the group specified and print one line containing only the GUID and node description for each entry. Example: saquery -m 0xc000

-x

get LinkRecord info

--src-to-dst <src:dst>

get a PathRecord for <src:dst> where src and dst are either node names or LIDs

--sgid-to-dgid <sgid:dgid>

get a PathRecord for sgid to dgid where both GIDs are in an IPv6 format acceptable to inet_pton (3)

--smkey <val>

use SM_Key value for the query. Will be used only with "trusted" queries. If non-numeric value (like 'x') is specified then saquery will prompt for a value. Default (when not specified here or in /etc/infiniband-diags/ibdiag.conf) is to use SM_Key == 0 (or "untrusted")

-K, --show_keys

show security keys (mkey, smkey, etc.) associated with the request.

--slid <lid> Source LID (PathRecord)

--dlid <lid> Destination LID (PathRecord)

--mlid <lid> Multicast LID (MCMemberRecord)

--sgid <gid> Source GID (IPv6 format) (PathRecord)

--dgid <gid> Destination GID (IPv6 format) (PathRecord)

--gid <gid> Port GID (MCMemberRecord)

--mgid <gid> Multicast GID (MCMemberRecord)

--reversible Reversible path (PathRecord)

--numb_path Number of paths (PathRecord)

--pkey P_Key (PathRecord, MCMemberRecord). If non-numeric value (like 'x')

is specified then saquery will prompt for a value

--qos_class QoS Class (PathRecord)

--sl Service level (PathRecord, MCMemberRecord)

--mtu MTU and selector (PathRecord, MCMemberRecord)

--rate Rate and selector (PathRecord, MCMemberRecord)

--pkt_lifetime Packet lifetime and selector (PathRecord, MCMemberRecord)

--qkey Q_Key (MCMemberRecord). If non-numeric value (like 'x') is specified

then saquery will prompt for a value

--tclass Traffic Class (PathRecord, MCMemberRecord)

--flow_label Flow Label (PathRecord, MCMemberRecord)

--hop_limit Hop limit (PathRecord, MCMemberRecord)

--scope Scope (MCMemberRecord)

--join_state Join state (MCMemberRecord)

--proxy_join Proxy join (MCMemberRecord)

--service_id ServiceID (PathRecord)

Supported query names (and aliases):

```
ClassPortInfo (CPI)
NodeRecord (NR) [lid]
PortInfoRecord (PIR) [[lid]/[port]/[options]]
SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]
PKeyTableRecord (PKTR) [[lid]/[port]/[block]]
VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]
InformInfoRecord (IIR)
LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]
ServiceRecord (SR)
PathRecord (PR)
MCMemberRecord (MCMR)
LFTRecord (LFTR) [[lid]/[block]]
MFTRecord (MFTR) [[mlid]/[position]/[block]]
GUIDInfoRecord (GIR) [[lid]/[block]]
SwitchInfoRecord (SWIR) [lid]
SMInfoRecord (SMIR) [lid]
```

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--outstanding_smps, -o <val>

Specify the number of outstanding SMP's which should be issued during the scan Default: 2

--node-name-map <node-name-map> Specify a node name map.

This file maps GUIDs to more user friendly names. See FILES section.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## COMMON FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

## DEPENDENCIES
OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad

## AUTHORS
Ira Weiny

< <ira.weiny@intel.com> >

Hal Rosenstock

< <halr@mellanox.com> >


sminfo

title: sminfo(8)

summary: query InfiniBand SMInfo attribute

text:
# sminfo(8)

## Name
sminfo - query InfiniBand SMInfo attribute

## SYNOPSIS
sminfo [options] sm_lid | sm_dr_path [modifier]

## DESCRIPTION
Optionally set and display the output of a sminfo query in human readable format. The target SM is the one listed in the local port info, or the SM specified by the optional SM lid or by the SM direct routed path.

Note: using sminfo for any purposes other then simple query may be very dangerous, and may result in a malfunction of the target SM.

## OPTIONS
-s, --state <state> set SM state

0 not active 1 discovering

2 standby

3 master

-p, --priority <priority> set priority (0-15)

-a, --activity <val> set activity count

### Addressing Flags
-D, --Direct The address specified is a directed route

```
Examples:

   [options] -D [options] "0"          # self port

   [options] -D [options] "0,1,2,1,4"  # out via port 1, then 2, ...

   (Note the second number in the path specified must match the port being

   used.  This can be specified using the port selection flag '-P' or the

   port found through the automatic selection process.)
```

-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

## EXAMPLES

```
sminfo                  # local port\'s sminfo
sminfo 32               # show sminfo of lid 32
sminfo  -G 0x8f1040023  # same but using guid address
```

## SEE ALSO
smpdump (8)

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


smpdump

title: smpdump(8)

text:
# smpdump(8)

## Name
smpdump - dump InfiniBand subnet management attributes

## SYNOPSIS
smpdump [options] <dlid|dr_path> <attribute> [attribute_modifier]

## DESCRIPTION
smpdump is a general purpose SMP utility which gets SM attributes from a specified SMA. The result is dumped in hex by default.

## OPTIONS
dlid|drpath

LID or DR path to SMA

attribute

IBA attribute ID for SM attribute

attribute_modifier

IBA modifier for SM attribute

-s, --string

Print strings in packet if possible

### Addressing Flags
-D, --Direct The address specified is a directed route

```
Examples:

   [options] -D [options] "0"          # self port

   [options] -D [options] "0,1,2,1,4"  # out via port 1, then 2, ...

   (Note the second number in the path specified must match the port being

   used.  This can be specified using the port selection flag '-P' or the

   port found through the automatic selection process.)
```

-L, --Lid The address specified is a LID

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

## EXAMPLES
Direct Routed Examples

```
smpdump -D 0,1,2,3,5 16 # NODE DESC
smpdump -D 0,1,2 0x15 2 # PORT INFO, port 2
```

LID Routed Examples

```
smpdump 3 0x15 2        # PORT INFO, lid 3 port 2
smpdump 0xa0 0x11       # NODE INFO, lid 0xa0
```

## SEE ALSO
smpquery (8)

## AUTHOR
Hal Rosenstock

< <halr@voltaire.com> >


smpquery

title: smpquery(8)

text:
# smpquery(8)

## Name
smpquery - query InfiniBand subnet management attributes

## SYNOPSIS
smpquery [options] <op> <dest dr_path|lid|guid> [op params]

## DESCRIPTION
smpquery allows a basic subset of standard SMP queries including the following: node info, node description, switch info, port info. Fields are displayed in human readable format.

## OPTIONS
Current supported operations (case insensitive) and their parameters:

```
Nodeinfo (NI) <addr>
Nodedesc (ND) <addr>
Portinfo (PI) <addr> [<portnum>]     # default port is zero
PortInfoExtended (PIE) <addr> [<portnum>]
Switchinfo (SI) <addr>
PKeyTable (PKeys) <addr> [<portnum>]
SL2VLTable (SL2VL) <addr> [<portnum>]
VLArbitration (VLArb) <addr> [<portnum>]
GUIDInfo (GI) <addr>
MlnxExtPortInfo (MEPI) <addr> [<portnum>]  # default port is zero
```

-c, --combined

Use Combined route address argument <lid> <DR_Path>

-x, --extended

Set SMSupportsExtendedSpeeds bit 31 in AttributeModifier (only impacts PortInfo queries).

-K, --show_keys

show security keys (mkey, smkey, etc.) associated with the request.

### Addressing Flags
-D, --Direct The address specified is a directed route

```
Examples:

   [options] -D [options] "0"          # self port

   [options] -D [options] "0,1,2,1,4"  # out via port 1, then 2, ...

   (Note the second number in the path specified must match the port being

   used.  This can be specified using the port selection flag '-P' or the

   port found through the automatic selection process.)
```

-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--node-name-map <node-name-map> Specify a node name map.

This file maps GUIDs to more user friendly names. See FILES section.

-y, --m_key <key>

use the specified M_key for requests. If non-numeric value (like 'x') is specified then a value will be prompted for.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

### NODE NAME MAP FILE FORMAT
The node name map is used to specify user friendly names for nodes in the output. GUIDs are used to perform the lookup.

This functionality is provided by the opensm-libs package. See opensm(8) for the file location for your installation.

Generically:

```
# comment
<guid> "<name>"
```

Example:

```
# IB1
# Line cards
0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
# Spines
0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
# GUID   Node Name
0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
```

## EXAMPLES

```
smpquery portinfo 3 1                     # portinfo by lid, with port modifier
smpquery -G switchinfo 0x2C9000100D051 1  # switchinfo by guid
smpquery -D nodeinfo 0                    # nodeinfo by direct route
smpquery -c nodeinfo 6 0,12               # nodeinfo by combined route
```

## SEE ALSO
smpdump (8)

## AUTHOR
Hal Rosenstock

< <hal@mellanox.com> >


vendstat

title: vendstat(8)

text:
# vendstat(8)

## Name
vendstat - query InfiniBand vendor specific functions

## SYNOPSIS
vendstat [options] <lid|guid>

## DESCRIPTION
vendstat uses vendor specific MADs to access beyond the IB spec vendor specific functionality. Currently, there is support for Mellanox InfiniSwitch-III (IS3) and InfiniSwitch-IV (IS4).

## OPTIONS
-N

show IS3 or IS4 general information.

-w

show IS3 port xmit wait counters.

-i

show IS4 counter group info.

-c <num,num>

configure IS4 counter groups. Configure IS4 counter groups 0 and 1. Such configuration is not persistent across IS4 reboot. First number is for counter group 0 and second is for counter group 1.

Group 0 counter config values:

```
        0 - PortXmitDataSL0-7

        1 - PortXmitDataSL8-15

        2 - PortRcvDataSL0-7
Group 1 counter config values:
```

```
1 - PortXmitDataSL8-15
2 - PortRcvDataSL0-7
8 - PortRcvDataSL8-15
```

-R, --Read <addr,mask>

Read configuration space record at addr

-W, --Write <addr,val,mask>

Write configuration space record at addr

### Addressing Flags
-G, --Guid The address specified is a Port GUID

-L, --Lid The address specified is a LID

-s, --sm_port <smlid> use 'smlid' as the target lid for SA queries.

### Port Selection flags
-C, --Ca <ca_name> use the specified ca_name.

-P, --Port <ca_port> use the specified ca_port.

### Local port Selection
Multiple port/Multiple CA support: when no IB device or port is specified (see the "local umad parameters" below), the libibumad library selects the port to use by the following criteria:

1.

the first port that is ACTIVE.

2.

if not found, the first port that is UP (physical link up).

If a port and/or CA name is specified, the libibumad library attempts to fulfill the user request, and will fail if it is not possible.

For example:

```
ibaddr                 # use the first port (criteria #1 above)
ibaddr -C mthca1       # pick the best port from "mthca1" only.
ibaddr -P 2            # use the second (active/up) port from the first available IB device.
ibaddr -C mthca0 -P 2  # use the specified port only.
```

### Debugging flags
-d

raise the IB debugging level. May be used several times (-ddd or -d -d -d).

-e

show send and receive errors (timeouts and others)

-h, --help show the usage message

-v, --verbose

increase the application verbosity level. May be used several times (-vv or -v -v -v)

-V, --version show the version info.

### Configuration flags
-t, --timeout <timeout_ms> override the default timeout for the solicited mads.

--config, -z <config_file> Specify alternate config file.

Default: /etc/infiniband-diags/ibdiag.conf

## FILES

### CONFIG FILE
/etc/infiniband-diags/ibdiag.conf

A global config file is provided to set some of the common options for all tools. See supplied config file for details.

## EXAMPLES

```
vendstat -N 6           # read IS3 or IS4 general information
vendstat -w 6           # read IS3 port xmit wait counters
vendstat -i 6 12        # read IS4 port 12 counter group info
vendstat -c 0,1 6 12    # configure IS4 port 12 counter groups for PortXmitDataSL
vendstat -c 2,8 6 12    # configure IS4 port 12 counter groups for PortRcvDataSL
```

## AUTHOR
Hal Rosenstock

< <hal.rosenstock@gmail.com> >


ibcheckerrors

package: infiniband-diags-compat

title: ibcheckerrors(8)

summary: validate IB subnet and report errors

text:
# ibcheckerrors(8)

## NAME
ibcheckerrors - validate IB subnet and report errors

## SYNOPSIS
ibcheckerrors [-h] [-b] [-v] [-N | -nocolor] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibcheckerrors is a script which uses a full topology file that was created by ibnetdiscover, scans the network to validate the connectivity and reports errors (from port counters).

## OPTIONS
-v increase the verbosity level

-b brief mode. Reduce the output to show only if errors are present,

not what they are.

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), ibchecknode(8), ibcheckport(8), ibcheckerrs(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibcheckerrs

title: ibcheckerrs(8)

text:
# ibcheckerrs(8)

## NAME
ibcheckerrs - validate IB port (or node) and report errors in counters above threshold

## SYNOPSIS
ibcheckerrs [-h] [-b] [-v] [-G] [-T <threshold_file>] [-s(how_thresholds)] [-N | -nocolor] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] <lid|guid> <port>

## DESCRIPTION
Check specified port (or node) and report errors that surpassed their predefined threshold. Port address is lid unless -G option is used to specify a GUID address. The predefined thresholds can be dumped using the -s option, and a user defined threshold_file (using the same format as the dump) can be specified using the -t <file> option.

## OPTIONS
-G use GUID address argument. In most cases, it is the Port GUID.

Example:

"0x08f1040023"

-s show predefined thresholds

-T use specified threshold file

-v increase the verbosity level

-b brief mode. Reduce the output to show only if errors are

present, not what they are.

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## EXAMPLE
ibcheckerrs 2 # check aggregated node counter for lid 2

ibcheckerrs 2 4 # check port counters for lid 2 port 4

ibcheckerrs -T xxx 2 # check node using xxx threshold file

## SEE ALSO
perfquery(8), ibaddr(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibchecknet

title: ibchecknet(8)

summary: validate IB subnet and report errors

text:
# ibchecknet(8)

## NAME
ibchecknet - validate IB subnet and report errors

## SYNOPSIS
ibchecknet [-h] [-N | -nocolor] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibchecknet is a script which uses a full topology file that was created by ibnetdiscover, and scans the network to validate the connectivity and reports errors (from port counters).

## OPTIONS
-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), ibchecknode(8), ibcheckport(8), ibcheckerrs(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibchecknode

title: ibchecknode(8)

summary: validate IB node and report errors

text:
# ibchecknode(8)

## NAME
ibchecknode - validate IB node and report errors

## SYNOPSIS
ibchecknode [-h] [-v] [-N | -nocolor] [-G] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] <lid|guid>

## DESCRIPTION
Check connectivity and do some simple sanity checks for the specified node. Port address is a lid unless -G option is used to specify a GUID address.

## OPTIONS
-G use GUID address argument. In most cases, it is the Port GUID.

Example:

"0x08f1040023"

-v increase the verbosity level

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## EXAMPLE
ibchecknode 2 # check node via lid 2

## SEE ALSO
smpquery(8), ibaddr(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibcheckport

title: ibcheckport(8)

summary: validate IB port and report errors

text:
# ibcheckport(8)

## NAME
ibcheckport - validate IB port and report errors

## SYNOPSIS
ibcheckport [-h] [-v] [-N | -nocolor] [-G] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] <lid|guid> <port>

## DESCRIPTION
Check connectivity and do some simple sanity checks for the specified port. Port address is a lid unless -G option is used to specify a GUID address.

## OPTIONS
-G use GUID address argument. In most cases, it is the Port GUID.

Example:

"0x08f1040023"

-v increase the verbosity level

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## EXAMPLE
ibcheckport 2 3 # check lid 2 port 3

## SEE ALSO
smpquery(8), ibaddr(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibcheckportstate

title: ibcheckportstate(8)

text:
# ibcheckportstate(8)

## NAME
ibcheckportstate - validate IB port for LinkUp and not Active state

## SYNOPSIS
ibcheckportstate [-h] [-v] [-N | -nocolor] [-G] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] <lid|guid> <port>

## DESCRIPTION
Check connectivity and check the specified port for proper port state (Active) and port physical state (LinkUp). Port address is a lid unless -G option is used to specify a GUID address.

## OPTIONS
-G use GUID address argument. In most cases, it is the Port GUID.

Example:

"0x08f1040023"

-v increase the verbosity level

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## EXAMPLE
ibcheckportstate 2 3 # check lid 2 port 3

## SEE ALSO
smpquery(8), ibaddr(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibcheckportwidth

title: ibcheckportwidth(8)

summary: validate IB port for 1x link width

text:
# ibcheckportwidth(8)

## NAME
ibcheckportwidth - validate IB port for 1x link width

## SYNOPSIS
ibcheckportwidth [-h] [-v] [-N | -nocolor] [-G] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] <lid|guid> <port>

## DESCRIPTION
Check connectivity and check the specified port for 1x link width. Port address is a lid unless -G option is used to specify a GUID address.

## OPTIONS
-G use GUID address argument. In most cases, it is the Port GUID.

Example:

"0x08f1040023"

-v increase the verbosity level

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## EXAMPLE
ibcheckportwidth 2 3 # check lid 2 port 3

## SEE ALSO
smpquery(8), ibaddr(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibcheckstate

title: ibcheckstate(8)

text:
# ibcheckstate(8)

## NAME
ibcheckstate - find ports in IB subnet which are link up but not active

## SYNOPSIS
ibcheckstate [-h] [-v] [-N | -nocolor] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibcheckstat is a script which uses a full topology file that was created by ibnetdiscover, scans the network to validate the port state and port physical state, and reports any ports which have a port state other than Active or a port physical state other than LinkUp.

## OPTIONS
-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), ibchecknode(8), ibcheckportstate(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibcheckwidth

title: ibcheckwidth(8)

summary: find 1x links in IB subnet

text:
# ibcheckwidth(8)

## NAME
ibcheckwidth - find 1x links in IB subnet

## SYNOPSIS
ibcheckwidth [-h] [-v] [-N | -nocolor] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibcheckwidth is a script which uses a full topology file that was created by ibnetdiscover, scans the network to validate the active link widths and reports any 1x links.

## OPTIONS
-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), ibchecknode(8), ibcheckportwidth(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibclearcounters

title: ibclearcounters(8)

summary: clear port counters in IB subnet

text:
# ibclearcounters(8)

## NAME
ibclearcounters - clear port counters in IB subnet

## SYNOPSIS
ibclearcounters [-h] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibclearcounters is a script that clears the PMA port counters by either walking the IB subnet topology or using an already saved topology file.

## OPTIONS
-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), perfquery(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibclearerrors

title: ibclearerrors(8)

summary: clear error counters in IB subnet

text:
# ibclearerrors(8)

## NAME
ibclearerrors - clear error counters in IB subnet

## SYNOPSIS
ibclearerrors [-h] [-N | -nocolor] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibclearerrors is a script which clears the PMA error counters in PortCounters by either walking the IB subnet topology or using an already saved topology file.

## OPTIONS
-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), perfquery(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibdatacounters

title: ibdatacounters(8)

summary: query IB subnet for data counters

text:
# ibdatacounters(8)

## NAME
ibdatacounters - query IB subnet for data counters

## SYNOPSIS
ibdatacounters [-h] [-b] [-v] [-N | -nocolor] [<topology-file> | -C ca_name -P ca_port -t(imeout) timeout_ms]

## DESCRIPTION
ibdatacounters is a script which uses a full topology file that was created by ibnetdiscover, scans the network to validate the connectivity and reports the data counters (from port counters).

## OPTIONS
-v increase the verbosity level

-b brief mode. Reduce the output to show only if errors are present,

not what they are.

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## SEE ALSO
ibnetdiscover(8), ibdatacounts(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibdatacounts

title: ibdatacounts(8)

summary: get IB port data counters

text:
# ibdatacounts(8)

## NAME
ibdatacounts - get IB port data counters

## SYNOPSIS
ibdatacounts [-h] [-b] [-v] [-G] [-N | -nocolor] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] <lid|guid> [<port>]

## DESCRIPTION
Obtain PMA data counters from specified port (or node). Port address is lid unless -G option is used to specify a GUID address.

## OPTIONS
-G use GUID address argument. In most cases, it is the Port GUID.

Example:

"0x08f1040023"

-v increase the verbosity level

-b brief mode

-N | -nocolor use mono rather than color mode

-C <ca_name> use the specified ca_name.

-P <ca_port> use the specified ca_port.

-t <timeout_ms> override the default timeout for the solicited mads.

## EXAMPLE
ibdatacounts 2 # show data counters for lid 2

ibdatacounts 2 4 # show data counters for lid 2 port 4

## SEE ALSO
perfquery(8), ibaddr(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibdiscover

title: ibdiscover(8)

text:
# ibdiscover(8)

## NAME
ibdiscover.pl - annotate and compare InfiniBand topology

## SYNOPSIS
ibdiscover.pl

## DESCRIPTION
ibdiscover.pl uses a topology file create by ibnetdiscover and a discover.map file which the network administrator creates which indicates the nodes to be expected and a ibdiscover.topo file which is the expected connectivity and produces a new connectivity file (discover.topo.new) and outputs the changes to stdout. The network administrator can choose to replace the "old" topo file with the new one or certain changes in.

The syntax of the ibdiscover.map file is:

<nodeGUID>|port|"Text for node"|<NodeDescription from ibnetdiscover format>

e.g.

8f10400410015|8|"ISR 6000"|# SW-6IB4 Voltaire port 0 lid 5

8f10403960558|2|"HCA 1"|# MT23108 InfiniHost Mellanox Technologies

The syntax of the old and new topo files (ibdiscover.topo and ibdiscover.topo.new) are:

<LocalPort>|<LocalNodeGUID>|<RemotePort>|<RemoteNodeGUID>

e.g.

10|5442ba00003080|1|8f10400410015

These topo files are produced by the ibdiscover.pl tool.

## USAGE
ibnetdiscover | ibdiscover.pl

## SEE ALSO
ibnetdiscover(8)

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibprintca

title: ibprintca(8)

text:
# ibprintca(8)

## NAME
ibprintca.pl - print either the ca specified or the list of cas from the ibnetdiscover output

## SYNOPSIS
ibprintca.pl [-R -l -C <ca_name> -P <ca_port>] [<ca_guid|node_name>]

## DESCRIPTION
Faster than greping/viewing with an editor the output of ibnetdiscover, ibprintca.pl will parse out and print either the CA information for the specified CA or a list of all the CAs in the subnet.

Finally, ibprintca.pl will also reuse the cached ibnetdiscover output from some of the other diag tools which makes it a bit faster than running ibnetdiscover from scratch.

## OPTIONS
-l

List the CAs (simply a wrapper for ibhosts).

-R

Recalculate the ibnetdiscover information, ie do not use the cached information. This option is slower but should be used if the diag tools have not been used for some time or if there are other reasons to believe that the fabric has changed.

-C <ca_name> use the specified ca_name for the search.

-P <ca_port> use the specified ca_port for the search.

## AUTHORS
Ira Weiny

<weiny2@llnl.gov>

Hal Rosenstock

<halr@voltaire.com>


ibprintrt

title: ibprintrt(8)

text:
# ibprintrt(8)

## NAME
ibprintrt.pl - print either only the router specified or a list of routers from the ibnetdiscover output

## SYNOPSIS
ibprintrt.pl [-R -l -C <ca_name> -P <ca_port>] [<rt_guid|node_name>]

## DESCRIPTION
Faster than greping/viewing with an editor the output of ibnetdiscover, ibprintrt.pl will parse out and print either the router information for the specified IB router or a list of all IB routers in the subnet.

Finally, ibprintrt.pl will also reuse the cached ibnetdiscover output from some of the other diag tools which makes it a bit faster than running ibnetdiscover from scratch.

## OPTIONS
-l

List the Rts (simply a wrapper for ibrouters).

-R

Recalculate the ibnetdiscover information, ie do not use the cached information. This option is slower but should be used if the diag tools have not been used for some time or if there are other reasons to believe that the fabric has changed.

-C <ca_name> use the specified ca_name for the search.

-P <ca_port> use the specified ca_port for the search.

## AUTHOR
Hal Rosenstock

<halr@voltaire.com>


ibprintswitch

title: ibprintswitch(8)

text:
# ibprintswitch(8)

## NAME
ibprintswitch.pl - print either the switch specified or a list of switches from the ibnetdiscover output

## SYNOPSIS
ibprintswitch.pl [-R -l -C <ca_name> -P <ca_port>] [<switch_guid|switch_name>]

## DESCRIPTION
Faster than greping/viewing with an editor the output of ibnetdiscover, ibprintswitch.pl will parse out and print either the switch information for the switch specified or a list of all the switches found in the subnet. In addition, it will crudely parse on the node description information and if found report all the information for an entire chasis if the description information is consistent.

Finally, ibprintswitch.pl will also reuse the cached ibnetdiscover output from some of the other diag tools which makes it a bit faster than running ibnetdiscover from scratch.

## OPTIONS
-l

List the switches (simply a wrapper for ibswitches).

-R

Recalculate the ibnetdiscover information, ie do not use the cached information. This option is slower but should be used if the diag tools have not been used for some time or if there are other reasons to believe that the fabric has changed.

-C <ca_name> use the specified ca_name for the search.

-P <ca_port> use the specified ca_port for the search.

## AUTHORS
Ira Weiny

<weiny2@llnl.gov>

Hal Rosenstock

<halr@voltaire.com>


ibswportwatch

title: ibswportwatch(8)

text:
# ibswportwatch(8)

## NAME
ibswportwatch.pl - poll the counters on the specified switch/port and report rate of change information.

## SYNOPSIS
ibswportwatch.pl [-p <pause_time> -v -n <cycles> -G] <guid|lid> <port>

## DESCRIPTION
ibswportwatch.pl polls the port counters of the specified port and calculates rate of change information.

## OPTIONS
-p <pause_time>

Specify a pause time (polling interval) other than the default.

-v

Be verbose.

-n <cycles>

Run for a set number of poll intervals and stop. (Default == -1 == forever)

-G

The address provided is a GUID rather than LID.

## AUTHOR
Ira Weiny

<weiny2@llnl.gov>


update-info-dir

package: info-install

title: update-info-dir(8)

text:
# update-info-dir(8)

## NAME
update-info-dir - (re-)create /usr/share/info/dir from all installed info files

## SYNOPSIS
update-info-dir [options]

## DESCRIPTION
This manual page documents briefly the update-info-dir command. This manual page was written for the Debian GNU/Linux distribution because the original script was designed for Debian packaging system.

update-info-dir [info-directory] (re-)creates the index of available documentation in info format (the file /usr/share/info/dir) which is usually presented by info browsers on startup.

## OPTIONS
info-directory

If an argument is given update the dir file in the directory given, otherwise use /usr/share/info.

## AUTHOR
This manual page was written by Norbert Preining <preining@logic.at>, for the Debian GNU/Linux system (but may be used by others).