Blame doc/rst/saquery.8.in.rst

Packit db064d
=======
Packit db064d
saquery
Packit db064d
=======
Packit db064d
Packit db064d
-------------------------------------------------
Packit db064d
query InfiniBand subnet administration attributes
Packit db064d
-------------------------------------------------
Packit db064d
Packit db064d
:Date: @BUILD_DATE@
Packit db064d
:Manual section: 8
Packit db064d
:Manual group: Open IB Diagnostics
Packit db064d
Packit db064d
SYNOPSIS
Packit db064d
========
Packit db064d
Packit db064d
saquery [options] [<name> | <lid> | <guid>]
Packit db064d
Packit db064d
DESCRIPTION
Packit db064d
===========
Packit db064d
Packit db064d
saquery issues the selected SA query. Node records are queried by default.
Packit db064d
Packit db064d
OPTIONS
Packit db064d
=======
Packit db064d
Packit db064d
**-p**
Packit db064d
        get PathRecord info
Packit db064d
Packit db064d
**-N**
Packit db064d
        get NodeRecord info
Packit db064d
Packit db064d
**-D, --list**
Packit db064d
        get NodeDescriptions of CAs only
Packit db064d
Packit db064d
**-S**
Packit db064d
        get ServiceRecord info
Packit db064d
Packit db064d
**-I**
Packit db064d
        get InformInfoRecord (subscription) info
Packit db064d
Packit db064d
**-L**
Packit db064d
        return the Lids of the name specified
Packit db064d
Packit db064d
**-l**
Packit db064d
        return the unique Lid of the name specified
Packit db064d
Packit db064d
**-G**
Packit db064d
        return the Guids of the name specified
Packit db064d
Packit db064d
**-O**
Packit db064d
        return the name for the Lid specified
Packit db064d
Packit db064d
**-U**
Packit db064d
        return the name for the Guid specified
Packit db064d
Packit db064d
**-c**
Packit db064d
        get the SA's class port info
Packit db064d
Packit db064d
**-s**
Packit db064d
        return the PortInfoRecords with isSM or isSMdisabled capability mask bit on
Packit db064d
Packit db064d
**-g**
Packit db064d
        get multicast group info
Packit db064d
Packit db064d
**-m**
Packit db064d
        get multicast member info.  If a group is specified, limit the output
Packit db064d
        to the group specified and print one line containing only the GUID and
Packit db064d
        node description for each entry. Example: saquery -m 0xc000
Packit db064d
Packit db064d
**-x**
Packit db064d
        get LinkRecord info
Packit db064d
Packit db064d
**--src-to-dst <src:dst>**
Packit db064d
        get a PathRecord for <src:dst>
Packit db064d
        where src and dst are either node names or LIDs
Packit db064d
Packit db064d
**--sgid-to-dgid <sgid:dgid>**
Packit db064d
        get a PathRecord for **sgid** to **dgid**
Packit db064d
        where both GIDs are in an IPv6 format acceptable to **inet_pton (3)**
Packit db064d
Packit db064d
**--smkey <val>**
Packit db064d
        use SM_Key value for the query. Will be used only with "trusted"
Packit db064d
        queries.  If non-numeric value (like 'x') is specified then saquery
Packit db064d
	will prompt for a value.
