MRTG教程（二）：MRTG配置文件的生成工具cfgmaker（上）

MRTG配置文件的生成工具 cfgmaker

如何使用 cfgmaker 工具来创建你所需要的 mrtg 的配置文件。

 

内容

cfgmaker 的说明
配置
过滤器的详细介绍
预定义的过滤器名称
各种过滤器的例子
模板详细介绍
可写的模板变量
预定义的模板变量
主机和系统相关的变量
接口目标相关的变量
接口网络配置变量
接口名称／描述以及别名变量
模板的助手函数
模板文件的例子
Template Example 1: Eliminating Rejected Targets From Appearing
Template Example 2: Simplier Version of Example 1
Template Example 3: Creating CPU Targets for Hosts
实例

 

 

 

 

cfgmaker 的说明
cfgmaker 根据某个路由器或其他 SNMP 可管理设备获取的信息来创建 MRTG 的配置文件。 :

[community@]router


Coomunity 是你所创建配置文件的设别的 community 名称。如果没有指定，缺省为 'public' ； 如果你不知道某个设备的 community 名称，可以先试试这个设备。如果使用的 community 名称不正确，将无法从设备中获得任何响应信息。

路由器是 SNMP 可管理设备的 IP 地址或者是 DNS 域名。你可以为该名称用 : 分割来指定 6 项更多的选项。语法如下： :

router[:[prt][:[tmout][:[retr][:[backoff][:vers]]]]]


特别有意思的是最后一项参数， vers 。如果将该参数设置为 2 , 将通过 SNMP V2 来查询你的设备。它允许你提取设备中的 64 位的流量计数器，并且对于快速的接口来说能够更加有效（不会有计数器溢出情况的发生）。注意在命令行中的 router 出现的顺序与所生成的配置文件中的参数顺序一致。第一个指定的 router 其配置文件的配置信息行将首先被生成，其后的配置行是下一个 router 的，以此类推。

注意 cfg 配置文件的第一行会包含要来生成配置文件使用的所有命令行选项。这主要是为了然后在增加新主机或进行其他全局修改时，能够很容易地再次生成配置文件。

配置
除了 --output 和 --global 选项以外，其他所有的选项仅仅影响命令行中跟在其后的 router 。如果命令行中的某个选项在后面再次以其他值出现，新的值将覆盖旧的值并对后续的 router 起作用。这样选项可以为路由器组或者独立的路由器进行裁减。

参看 --output 和 --global 选项来了解其在命令行中何处出现、出现次数如何影响所生成的配置文件。

参看后面给出的例子来了解如何为多个路由器设置不同的选项。

--help 打印帮助信息并退出。
--man 打印手册信息并退出。
--version 打印 cfgmaker 的版本信息。 cfgmaker 的版本应当与所使用的 mrtg 的版本一致。

--ifref nr|ip|eth|descr|name
选择接口识别方式。缺省为 nr ，表示通过路由器编号来识别路由器的接口。不幸的是 SNMP 树中的接口编号是可以改变的。某些路由器会在增加新的接口后更改其编号，另一些更搞笑，他们会在每次月圆的的日子更改他们的编号。

为了搞定这样令人沮丧的问题， mrtg 能够通过其他 4 中属性来识别接口。这四种方式没有一种能够适用与所有的接口，不过你可以选一种适合你的方式。注意特别是某些路由器的所有接口卡都用相同的以太网地址，从而导致问题频出。

Select ip to identify the interface by its IP number. Use eth to use the ethernet address for identification. Use descr to use the Interface description. or use name to use the Interface name.

If your chosen method does not allow unique interface identification on the device you are querying, cfgmaker will tell you about it.

--ifdesc nr|ip|eth|descr|name|type|alias
Select what to use as the description of the interface. The description appears in the Title[] property for the target as well as the text header in the HTML code defined in the target's PageTop[]. Default is to use nr which is just the interface number which isn't always useful to the viewer of the graphs.

