1PMDACISCO(1) General Commands Manual PMDACISCO(1)
2
6 pmdacisco - Cisco router performance metrics domain agent (PMDA)
7
9 $PCP_PMDAS_DIR/cisco/pmdacisco [-d domain] [-l logfile] [-P password]
10 [-r refresh] [-U username] [-x port] host:interface-spec [...]
11 $PCP_PMDAS_DIR/cisco/parse [options] host:interface-spec [...]
12 $PCP_PMDAS_DIR/cisco/probe [-P password] [-U username] host
13
15 pmdacisco is a Performance Metrics Domain Agent (PMDA) which extracts
16 performance metrics from one or more Cisco routers.
17 A brief description of the pmdacisco command line options follows:
19 -d It is absolutely crucial that the performance metrics domain num‐
21 ber specified here is unique and consistent. That is, domain
22 should be different for every PMDA on the one host, and the same
23 domain number should be used for the same PMDA on all hosts.
24 -l Location of the log file. By default, a log file named cisco.log
26 is written in the current directory of pmcd(1) when pmdacisco is
27 started, i.e. $PCP_LOG_DIR/pmcd. If the log file cannot be cre‐
28 ated or is not writable, output is written to the standard error
29 instead.
30 -P By default, it is assumed that no user-level password is required
32 to access the Cisco's telnet port. If user-level passwords have
33 been enabled on the Ciscos, then those passwords must be specified
34 to pmdacisco. If specified with the -P option, password will be
35 used as the default user-level password for all Ciscos. See also
36 the INTERFACE IDENTIFICATION section below.
37 -r pmdacisco will refresh the current values for all performance met‐
39 rics by contacting each Cisco router once every refresh seconds.
40 The default refresh is 120 seconds.
41 -U By default, it is assumed that no username login is required to
43 access the Cisco's telnet port. If username login has been
44 enabled on the Ciscos, then the corresponding usernames must be
45 specified to pmdacisco. If specified with the -U option, username
46 will be used as the default username login for all Ciscos. See
47 also the INTERFACE IDENTIFICATION section below.
48 -x Connect to the Cisco via TCP port number port rather than the
50 default 23 for a telnet connection.
51 For each interface, once the telnet connection is established,
53 pmdacisco is willing to wait up to 5 seconds for the Cisco to provide a
54 new snapshot of the requested information. If this does not happen,
55 the telnet connection is broken and no values are returned. This pre‐
56 vents pmdacisco tying up the Cisco's telnet ports waiting indefinitely
57 when the response from the router is not what is expected, e.g. if the
58 format of the ``show int'' output changes, or the command is in error
59 because an interface is no longer configured on the router.
60
62 As each Cisco router can support multiple network interfaces and/or
63 multiple communications protocols, it is necessary to tell pmdacisco
64 which interfaces are to be monitored.
65 The host:interface-spec arguments on the command line define a particu‐
67 lar interface on a particular Cisco router. host should be a hostname
68 or a ``dot-notation'' IP address that identifies the telnet port of a
69 particular Cisco router. There are several components of the inter‐
70 face-spec as follows.
71 protocol
73 One of the abbreviations a, B, E, e, f, G, h, s or Vl respec‐
74 tively for ATM, BRI (ISDN), FastEthernet, Ethernet, FDDI, Giga‐
75 bitEthernet, HSSI, serial or Vlan.
76 interface
78 Depending on the model of the Cisco, this will either be an
79 integer, e.g. s0, or an integer followed by a slash (``/'') fol‐
80 lowed by a subinterface identification in one of a variety of
81 syntactic forms, e.g. e1/0, G0/0/1 or s4/2.1.
82 To discover the valid interfaces on a particular Cisco, connect to the
84 telnet port (using telnet(1)) and enter the command "show int" and look
85 for the interface identifiers following the keywords ``Ethernet'',
86 ``Fddi'', ``Serial'', etc.
87 Alternatively run the probe command.
89 password
91 If there is a user-level password, and it is different to the
92 default (see -P above), it may be optionally specified here by
93 appending a question mark (``?'') and the password to the end of
94 interface-spec.
95 username
97 If there is a username login, and it is different to the default
98 (see -U above), it may be optionally specified here by appending
99 ``@'' and the username to the end of interface-spec.
100 The following are examples of valid interface-spec arguments.
102 my-router:e1/2
103 123.456.789.0:s0
104 wancisco:f2/3?trust_me
105 cisco34.foo.bar.com:e2?way2cool
106 mycisco:s2/2.1@mylogin
107 yourcisco:E0/0?yourpassword@youlogin
108
110 The probe command may be used to discover the names of all interfaces
111 for a particular Cisco router identified by host. The -P argument is
112 the same as for pmdacisco.
113 The parse command takes exactly the same arguments as pmdacisco, but
115 executes outside the control of any pmcd(1) and so may be used to diag‐
116 nose problems with handling a particular Cisco router and/or one of its
117 interfaces. Additional diagnostic verbosity may be produced using the
118 -D appl0,appl1,appl2 command line option. Diagnostics are generated on
119 standard error as each sample is fetched and parsed.
120
122 If you want access to the names, help text and values for the Cisco
123 performance metrics, do the following as root:
124 # cd $PCP_PMDAS_DIR/cisco
126 # ./Install
127 If you want to undo the installation, do the following as root:
129 # cd $PCP_PMDAS_DIR/cisco
131 # ./Remove
132 pmdacisco is launched by pmcd(1) and should never be executed directly.
134 The Install and Remove scripts notify pmcd(1) when the agent is
135 installed or removed.
136
138 $PCP_PMCDCONF_PATH
139 command line options used to launch pmdacisco
140 $PCP_PMDAS_DIR/cisco/help
141 default help text file for the Cisco metrics
142 $PCP_PMDAS_DIR/cisco/Install
143 installation script for the pmdacisco agent
144 $PCP_PMDAS_DIR/cisco/Remove
145 undo installation script for the pmdacisco agent
146 $PCP_LOG_DIR/pmcd/cisco.log
147 default log file for error messages and other information
148 from pmdacisco
149
151 Environment variables with the prefix PCP_ are used to parameterize the
152 file and directory names used by PCP. On each installation, the file
153 /etc/pcp.conf contains the local values for these variables. The
154 $PCP_CONF variable may be used to specify an alternative configuration
155 file, as described in pcp.conf(4).
156
158 pmcd(1), pcp.conf(4) and pcp.env(4).
159Performance Co-Pilot SGI PMDACISCO(1)