1PMFIND(1) General Commands Manual PMFIND(1)
2
6 pmfind - find PCP services on the network
7
9 pmfind [-qr?] [-m mechanism] [-s service] [-t timeout]
10
12 pmfind searches for instances of the specified PCP service being adver‐
13 tised on the network and prints a list of URLs corresponding to the
14 services discovered.
15
17 -m mechanism, --mechanism=mechanism This option sets the mechanism that
18 pmfind uses when performing service discovery. By default, or if the
19 keyword all is specified, every available mechanism will be used (iter‐
20 atively). See the ``MECHANISMS'' section for a description of each
21 available discovery mechanism.
22 -q, --quiet
24 This option suppresses all output on the standard output stream.
25 -r, --resolve
27 Requests that DNS name resolution be attempted for the addresses
28 of any discovered services. The default is to display the net‐
29 work addresses of any discovered services.
30 -s service, --service=service
32 By default pmfind will search for all supported PCP services,
33 however a specific PCP service to discover can be specified
34 using the -s option. Supported services are pmcd(1), and
35 pmproxy(1).
36 -t seconds, --timeout=seconds
39 Sets the maximum amount of time in seconds that pmfind
40 will take before interrupting the service discovery. The
41 time argument is a floating point number representing the
42 number of seconds before timing out. The default is to
43 take as much time as is needed to complete the process.
44 -?, --help
46 Display usage message and exit.
47
49 Supported mechanisms for service discovery are:
50 avahi Searches for services which are broadcasting using mDNS
52 via avahi-daemon(8). An optional suffix ",timeout=N" may
53 be added to limit the amount of time waiting for the
54 avahi-daemon. N is a floating point number specifying
55 the number of seconds to wait. The default is 0.5 sec‐
56 onds. This timeout may also be specified by setting the
57 environment variable AVAHI_DISCOVERY_TIMEOUT to the
58 desired number of seconds. If both are specified, then
59 the value specified in the environment variable takes
60 precedence.
61 probe=<net-address>/<mask-bits>
63 Actively probes the given subnet for the requested PCP
64 service(s). <net-address> is an Inet or IPv6 network
65 address and <mask-bits> is the number of bits used to
66 define the subnet. For example, 192.168.1.0/24 defines
67 an 8 bit subnet consisting of the addresses 192.168.1.0
68 through 192.168.1.255. An optional suffix ",max‐
69 Threads=N" may be added to limit the number of threads
70 used while probing. The default is the value of FD_SET‐
71 SIZE (which is typically 1024) or the number of addresses
72 in the subnet, whichever is less. An optional suffix
73 ",timeout=N" may be added to limit the amount of time
74 spent waiting for each connection attempt. N is a float‐
75 ing point number specifying the number of seconds to
76 wait. The default is 0.02 seconds (20 milliseconds).
77 shell Probes the list of addresses provided by scripts for
79 requested PCP service(s). Several optional, comma-sepa‐
80 rated parameters can also be provided. The "path=DIR"
81 option specifies the directory where commands like pcp-
82 kube-pods(1) are located (defaults to
83 $PCP_BINADM_DIR/discover/). This setting can be further
84 restricted to an individual command using the command=CMD
85 option, but the default is to use all available commands
86 from the path. The "maxThreads=N" option limits the num‐
87 ber of threads used while probing. The default is the
88 value of FD_SETSIZE (which is typically 1024) or the num‐
89 ber of addresses returned by the scripts, whichever is
90 less. The "timeout=N" option may be added to limit the
91 amount of time spent waiting for each connection attempt.
92 N is a floating point number specifying the number of
93 seconds to wait. The default is 0.02 seconds (20 mil‐
94 liseconds).
95
97 pmfind will interrupt the service discovery process when one of
98 the following signals is received: SIGHUP, SIGPIPE, SIGINT,
99 SIGTERM, SIGXFSZ, SIGXCPU. pmfind will report any results which
100 were discovered up to point of the interruption.
101
103 The value of the exit status from the command is zero when ser‐
104 vices were successfully located, one if no services were found,
105 and two if an error occurred.
106 In the event of an error a message will be generated on standard
108 error that is intended to be self-explanatory.
109
111 $PCP_BINADM_DIR/discover
112 default path to address discovery scripts
113
115 Environment variables with the prefix PCP_ are used to parame‐
116 terize the file and directory names used by PCP. On each
117 installation, the file /etc/pcp.conf contains the local values
118 for these variables. The $PCP_CONF variable may be used to
119 specify an alternative configuration file, as described in
120 pcp.conf(5).
121
123 PCPIntro(1), pmcd(1), pmproxy(1), pcp-kube-pods(1), PMAPI(3),
124 PMWEBAPI(3), pmDiscoverServices(3), pcp.conf(5) and pcp.env(5).
125Performance Co-Pilot PCP PMFIND(1)