There are 6 other properties which could be used. Use ip if you want to use the interface's IP-address. Use eth if you want to use the interface's ethernet address. If you want a better description, you can use either descr, name or alias. Exactly what each of these do varies between different equipment so you might need to experiment. For instance, for a serial interface on a Cisco router running IOS using name might result in "S0" being the interface description , descr might result in "Serial0" and alias might result in "Link to HQ" (provided that is what is used as the interface's description in the router's configuration).

Finally, if you want to describe the interface by it's Btype (i.e "ethernetCSMA", "propPointtoPoint" etc) you can use type.

--if-filter 'filter-e­xpression'
First of all, this is under some developement and is experimental.

Use this if you want to have better control over what interfaces gets included into the configuration. The filter-e­xpression is evaluated as a piece of Perl code and is expected to return a truth value. If true, include the interface and if false, exclude the interface.

For a further discussion on how these filters work, see the section DETAILS ON FILTERS below.

--if-template 'template-file'
First of all, this is under some development and is experimental.

Use this if you want to control what the line for each target should look like in the configuration file. The contents of the file template-file will be evaluated as a Perl program which generates the lines using certain variables for input and output.

For a further discussion on how these templates work, see the section DETAILS ON TEMPLATES below.

--host-template 'template-file'
First of all, this is under some development and is experimental.

Use this if you want to have some extra targets related to the host itself such as CPU utilization, ping response time to the host, number of busy modems etc. The contents of the file template-file will be evaluated once per host as a Perl program which generates the lines using certain variables for input and output.

For a further discussion on how these templates work, see the section DETAILS ON TEMPLATES below.

--community 'community-string'
Use this to set the community for the routers following on the command line to community-string. Individual routers might overrride this community string by using the syntax community@router.
--enable-ipv6 This option enables IPv6 support. It requires the appropriate perl modules; if they are not found then IPv6 is disabled (see the ipv6 documentation).

cfgmaker will use IPv6 or IPv4 depending on the target. If the target is a numeric address, the protocol depends on the type of address. If the target is a hostname, cfgmaker will try to resolve the name first to an IPv6 address then to an IPv4 address.

IPv6 numeric addresses must be specified between square braces.

For example:

cfgmaker --enable-ipv6 [2001:760:4::1]:165:::2


If the target has both an IPv6 address and an IPv4 address with the same hostname, cfgmaker first queries the target using IPv6 and falls back to IPv4 if it fails. This is useful for targets which don't support SNMP over IPv6.

--use-16bit This option forces the use of 16bit SNMP request IDs. Some broken SNMP agents do not accept 32bit request IDs. Try to avoid this option as much as possible, complain to your agent vendor instead.

--snmp-options :[port][:[timeout][:[retries][:[backoff][:version]]]]
Use this to set the default SNMP options for all routers following on the command line. Individual values might be omitted as well as trailing colons. Note that routers might override individual (or all) values specified by --snmp-options by using the syntax

router[:[port][:[timeout][:[retries][:[backoff][:version]]]]]


--global bla: abc
Use this to add global options to the generated config file. You can call --global several times to add multiple options. The line will appear in the configuration just before the config for the next router appearing on the command line.

--global "workdir: /home/mrtg"
If you want some default Options you might want to put
--global "options[_]: growright,bits"
Specifying --global after the last router on the command line will create a line in the configuration file which will appear after all the routers.
--noreversedns Do not try to reverse lookup IP numbers ... a must for DNS free environments.
--no-down Normally cfgmaker will not include interfaces which are marked anything but administratively and operationally UP. With this switch you get them all.
--show-op-down Include interfaces which are operatively down.
--zero-speed speed
  Assign this speed in bits-per-second to all interfaces which return 0 for ifSpeed and ifHighSpeed. Some switches, notably Foundry equipment, return a speed of zero for some interfaces. For example, to have all interfaces reporting zero set to 100Mbps, use --zero-speed=100000000.