Packit db064d
	Default (when not specified here or in
Packit db064d
	@IBDIAG_CONFIG_PATH@/ibdiag.conf) is to use SM_Key == 0 (or
Packit db064d
	\"untrusted\")
Packit db064d
Packit db064d
.. include:: common/opt_K.rst
Packit db064d
Packit db064d
**--slid <lid>** Source LID (PathRecord)
Packit db064d
Packit db064d
**--dlid <lid>** Destination LID (PathRecord)
Packit db064d
Packit db064d
**--mlid <lid>** Multicast LID (MCMemberRecord)
Packit db064d
Packit db064d
**--sgid <gid>** Source GID (IPv6 format) (PathRecord)
Packit db064d
Packit db064d
**--dgid <gid>** Destination GID (IPv6 format) (PathRecord)
Packit db064d
Packit db064d
**--gid <gid>** Port GID (MCMemberRecord)
Packit db064d
Packit db064d
**--mgid <gid>** Multicast GID (MCMemberRecord)
Packit db064d
Packit db064d
**--reversible** Reversible path (PathRecord)
Packit db064d
Packit db064d
**--numb_path** Number of paths (PathRecord)
Packit db064d
Packit db064d
**--pkey** P_Key (PathRecord, MCMemberRecord). If non-numeric value (like 'x')
Packit db064d
        is specified then saquery will prompt for a value
Packit db064d
Packit db064d
**--qos_class** QoS Class (PathRecord)
Packit db064d
Packit db064d
**--sl** Service level (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--mtu** MTU and selector (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--rate** Rate and selector (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--pkt_lifetime** Packet lifetime and selector (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--qkey** Q_Key (MCMemberRecord). If non-numeric value (like 'x') is specified
Packit db064d
        then saquery will prompt for a value
Packit db064d
Packit db064d
**--tclass** Traffic Class (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--flow_label** Flow Label (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--hop_limit** Hop limit (PathRecord, MCMemberRecord)
Packit db064d
Packit db064d
**--scope** Scope (MCMemberRecord)
Packit db064d
Packit db064d
**--join_state** Join state (MCMemberRecord)
Packit db064d
Packit db064d
**--proxy_join** Proxy join (MCMemberRecord)
Packit db064d
Packit db064d
**--service_id** ServiceID (PathRecord)
Packit db064d
Packit db064d
Supported query names (and aliases):
Packit db064d
Packit db064d
::
Packit db064d
Packit db064d
        ClassPortInfo (CPI)
Packit db064d
        NodeRecord (NR) [lid]
Packit db064d
        PortInfoRecord (PIR) [[lid]/[port]/[options]]
Packit db064d
        SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]
Packit db064d
        PKeyTableRecord (PKTR) [[lid]/[port]/[block]]
Packit db064d
        VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]
Packit db064d
        InformInfoRecord (IIR)
Packit db064d
        LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]
Packit db064d
        ServiceRecord (SR)
Packit db064d
        PathRecord (PR)
Packit db064d
        MCMemberRecord (MCMR)
Packit db064d
        LFTRecord (LFTR) [[lid]/[block]]
Packit db064d
        MFTRecord (MFTR) [[mlid]/[position]/[block]]
Packit db064d
        GUIDInfoRecord (GIR) [[lid]/[block]]
Packit db064d
        SwitchInfoRecord (SWIR) [lid]
Packit db064d
        SMInfoRecord (SMIR) [lid]
Packit db064d
Packit db064d
Packit db064d
Packit db064d
Port Selection flags
Packit db064d
--------------------
Packit db064d
Packit db064d
.. include:: common/opt_C.rst
Packit db064d
.. include:: common/opt_P.rst
Packit db064d
.. include:: common/sec_portselection.rst
Packit db064d
Packit db064d
Packit db064d
Debugging flags
Packit db064d
---------------
Packit db064d
Packit db064d
.. include:: common/opt_d.rst
Packit db064d
.. include:: common/opt_e.rst
Packit db064d
.. include:: common/opt_h.rst
Packit db064d
.. include:: common/opt_v.rst
Packit db064d
.. include:: common/opt_V.rst
Packit db064d
Packit db064d
Packit db064d
Configuration flags
Packit db064d
-------------------
Packit db064d
Packit db064d
.. include:: common/opt_t.rst
Packit db064d
.. include:: common/opt_o-outstanding_smps.rst
Packit db064d
.. include:: common/opt_node_name_map.rst
Packit db064d
.. include:: common/opt_z-config.rst
Packit db064d
Packit db064d
Packit db064d
Packit db064d
COMMON FILES
Packit db064d
============
Packit db064d
Packit db064d
.. include:: common/sec_config-file.rst
Packit db064d
Packit db064d
.. include:: common/sec_node-name-map.rst
Packit db064d
Packit db064d
Packit db064d
Packit db064d
DEPENDENCIES
Packit db064d
============
Packit db064d
Packit db064d
OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad
Packit db064d
Packit db064d
AUTHORS
Packit db064d
=======
Packit db064d
Packit db064d
Ira Weiny
Packit db064d
        < ira.weiny@intel.com >
Packit db064d
Packit db064d
Hal Rosenstock
Packit db064d
        < halr@mellanox.com >