Merge branch 'master' of git://git.pcp.io/pcp into qt
[pcp.git] / qa / 226.out
blob8d8086865a028aa4fc718b3b945f9dced5eb6aa6
1 QA output created by 226
2 help [ command ]
4 attr name [value]
5 attr attr# [value]
6 children metric-name
7 close
8 debug all | none
9 debug flag [ flag ... ] (flag is decimal or symbolic name)
10 desc metric
11 fetch metric [ metric ... ]
12 getdesc on | off
13 instance indom# [ number | name | "name" ]
14 name pmid#
15 namespace fname
16 open dso dsoname init_routine [ domain# ]
17 open pipe execname [ arg ... ]
18 open socket unix sockname
19 open socket inet port#|service
20 open socket ipv6 port#|service
21 pmid metric-name
22 profile indom# [ all | none ]
23 profile indom# [ add | delete ] number
24 quit
25 status
26 store metric "value"
27 text metric
28 text indom indom#
29 timer on | off
30 traverse metric-name
31 wait seconds
32 watch logfilename
34 dbpmda> help attr
36 attr name [value]
37 attr attr# [value]
39 Set a security attribute. These set aspects of per-user authentication,
40 allowing a PMDA to provide different metric views for different users.
42 dbpmda> help children
44 children metric-name
46 Fetch and print the next name component of the direct decendents of
47 metric-name in the PMNS, reporting for each if it is a leaf node or a
48 non-leaf node.
49 Most useful for PMDAs that support dynamic metrics in the PMNS.
51 dbpmda> help close
53 close
55 Close the pipe to a daemon PMDA or dlclose(3) a DSO PMDA. dbpmda does not
56 exit, allowing another PMDA to be opened.
58 dbpmda> help debug
60 debug all | none
61 debug flag [ flag ... ] (flag is decimal or symbolic name)
63 Specify which debugging flags should be active (see pmdbg(1)).  Flags may
64 be specified as integers or by name, with multiple flags separated by
65 white space.  All flags may be selected or deselected if 'all' or 'none' is
66 specified.  The current setting is displayed by the status command.
69 dbpmda> help desc
71 desc metric
73 Print out the meta data description for the 'metric'.  The metric may be
74 specified by name, or as a PMID of the form N, N.N or N.N.N.
76 dbpmda> help fetch
78 fetch metric [ metric ... ]
80 Fetch metrics from the PMDA.  The metrics may be specified as a list of
81 metric names, or PMIDs of the form N, N.N or N.N.N.
83 dbpmda> help getdesc
85 getdesc on | off
87 Before doing a fetch, get the descriptor so that the result of a fetch
88 can be printed out correctly.
90 dbpmda> help instance
92 instance indom# [ number | name | "name" ]
94 List the instances in 'indom'.  The list may be restricted to a specific
95 instance 'name' or 'number'.
97 dbpmda> help name
99 name pmid#
101 Print the name of the metric with PMID pmid#.  The pmid# syntax follows
102 the source PMNS syntax, namely 3 numbers separated by '.' to encode
103 the domain, cluster and item components of the PMID, e.g.
104     name 29.0.1004
105 Most useful for PMDAs that support dynamic metrics in the PMNS.
107 dbpmda> help namespace
109 namespace fname
111 Unload the current Name Space and load up the given Name Space.
112 If unsuccessful then will try to reload the previous Name Space.
114 dbpmda> help open
116 open dso dsoname init_routine [ domain# ]
117 open pipe execname [ arg ... ]
118 open socket unix sockname
119 open socket inet port#|service
120 open socket ipv6 port#|service
122 Open a PMDA as either a DSO, via a network socket (unix/inet/ipv6), or as a
123 daemon (connected with a pipe).  The 'dsoname' and 'execname' fields are
124 the path to the PMDA shared object file or executable.  The first socket PMDA
125 field is the type - either unix (if supported), inet or ipv6.  The 'sockname'
126 argument for unix sockets is a path of a named pipe where a PMDA is listening
127 for connections.  The 'port' argument is a port number, 'serv' a service name
128 typically defined in /etc/services (resolved to a port via getservent(3)).
129 The arguments to this command are similar to a line in the pmcd.conf file.
131 dbpmda> help pmid
133 pmid metric-name
135 Print the PMID for the named metric
136 Most useful for PMDAs that support dynamic metrics in the PMNS.
138 dbpmda> help profile
140 profile indom# [ all | none ]
141 profile indom# [ add | delete ] number
143 For the instance domain specified, the profile may be changed to include
144 'all' instances, no instances, add an instance or delete an instance.
146 dbpmda> help quit
148 quit
150 Exit dbpmda.  This also closes any open PMDAs.
152 dbpmda> help status
154 status
156 Display the state of dbpmda, including which PMDA is connected, which
157 pmDebug flags are set, and the current profile.
159 dbpmda> help store
161 store metric "value"
163 Store the value (int, real or string) into the 'metric'.  The metric may be
164 specified by name or as a PMID with the format N, N.N, N.N.N.  The value to
165 be stored must be enclosed in quotes.  Unlike the other commands, a store
166 must request a metric description and fetch the metric to determine how to
167 interpret the value, and to allocate the PDU for transmitting the value,
168 respectively.  The current profile will be used.
170 dbpmda> help text
172 text metric
173 text indom indom#
175 Retrieve the help text for the 'metric' or 'indom' from the PMDA.  The one
176 line message is shown between '[' and ']' with the long message on the next
177 line.  To get the help text for an instance domain requires the word
178 ``indom'' before the indom number
180 dbpmda> help timer
182 timer on | off
184 Report the response time of the PMDA when sending and receiving PDUs.
186 dbpmda> help traverse
188 traverse metric-name
190 Fetch and print all of the decendent metric names below metric-name
191 in the PMNS.
192 Most useful for PMDAs that support dynamic metrics in the PMNS.
194 dbpmda> help wait
196 wait seconds
198 Sleep for this number of seconds
200 dbpmda> help watch
202 watch logfilename
204 An xterm window is opened which tails the specified log file.  This window
205 must be closed by the user when no longer required.
207 dbpmda>