--subdirs format
  Give each router its own subdirectory for the HTML and graphics (or .rrd) files. The directory name is the given format string with a couple of pattern replacements. The string HOSTNAME will be replaced by the hostname of the router (however you specified it on the cfgmaker commandline -- it may be an actual hostname or just an IP address), and SNMPNAME will be replaced with the device's idea of its own name (the same name that appears on the right side of the Title lines). For instance, a call like:

cfgmaker --subdirs=HOSTNAME__SNMPNAME [email protected]


would result in the generation of lines looking something like:

Directory[10.10.0.18_1]: 10.10.0.18__fp2200-bothrip-1.3



--output file Write the output from cfgmaker into the file file. The default is to use STDOUT. --output is expected to appear only once on the command line. If used multiple times, the file specified by the last --output will be used.
--nointerfaces Don't generate configuration lines for interfaces.

This makes cfgmaker skip all steps related to interfaces which means it will not do any polling of the router to retrieve interface information which speeds up the execution of cfgmaker and it will neither run any interface templates.

--interfaces This makes cfgmaker generate configuration lines for interfaces (the default behaviour).

The main usage of this option is to negate an --nointerfaces appearing earlier on the command line.


过滤器的详细介绍
过滤器的目的是确定接受哪些接口，拒绝哪些接口。这是通过为每个接口执行其过滤器表达式，并根据执行结果来确定的，过滤器表达式是一小段 perl 代码。如果执行结果为 true , 则接受该接口，否则拒绝。

在使用过滤器时，要记住 perl 有自己的 true 和 false 的判断标准。 空串和 字符串 0 都是 false 。 整数值 0 以及其他任何未定义的值都是 false 。 任何应用都是 true.

由于过滤器是 perl 代码，以下 perl 表达式需要了解。 :

表达式可以用括号分组 () . 表达式可以用以下布尔操作符进行组合。

and (equivalent with && )
Boolean and of the two e­xpressions, is only true if both e­xpressions are true. Example: e­xpression1 and e­xpression2
or (equivalent with || )
Boolean or of the two e­xpressions, is true if either or both e­xpressions are true. Example: e­xpression1 or e­xpression2
not (equivalent with ! )
Boolean negation of a single e­xpression. Example: not e­xpression . Yet another example: !e­xpression
(For more details on this I recommend a book on Perl)

