1PMFIND(1) General Commands Manual PMFIND(1)
2
6 pmfind - find PCP services on the network
7
9 pmfind [-q] [-m mechanism] [-s service] [-r] [-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 By default pmfind will search for all supported PCP services, however a
17 specific PCP service to discover can be specified using the -s (or
18 --service) option. Supported services are pmcd(1), pmproxy(1) and
19 pmwebd(1).
20 The -m (or --mechanism) option sets the mechanism that pmfind uses when
22 performing service discovery. By default, or if the keyword "all" is
23 specified, every available mechanism will be used (iteratively). Sup‐
24 ported mechanisms are:
25 avahi Searches for services which are broadcasting using mDNS via
27 avahi-daemon(8). An optional suffix ",timeout=N" may be added
28 to limit the amount of time waiting for the avahi-daemon. N is a
29 floating point number specifying the number of seconds to wait.
30 The default is 0.5 seconds. This timeout may also be specified
31 by setting the environment variable AVAHI_DISCOVERY_TIMEOUT to
32 the desired number of seconds. If both are specified, then the
33 value specified in the environment variable takes precedence.
34 probe=<net-address>/<mask-bits>
36 Actively probes the given subnet for the requested PCP ser‐
37 vice(s). <net-address> is an inet or ipv6 network address and
38 <mask-bits> is the number of bits used to define the subnet.
39 For example, 192.168.1.0/24 defines an 8 bit subnet consisting
40 of the addresses 192.168.1.0 through 192.168.1.255. An optional
41 suffix ",maxThreads=N" may be added to limit the number of
42 threads used while probing. The default is the value of FD_SET‐
43 SIZE (which is typically 1024) or the number of addresses in the
44 subnet, whichever is less. An optional suffix ",timeout=N" may
45 be added to limit the amount of time spent waiting for each con‐
46 nection attempt. N is a floating point number specifying the
47 number of seconds to wait. The default is 0.02 seconds (20 mil‐
48 liseconds).
49 shell Probes the list of addresses provided by scripts for requested
51 PCP service(s). Several optional, comma-separated parameters
52 can also be provided. The "path=DIR" option specifies the
53 directory where commands like pcp-kube-pods(1) are located
54 (defaults to $PCP_BINADM_DIR/discover/). This setting can be
55 further restricted to an individual command using the com‐
56 mand=CMD option, but the default is to use all available com‐
57 mands from the path. The "maxThreads=N" option limits the num‐
58 ber of threads used while probing. The default is the value of
59 FD_SETSIZE (which is typically 1024) or the number of addresses
60 returned by the scripts, whichever is less. The "timeout=N"
61 option may be added to limit the amount of time spent waiting
62 for each connection attempt. N is a floating point number spec‐
63 ifying the number of seconds to wait. The default is 0.02 sec‐
64 onds (20 milliseconds).
65 The -r (or --resolve) option requests that DNS name resolution be
67 attempted for the addresses of any discovered services. The default is
68 to display the network addresses of any discovered services.
69 The -t (or --timeout) option sets the maximum amount of time that
71 pmfind will take before interrupting the service discovery. The argu‐
72 ment is a floating point number representing the number of seconds
73 before timing out. The default is to take as much time as is needed to
74 complete the process.
75 The -q (or --quiet) option suppresses all output on the standard output
77 stream.
78
80 $PCP_BINADM_DIR/discover
81 default path to address discovery scripts
82
84 Environment variables with the prefix PCP_ are used to parameterize the
85 file and directory names used by PCP. On each installation, the file
86 /etc/pcp.conf contains the local values for these variables. The
87 $PCP_CONF variable may be used to specify an alternative configuration
88 file, as described in pcp.conf(5).
89
91 The value of the exit status from the command is zero when services
92 were successfully located, one if no services were found, and two if an
93 error occurred.
94 In the event of an error, a message will be generated on standard error
96 that is intended to be self-explanatory.
97
99 pmfind will interrupt the service discovery process when one of the
100 following signals is received: SIGHUP, SIGPIPE, SIGINT, SIGTERM,
101 SIGXFSZ, SIGXCPU. pmfind will report any results which were discovered
102 up to point of the interruption.
103
105 PCPIntro(1), pmcd(1), pmproxy(1), pmwebd(1), pcp-kube-pods(1),
106 PMAPI(3), pmDiscoverServices(3), pcp.conf(5) and pcp.env(5).
107Performance Co-Pilot PCP PMFIND(1)