1PMDACISCO(1)                General Commands Manual               PMDACISCO(1)
2
3
4

NAME

6       pmdacisco - Cisco router performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/cisco/pmdacisco  [-d  domain] [-l logfile] [-U username]
10       [-P  password]  [-r  refresh]  [-s  prompt]  [-M  username]  [-x  port]
11       host:interface-spec [...]
12       $PCP_PMDAS_DIR/cisco/parse [options] host:interface-spec [...]
13       $PCP_PMDAS_DIR/cisco/probe  [-P password] [-s prompt] [-U username] [-x
14       port] host
15

DESCRIPTION

17       pmdacisco is a Performance Metrics Domain Agent (PMDA)  which  extracts
18       performance metrics from one or more Cisco routers.
19
20       A brief description of the pmdacisco command line options follows:
21
22       -d   It  is absolutely crucial that the performance metrics domain num‐
23            ber specified here is unique  and  consistent.   That  is,  domain
24            should  be  different for every PMDA on the one host, and the same
25            domain number should be used for the same PMDA on all hosts.
26
27       -l   Location of the log file.  By default, a log file named  cisco.log
28            is  written  in the current directory of pmcd(1) when pmdacisco is
29            started, i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be  cre‐
30            ated  or  is not writable, output is written to the standard error
31            instead.
32
33       -P   By default, it is assumed that no user-level password is  required
34            to  access  the Cisco's telnet port.  If user-level passwords have
35            been enabled on the Ciscos, then those passwords must be specified
36            to  pmdacisco.   If specified with the -P option, password will be
37            used as the default user-level password for all Ciscos.  See  also
38            the INTERFACE IDENTIFICATION section below.
39
40       -r   pmdacisco will refresh the current values for all performance met‐
41            rics by contacting each Cisco router once every  refresh  seconds.
42            The default refresh is 120 seconds.
43
44       -s   The Cisco command prompt ends with the string prompt.  The default
45            value is ``>''.  The only way pmdacisco can synchronize the  send‐
46            ing of commands and the parsing of output is by recognizing prompt
47            as a unique string that comes at the end of all  output,  i.e.  as
48            the command prompt when waiting for the next command.
49
50       -U   By  default,  it  is assumed that no username login is required to
51            access the Cisco's  telnet  port.   If  username  login  has  been
52            enabled  on  the  Ciscos, then the corresponding usernames must be
53            specified to pmdacisco.  If specified with the -U option, username
54            will  be  used  as the default username login for all Ciscos.  See
55            also the INTERFACE IDENTIFICATION section below.
56
57       -M   User account under which to run the agent.   The  default  is  the
58            unprivileged  "pcp"  account  in  current  versions of PCP, but in
59            older versions the superuser account ("root") was used by default.
60
61       -x   Connect to the Cisco via TCP port  number  port  rather  than  the
62            default 23 for a telnet connection.
63
64       For   each  interface,  once  the  telnet  connection  is  established,
65       pmdacisco is willing to wait up to 5 seconds for the Cisco to provide a
66       new  snapshot  of  the requested information.  If this does not happen,
67       the telnet connection is broken and no values are returned.  This  pre‐
68       vents  pmdacisco tying up the Cisco's telnet ports waiting indefinitely
69       when the response from the router is not what is expected, e.g. if  the
70       format  of  the ``show int'' output changes, or the command is in error
71       because an interface is no longer configured on the router.
72

INTERFACE IDENTIFICATION

