Basic Commands

From OpenFabrics Alliance Wiki
Revision as of 11:27, 28 October 2014 by Skcoulter (Talk | contribs)

Jump to: navigation, search

IB Basic Commands

ibstat

 Displays operational information about one or more InfiniBand network devices. This command displays InfiniBand operational
 information pertaining to a specified Host Channel Adapter Device (HCAD). If an HCAD device name is not entered, status for 
 all available HCADs are displayed. Select a flag to narrow down your search results. You can display specific categories of 
 information, including Node, Port, Interface, and Debug information. You can also choose to display all of the information 
 categories.
 Flags:
 -d	Displays current debug setting.
 -h	Displays ibstat command usage.
 -i	Displays network interface information.
 -n	Displays IB node information.
 -p	Displays IB port information.
 -v	Displays all IB device information.


ibv_devinfo

{{{ Print information about RDMA devices available for use from user space.

Flags: -d, --ib-dev=DEVICE use IB device DEVICE (default first device found) -i, --ib-port=PORT query port PORT (default all ports) -l, --list only list names of RDMA devices -v, --verbose print all available }}}

sminfo

{{{ Query InfiniBand SMInfo attribute. 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.

Flags: -s set SM state 0 - not active 1 - discovering 2 - standby 3 - master -p set priority (0-15) -a set activity count }}}

ping hostname-ib0

{{{ }}}

ibping

{{{ ibping uses vendor mads to validate connectivity between IB nodes. On exit, (IP) ping like output is show. ibping is run as client/server. Default is to run as client. Note also that a default ping server is implemented within the kernel.

Flags: -c stop after count packets -f, --flood flood destination: send packets back to back without delay -o, --oui use specified OUI number to multiplex vendor mads -S, --Server start in server mode (do not return) }}}

ib_tracert

{{{ Uses SMP to trace path from Source GID/LID to Destinatino GID/LID 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.

Flags: -n, --no_info simple format; don't show additional information -m show the multicast trace of the specified mlid --node-name-map <node-name-map> Specify a node name map. The node name map file maps GUIDs to more user friendly names. }}}

perfquery

{{{ 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. Also, optionally, reset after read, or only reset 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.

Common Flags:

  1. 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  : show the usage message -v  : increase the application verbosity level.

      : May be used several times (-vv or -v -v -v)

-V  : show the version info.

  1. Addressing flags

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

      : Example: "0x08f1040023"

-s <smlid>:use ’smlid’ as the target lid for SM/SA queries.

  1. Other common flags:

-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.

Multiple CA/Multiple Port Support When no IB device or port is specified, the port to use is selected 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 user request is attempted to be fulfilled, and will fail if it is not possible.

}}}

ibdiagnet

4x

ibnetdiscover

{{{ ibnetdiscover performs IB subnet discovery and outputs a human readable topology file. GUIDs, node types, and port numbers are displayed as well as port LIDs and NodeDescriptions. All nodes (and links) are displayed (full topology). Optionally, this utility can be used to list the current connected nodes by nodetype. The output is printed to standard output unless a topology file is specified.

Common Options: -l, --list  : List of connected nodes -g, --grouping  : Show grouping. Grouping correlates IB nodes by different vendor specific schemes. It may also show the switch external ports correspondence. -H, --Hca_list  : List of connected CAs -S, --Switch_list : List of connected switches -R, --Router_list : List of connected routers -s, --show  : Show progress information during discovery. --node-name-map <node-name-map>: Specify a node name map. The node name map file maps GUIDs to more user friendly names. -p, --ports  : Obtain a ports report which is a list of connected ports with relevant information (like LID, portnum, GUID, width, speed, and NodeDescription). -m, --max_hops  : Report max hops discovered. }}}


ibportstate

lid