预定义的过滤器名称
为了方便起见，在过滤器中有许多预定义的变量。注意这些变量在接口模板中同样可用。 ( 不是主模板）

Caveat: All these variables' names begin with a dollar sign ($), which is a syntactic requirement for scalar variables in Perl. The danger here is that the dollar sign in many shells is an active character (often used for shell variables exactly as in Perl variables) so it is important to ensure that the Perl e­xpression isn't evaluated by the command line shell as shell code before being passed to cfgmaker as command line arguments. In shells like Bourne shell, ksh shell or bash shell, placing the entire e­xpression within single qoutes will avoid such accidental evaluation:

--if-filter=($default_iftype && $if_admin)


$if_type
This is an integer specifying the interface type as per the SNMP standards and as reported by the polled device. A complete list of interface types would be impractical for this document , but there are a number predefined varables below. Normally, cfgmaker puts in the target's PageTop this iftype value within paranthesis after the name of the interface type. (e.g propPointToPointSerial (22) ).

Here's a list of some of the most common interface types by number:

  6 ethernetCsmacd

  7 iso88023Csmacd

  9 iso88025TokenRing

15 fddi

19 E1

20 basicISDN

21 primaryISDN

22 propPointToPointSerial

23 ppp

24 softwareLoopback

30 ds3

32 frame-relay

33 rs232

37 atm

39 sonet

44 frameRelayService

46 hssi

49 aal5

53 propVirtual

62 Fast Ethernet (100BaseT)

63 ISDN & X.25

69 Full Duplex Fast Ethernet (100BaseFX)

94 Asymetric Digital Subscriber Loop (ADSL)

117 Gigabit Ethernet

134 ATM Sub Interface



=item B<$default>


True if and only if cfgmaker normally should accepted the interface based on the interfaces administrative and operational state (taking the flags --no-down and --show-op-down into account) and it's type (and a few other things).

$default_ifstate
True if and only if cfgmaker would have accepted the interface based on it's operational and administrative states (also taking into account the presence of the flags --no-down and --show-op-down).
$default_iftype
True if and only if cfgmaker would have accepted the interface based on it's type (and a few type specific details in addition).
$if_admin
True if and only if the interface is in an adminstrative up state.
$if_oper
True if and only if the interface is in an operational up state.
A number of variables are also predefined to easily decide if an interface belong to a certain cathegory or not. Below is all those variables listed together with which if_type numbers each variable will be true for. Note that some variables refer to other variables as well.

$if_is_ethernet
True for ethernet interfaces (nr 6, 7, 26, 62, 69 and 117).
$if_is_isdn
True for various ISDN interface types (nr 20, 21, 63, 75, 76 and 77)
$if_is_dialup
True for dial-up interfaces such as PPP as well as ISDN. (nr 23, 81, 82 and 108 in addition to the numbers of $if_is_isdn).
$if_is_atm
True for miscellaneous ATM related interface types (nr 37, 49, 107, 105, 106, 114 and 134).
$if_is_wan
True for WAN interfaces point to point, Frame Relay and High Speed Serial ( 22,32,44,46)
$if_is_lan
True for LAN interfaces (8, 9, 11, 15, 26, 55, 59, 60 and 115 in addition to the numbers of $if_is_ethernet).
$if_is_dsl
True for ADSL, RDSL, HDSL and SDSL (nr 94, 95, 96, 97)
$if_is_loopback
True for software loopback interfaces (nr 24)
$if_is_ciscovlan
True for Cisco VLAN interfaces (interfaces with the word Vlan or VLAN in their ifdescs)
$if_vlan_id
Returns the vlan id associated with a specific port on Cisco Catalyst switches under both Catalyst OS and IOS. If it is not a vlan interface, will return undef.
$if_MTU
Returns the Maximum Transfer Unit associated with a specific port.
Besides that, you can also use the variables defined for templates below. Further, all the variables available in cfgmaker is at the scripts disposal even if the use of such features is discouraged. More shortcuts in the form of variables and functions will be made avaiable in the future instead.
各种过滤器的例子
The following filter will not affect which interfaces get's included or excluded, it will make cfgmaker behave as normally.

'--if-filter=$default'


The following filter will make cfgmaker exclude PPP (23) interfaces:

'--if-filter=$default && $if_type!=23'


The following filter will make cfgmaker behave as usual except that it will consider the operational state of an interface irrelevant but still reject all interfaces which are administratively down.:

'--if-filter=$if_admin && $default_iftype'


模板详细介绍
The contents of the template files are evaluated as a Perl program. A number or Perl variables are available for the program to read and others are used to be written to.

As quite a few of the predefined variables has values which are are supposed to be used in HTML code some of them have an HTML-escaped`variant, e.g $html_syslocation is the HTML escaped variant of $syslocation. The HTML escaping means that the chars `< , > and & are replaced by < , > and & and that newlines embedded in the string are prepended with <BR> and appended with a space character (if a newline is last in the string it is not touched).

可写的模板变量
These are the variables available to store the configuration lines in. Some of them are initialized prior to the evaluation of the template but such content normally is comments for inclusion in the final configuration file so those variables might be reset to the empty string in the template code to eliminate the comments. The other way around is also possible, the contents of these variables might be extended with further information for various reasons such as debugging etc.

Once the template has been evaluated, the following happens: if the template is a interface template and the actual interface for some reason is rejected and thus needs to be commented out, all the lines in the variable $target_lines are turned into comments by adding a hash mark ( # ) at their beginning. Then all the variables $head_lines, $problem_lines , $target_lines and $separator_lines are concatenated together to form the lines to add to the configuration file.

$target_lines
This variable is the placeholder for the configuration lines created by the template. $target_lines is predefined to be empty when the template code is evaluated.
$head_lines
This variable is intended to be the placeholder for the comment line appearing just before the target in the configuration file. It is initialized with that comment line before the evaluation of the template code and if the template doesn't modify $head_lines during evaluation, the comment will look like usual in the config file.
$problem_lines
This variable is intended to be the placholder for the comment lines describing any problems which might have been encountered when trying to add the target into the configuration. For host templates it's normally not used and for those it's predefined as the empty string. For interface templates $problem_lines is predefined with the error description comments which cfgmaker normally would use for rejected interfaces or as the empty string for accepted interfaces.

It is possible to test against $problem_lines to find out if an interface will be included or rejected but this is not recommended. Test against $if_ok instead.

$separator_lines
This variable is the placeholder for the string to use as the separator between the code for individual targets. The contents of this variable is put after each target (so the lines will appear after the end of the last target in the config as well).
预定义的模板变量
All the variables below are available for interface templates to use. For host templates, only those listed under Host and System Variables are available.

For interface templates the variables listed under Predefined Filter Variables are also available.

主机和系统相关的变量
$router_name
This is the fully qualified name for the router. It is affected by the following items on the command line: the router name itself and --dns-domain.
$router_connect
This is the reference string for the router being polled. It is on the form community@router possibly followed by some snmp options. It is affected by the following items on the command line: the router name itself, --community, --snmp-options and --dns-domain. (There's no HTML escaped variant available)
$directory_name
This variable should contain the directory name as cfgmaker normally would use as the value for the Directory[] directive. The value is determined by the --subdirs command line option. If --subdirs isn't specified $directory_name will be the empty string. (There's no HTML escaped variant available)
$syscontact
This variable is the router's SNMP sysContact value. (HTML escaped variant: $html_syscontact)
$sysname
This variable is the router's SNMP sysName value. (No HTML escaped variant available)
$syslocation
This variable is the router's SNMP sysLocation value. (HTML escaped variant: $html_syslocation)
$sysdescr
This variable is the router's SNMP sysDescr value. It is normally not used by cfgmaker but might be useful in a template. (HTML escaped variant: $html_sysdescr)
接口目标相关的变量
$target_name
This is what cfgmaker normally would use as the the name of the target. The target name is what is found within the square brackets, [] , for target directives. (There's no HTML escaped variant available)
$if_ref
This the reference string for the interface. It is expected to be used in the Target[xyz] directive to distinguish what interface to use. The value of this variable is affected by the --ifref command line option. It is normally used together with $router_connect. (There's no HTML escaped variant available)
$if_ok
This variable is true if the interface is going to be included into the configuration file, otherwise false. Don't test against other variables such as $problem_lines to find out if an interface will be rejected or not, use this $if_ok instead.
$default_target_lines
This variable contains all the target lines which cfgmaker by default outputs for this interface. It's useful if you want to have the standard target but want to add some extra lines to it by using a template.
By default cfgmaker uses the following directives for each target it generates: Target[], SetEnv[], MaxBytes[], Title[], PageTop[] and if there is any directory specified also the Directory[] directive.

To facilitate the creation of templates which generates target configs which are similar to the default one, each of the above mentioned directive lines have a corresponding variable containing the line as cfgmaker would have output it by default.

Note that none of these have a HTML escaped variant, text in them is HTML escaped where needed. Also note that they do not have any newline at the end.

$default_target_directive
This variable contains the default string for the Target[] directive line.
$default_setenv_directive
This variable contains the default string for the SetEnv[] directive line.
$default_directory_directive
This variable contains the default string for the Directory[] directive line which means it is an empty string (with no newline) if there's no directory.
$default_maxbytes_directive
This variable contains the default string for the MaxBytes[] directive line.
$default_title_directive
This variable contains the default string for the Title[] directive line.
$default_pagetop_directive
This variable contains the default string for the PageTop[] directive lines.
接口网络配置变量
$if_ip
This variable should contain the IP-address of the interface, if any has been assigned to it. (There's no HTML escaped variant available)
$ifindex
This variable is the SNMP ifIndex for the interface which per definition always is an integer. (There's no HTML escaped variant available)
$if_index
Equivalent with $ifindex.
$if_eth
Contains the ethernet address of the interface, if any. (There's no HTML escaped variant available)
$if_speed
This variable is the speed in bytes/second (with prefixes). (There's no HTML escaped variant available)
$if_speed_str
This variable is a cooked speed description which is either in bits or bytes depending on wether or not the bits option is active and also with the proper prefix for the speed (k, M, G etc). (No HTML escaped variant available)
$if_type_desc
This variable is a textual description of the interface type. (HTML escaped variant: $html_if_type_desc)
$if_type_num
This variable the integer value corresponding to the interface type (for a listing for the value for the more common interface types, see the section DETAILS ON FILTERS above). (No HTML escaped variant available)
$if_dns_name
This is the DNS name for the interface. (No HTML escaped variant available)
接口名称／描述以及别名变量
It might seem confusing with both Name, Description and Alias in this context and to some extent it is. Name and Description are usually supported on most equipment but how they are used varies, both between manufacturers as well as between different cathegories of equipment from the same manufacturer. The Alias is at least supported by Cisco IOS, and that variable contains whatever is used in the IOS statement called description for the interface (not to be confused with the SNMP variables for Description).

For better control from the command line consider $if_title_desc which contents are controlled by the --if-descr command line option.

$if_snmp_descr
This variable should contain the raw description of the interface as determined by the SNMP polling of the router. (HTML escaped variant: $html_if_snmp_descr)
$if_snmp_name
The raw name for the interface as provided by SNMP polling. (HTML escaped variant: $html_if_snmp_name)
$if_snmp_alias
The raw ifAlias for the interface as provided by SNMP polling. (HTML escaped variant: $html_if_snmp_alias)
$if_cisco_descr
The raw CiscolocIfDescr for the interface as provided by SNMP polling. (HTML escaped variant: $html_if_cisco_descr)
$if_description
This is the cooked description string for the interface, taking into account the SNMP values found for the interface's RDescr, ifAlias and CiscolocIfDescr. (HTML escaped variant: $html_if_description)
$if_title
The full string cfgmaker by default would have used for the Title[] directive in the configuration as well as the content of the topmost H1 tag in the PageTop[]. Is composed by the contents of $desc_prefix, $if_title_desc and $sysname.

As $if_title depends on $if_title_desc, it is possible to indirectly control $if_title by using the command line option --if-descr.:

(HTML escaped variant: $html_if_title)


$if_port_name
If the host is a Cisco Catalyst LAN switch, this variable is the name of that port. (No HTML escaped variant available)
$desc_prefix
This variable is a prefix of the description of what the target is to use in the Title[] directive and in the H1 section of the PageTop[] . Default is Traffic analysis for . (HTML escaped variant: $html_desc_prefix)
$if_title_desc
This is the description of the interface normally used by cfgmaker as part of the variable $if_title. The latter is used as the full string in the Title[] directove and the H1 section in the PageTop[].

$if_title_desc is controlled by the command line option --if-descr which indirectly controls the contents of $if_title:

(HTML escaped variant: $html_if_title_desc


模板的助手函数
The following functions exists to facilitate the writing of host and interface templates.

html_escape(string)
html_escape() takes a string as an argument and returns a new string where the following substitutions has been done: the chars <`, > and & are replaced by < , > and & and that newlines embedded in the string are prepended with <BR> and appended with a space character (newlines at the end of the string are not touched).