74       As each Cisco router can support  multiple  network  interfaces  and/or
75       multiple  communications  protocols,  it is necessary to tell pmdacisco
76       which interfaces are to be monitored.
77
78       The host:interface-spec arguments on the command line define a particu‐
79       lar  interface on a particular Cisco router.  host should be a hostname
80       or a ``dot-notation'' IP address that identifies the telnet port  of  a
81       particular  Cisco  router.   There are several components of the inter‐
82       face-spec as follows.
83
84       protocol
85              One of the abbreviations a, B, E, e, f, G, h, s  or  Vl  respec‐
86              tively  for ATM, BRI (ISDN), FastEthernet, Ethernet, FDDI, Giga‐
87              bitEthernet, HSSI, serial or Vlan.
88
89       interface
90              Depending on the model of the Cisco,  this  will  either  be  an
91              integer, e.g. s0, or an integer followed by a slash (``/'') fol‐
92              lowed by a subinterface identification in one of  a  variety  of
93              syntactic forms, e.g. e1/0, G0/0/1 or s4/2.1.
94
95              To  discover the valid interfaces on a particular Cisco, connect
96              to the telnet port (using telnet(1)) and enter the command "show
97              int"  and  look for the interface identifiers following the key‐
98              words ``Ethernet'', ``Fddi'', ``Serial'', etc.
99
100              Alternatively run the probe command.
101
102       username
103              If there is a username login, and it is different to the default
104              (see -U above), it may be optionally specified here by appending
105              ``@'' and the username to the end of interface-spec.
106
107       password
108              If there is a user-level password, and it is  different  to  the
109              default  (see  -P above), it may be optionally specified here by
110              appending a question mark (``?'') and the password to the end of
111              interface-spec.
112
113       prompt If  the Cisco command prompt is different to the default (see -s
114              above), it may be optionally  specified  here  by  appending  an
115              exclamation mark (``!'') and the prompt to the end of interface-
116              spec.
117
118       The following are examples of valid interface-spec arguments.
119                 my-router:e1/2
120                 123.456.789.0:s0
121                 wancisco:f2/3?trust_me
122                 somecisco:G1/0!myprompt
123                 cisco34.foo.bar.com:e2?way2cool
124                 mycisco:s2/2.1@mylogin
125                 yourcisco:E0/0@yourlogin?yourpassword
126                 mycisco:E0/0@mylogin?mypassword!myprompt
127

HELPER UTILITIES

129       The probe command may be used to discover the names of  all  interfaces
130       for  a  particular Cisco router identified by host.  The -P argument is
131       the same as for pmdacisco.
132
133       The parse command takes exactly the same arguments  as  pmdacisco,  but
134       executes outside the control of any pmcd(1) and so may be used to diag‐
135       nose problems with handling a particular Cisco router and/or one of its
136       interfaces.
137
138       Additional   diagnostic   verbosity   may  be  produced  using  the  -D
139       appl0,appl1,appl2 command line option.  appl0 logs connect and  discon‐
140       nect  events,  login progress, high-level flow of control and extracted
141       statistics.  appl1 traces all commands sent to the Cisco device.  appl2
142       logs tokenizing and parsing of the output from the Cisco device.  Diag‐
143       nostics are generated on standard error as each sample is  fetched  and
144       parsed.
145

INSTALLATION

147       If  you  want  access  to the names, help text and values for the Cisco
148       performance metrics, do the following as root:
149
150            # cd $PCP_PMDAS_DIR/cisco
151            # ./Install
152
153       If you want to undo the installation, do the following as root:
154
155            # cd $PCP_PMDAS_DIR/cisco
156            # ./Remove
157
158       pmdacisco is launched by pmcd(1) and should never be executed directly.
159       The  Install  and  Remove  scripts  notify  pmcd(1)  when  the agent is
160       installed or removed.
161

FILES

163       $PCP_PMCDCONF_PATH
164                 command line options used to launch pmdacisco
165       $PCP_PMDAS_DIR/cisco/help
166                 default help text file for the Cisco metrics
167       $PCP_PMDAS_DIR/cisco/Install
168                 installation script for the pmdacisco agent
169       $PCP_PMDAS_DIR/cisco/Remove
170                 undo installation script for the pmdacisco agent
171       $PCP_LOG_DIR/pmcd/cisco.log
172                 default log file for error  messages  and  other  information
173                 from pmdacisco
174

PCP ENVIRONMENT

176       Environment variables with the prefix PCP_ are used to parameterize the
177       file and directory names used by PCP.  On each installation,  the  file
178       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
179       $PCP_CONF variable may be used to specify an alternative  configuration
180       file, as described in pcp.conf(5).
181

SEE ALSO

183       pmcd(1), pcp.conf(5) and pcp.env(5).
184
185
186
187Performance Co-Pilot                  PCP                         PMDACISCO(1)
Impressum