pmdaib(1)

1PMDAIB(1)                   General Commands Manual                  PMDAIB(1)
2
3
4

NAME

6       pmdaib - Infiniband performance metrics domain agent (PMDA)
7

SYNOPSYS

9       $PCP_PMDAS_DIR/infiniband/pmdaib [-c configFile] [-D debug] [-d domain]
10       [-l logfile] [-w]
11

DESCRIPTION

13       pmdaib is a Performance  Metrics  Domain  Agent  (PMDA)  which  exports
14       information  and  performance  metrics  about local Infiniband HCAs and
15       local or remote Infiniband GUIDs.
16
17       A brief description of the pmdaib command line options follows:
18
19       -c   Location of the config file.  By default, the config file is named
20            $PCP_PMDAS_DIR/infiniband/config.  See CONFIG FILE for more infor‐
21            mation.
22
23       -D   A debug values, as specified by pmdbg (1)
24
25       -d   Specify an alternate performance metrics  domain  number.   Almost
26            never necessary.
27
28       -l   Location  of the log file.  By default, a log file named ib.log is
29            written to $PCP_LOG_DIR/pmcd.  If the log file cannot  be  created
30            or  is  not  writable,  output  is  written  to the standard error
31            instead.
32
33       -w   Write out the default config  file  to  $PCP_PMDAS_DIRS/infiniband
34            and  exit  immediately.   The written config file will contain the
35            local HCA ports.  It will not overwrite an  existing  file.   This
36            argument  should  only  be used to create the template config file
37            and should never appear in pmcd.conf.  See CONFIG  FILE  for  more
38            information on the file format and on monitoring remote GUIDs.
39

CONFIG FILE

41       By default, the PMDA will operate without using a config file.  In this
42       mode of operation the local HCA ports will be monitored.  Note that  if
43       a  new  HCA  is  added  to  the machine that instance domain naming may
44       change because it will always be based on the kernel's naming.
45
46       In cases where this is not acceptable, or in the case where  monitoring
47       remote  Infiniband ports is required, a config file must be created.  A
48       "template" file can be created by running the pmdaib daemon with the -w
49       argument.   This  will  create  a  config file with the local ports and
50       GUIDs.
51
52       If the config file is executable then it will be  run  and  the  output
53       will be used as the config file.
54
55       The  config  file  is  composed of line-based records.  Blank lines and
56       everything after the hash (#) character are ignored.  Each line  has  6
57       fields:
58
59       [instName] [portGUID] [portNum] via [localPortName]:[localPortNum]
60
61       The  first  field is used to give a static instance name to the Infini‐
62       band port that has a specific GUID.  All of the other  fields  must  be
63       properly specified in order to monitor a particular port.
64
65       For  example, to monitor port 1 of the local HCA called 'mthca0' a pos‐
66       sible config file line would be:
67
68       myPort1 0xdeadbeef01234567 1 via mthca0:1
69
70       Remote ports can be easily monitored by specifying the GUID of the  HCA
71       or  switch  and  specifying  the  remote  port  number.  The localPort‐
72       Name:localPortNum tuple specifies which local HCA and port  to  use  as
73       the  "first  hop" in contacting the remote GUID.  E.g., to monitor port
74       13 of a remote switch which is connected to the  fabric  on  the  first
75       port of the second HCA:
76
77       switch13 0xfeeffeefabcdabcd 13 via mthca1:1
78

LOCAL CONTEXT

80       The  Infiniband  pmda  also  supports accessing the metrics via PM_CON‐
81       TEXT_LOCAL when using the PMAPI interface.  In order to use the Infini‐
82       band pmda in this way, set the environment variable PMDA_LOCAL_IB prior
83       to calling pmNewContext(3).
84

NAME

SYNOPSYS

DESCRIPTION

CONFIG FILE

LOCAL CONTEXT

SEE ALSO