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