qa/226.out.1

   1 QA output created by 226
   2 help [ command ]
   3
   4 children metric-name
   5 close
   6 debug all | none
   7 debug flag [ flag ... ] (flag is decimal or symbolic name)
   8 desc metric
   9 fetch metric [ metric ... ]
  10 getdesc on | off
  11 instance indom# [ number | name | "name" ]
  12 name pmid#
  13 namespace fname
  14 open dso dsoname init_routine [ domain# ]
  15 open pipe execname [ arg ... ]
  16 open socket sockname
  17 pmid metric-name
  18 profile indom# [ all | none ]
  19 profile indom# [ add | delete ] number
  20 quit
  21 status
  22 store metric "value"
  23 text metric
  24 text indom indom#
  25 timer on | off
  26 traverse metric-name
  27 wait seconds
  28 watch logfilename
  29
  30 dbpmda> help children
  31
  32 children metric-name
  33
  34 Fetch and print the next name component of the direct decendents of
  35 metric-name in the PMNS, reporting for each if it is a leaf node or a
  36 non-leaf node.
  37 Most useful for PMDAs that support dynamic metrics in the PMNS.
  38
  39 dbpmda> help close
  40
  41 close
  42
  43 Close the pipe to a daemon PMDA or dlclose(3) a DSO PMDA. dbpmda does not
  44 exit, allowing another PMDA to be opened.
  45
  46 dbpmda> help debug
  47
  48 debug all | none
  49 debug flag [ flag ... ] (flag is decimal or symbolic name)
  50
  51 Specify which debugging flags should be active (see pmdbg(1)).  Flags may
  52 be specified as integers or by name, with multiple flags separated by
  53 white space.  All flags may be selected or deselected if 'all' or 'none' is
  54 specified.  The current setting is displayed by the status command.
  55
  56
  57 dbpmda> help desc
  58
  59 desc metric
  60
  61 Print out the meta data description for the 'metric'.  The metric may be
  62 specified by name, or as a PMID of the form N, N.N or N.N.N.
  63
  64 dbpmda> help fetch
  65
  66 fetch metric [ metric ... ]
  67
  68 Fetch metrics from the PMDA.  The metrics may be specified as a list of
  69 metric names, or PMIDs of the form N, N.N or N.N.N.
  70
  71 dbpmda> help getdesc
  72
  73 getdesc on | off
  74
  75 Before doing a fetch, get the descriptor so that the result of a fetch
  76 can be printed out correctly.
  77
  78 dbpmda> help instance
  79
  80 instance indom# [ number | name | "name" ]
  81
  82 List the instances in 'indom'.  The list may be restricted to a specific
  83 instance 'name' or 'number'.
  84
  85 dbpmda> help name
  86
  87 name pmid#
  88
  89 Print the name of the metric with PMID pmid#.  The pmid# syntax follows
  90 the source PMNS syntax, namely 3 numbers separated by '.' to encode
  91 the domain, cluster and item components of the PMID, e.g.
  92     name 29.0.1004
  93 Most useful for PMDAs that support dynamic metrics in the PMNS.
  94
  95 dbpmda> help namespace
  96
  97 namespace fname
  98
  99 Unload the current Name Space and load up the given Name Space.
 100 If unsuccessful then will try to reload the previous Name Space.
 101
 102 dbpmda> help open
 103
 104 open dso dsoname init_routine [ domain# ]
 105 open pipe execname [ arg ... ]
 106 open socket sockname
 107
 108 Open a PMDA as either a DSO, via UNIX domain socket (named pipe), or as a
 109 daemon (connected with a pipe).  The 'dsoname' and 'execname' fields are
 110 the path to the PMDA shared object file or executable.  The 'sockname'
 111 field is the path of a named pipe where a PMDA is listening for connections.
 112 The arguments to this command are similar to a line in the pmcd.conf file.
 113
 114 dbpmda> help pmid
 115
 116 pmid metric-name
 117
 118 Print the PMID for the named metric
 119 Most useful for PMDAs that support dynamic metrics in the PMNS.
 120
 121 dbpmda> help profile
 122
 123 profile indom# [ all | none ]
 124 profile indom# [ add | delete ] number
 125
 126 For the instance domain specified, the profile may be changed to include
 127 'all' instances, no instances, add an instance or delete an instance.
 128
 129 dbpmda> help quit
 130
 131 quit
 132
 133 Exit dbpmda.  This also closes any open PMDAs.
 134
 135 dbpmda> help status
 136
 137 status
 138
 139 Display the state of dbpmda, including which PMDA is connected, which
 140 pmDebug flags are set, and the current profile.
 141
 142 dbpmda> help store
 143
 144 store metric "value"
 145
 146 Store the value (int, real or string) into the 'metric'.  The metric may be
 147 specified by name or as a PMID with the format N, N.N, N.N.N.  The value to
 148 be stored must be enclosed in quotes.  Unlike the other commands, a store
 149 must request a metric description and fetch the metric to determine how to
 150 interpret the value, and to allocate the PDU for transmitting the value,
 151 respectively.  The current profile will be used.
 152
 153 dbpmda> help text
 154
 155 text metric
 156 text indom indom#
 157
 158 Retrieve the help text for the 'metric' or 'indom' from the PMDA.  The one
 159 line message is shown between '[' and ']' with the long message on the next
 160 line.  To get the help text for an instance domain requires the word
 161 ``indom'' before the indom number
 162
 163 dbpmda> help timer
 164
 165 timer on | off
 166
 167 Report the response time of the PMDA when sending and receiving PDUs.
 168
 169 dbpmda> help traverse
 170
 171 traverse metric-name
 172
 173 Fetch and print all of the decendent metric names below metric-name
 174 in the PMNS.
 175 Most useful for PMDAs that support dynamic metrics in the PMNS.
 176
 177 dbpmda> help wait
 178
 179 wait seconds
 180
 181 Sleep for this number of seconds
 182
 183 dbpmda> help watch
 184
 185 watch logfilename
 186
 187 A xwsh window is opened which tails the specified log file.  This window
 188 must be closed by the user when no longer required.
 189
 190 dbpmda>