The table below describes the tags that can be used in a components configuration file. The table shows which tags can be used in what components. I.e. it makes no sense to use the <yaxis> tag in an xml configuration file for the FC_RTTable component! Below the table you'll find the tag descriptions.
|<rtgraph> | <rtpie> | <rttable> | <rtmeter> | <rtset>|
|</rtgraph> | </trpie> | </rttable> | </rtmeter> | </rtset>|
Tag descriptions - The "GENERAL" block
The "general" block contains information about the appearance and behaviour of the component.
- Defines the component's window caption. The programtitle tag may contain any number of characters.
- Defines the title of the chart. The title is displayed just above the actual chart and may contain any number of characters.
- The fully qualified name of the xml configuration file to save the settings to when the user clicks the components "Save current settings" button. This can EITHER be the name of the xml file that was used to start the component OR a different name. The components "Save current settings" button will be disabled if the <savesettfile> tag has been left blank.
- When true, the components control panel is visible and the user can use the controls to customize the components appearance. If false, the panel is hidden, leaving more space for the actual chart.
- If true, the chart is in 3-dimensional mode.
- Sets the position of the charts legend. Allowed values are: "left", "right", "top" and "bottom".
- Defines the maximum string length (in number of characters) of the legend to display. Legend strings longer than the maximum are automatically truncated!
- Defines the text for the horizontal axis of the graph and may contain any number of characters.
- Defines the text for the vertical axis of the graph and may contain any number of characters.
- If true, the needle color changes according to the color of the zone the needle points to. In other words, the color of the needle depends on the actual meter value.
- If set to 0 (zero), the meter will automatically scale up with the maximum meter value. If > 0, the maximum meter value is fixed.
- Sets the number of decimals of the values displayed.
- The percentage of the scale reserved for the "low" zone.
- The percentage of the scale reserved for the "normal" zone. The rest of the scale is for the "high" zone. I.e. zone1=60,zone2=20 means: 0 <= zone1 < 60, 60 <= zone2 < 80, 80 <= zone3 <= 100.
- The color of the "low" zone. The color can be specified as in the <scolor></scolor> tag.
- The color of the "normal" zone. The color can be specified as in the <scolor></scolor> tag.
- The color of the "high" zone. The color can be specified as in the <scolor></scolor> tag.
- The meter's background color. The color can be specified as in the <scolor></scolor> tag.
- The color of all text, ticks and titles. The color can be specified as in the <scolor></scolor> tag.
- The color of the needle. The color can be specified as in the <scolor></scolor> tag. Can be overruled by the <dependentneedlecolor> tag.
- Controls how the needle moves to a new value. If true, the needle moves in 50 fps to a new value for a more professional look and feel at the cost of cpu cycles. If false, the needle jumps from value to value leaving the cpu nearly "untouched".
- The color of the needle axle. The color can be specified as in the <scolor></scolor> tag.
- Sets the angle of the meter in degrees (60 <= meterangle <= 320).
- Defines how many slices should be displayed in the Pie. If the actual number of slices is greater than <slices>, the last slice of the chart is used as "rest" or "other".
- Determines whether a separate legend should be displayed along the pie chart or that the slices of the pie should be labelled.
- If true, the width of each individual column in the table is determined by the width of the longest content in each column. If false, the width of each column is determined by the width of the column header.
- Sets the initial charttype. There are 4 types avaliable: "fastline", "line", "bar" and "area". The charttype can be modified at runtime.
- The barstyle tag lets you set the style of the bar. The bar style can also be set at runtime through the style selection control on the components control panel. There are 4 styles available: "rectangle", "cylinder", "arrow" and "gradient". The value of this tag has only effect if <charttype> = "bar".
- Defines how multiple "bars" are displayed on the graph. Available choices are: "behind", "side by side" and "stacked". The value of this tag has only effect if <charttype> = "bar".
- If more than 20 series are displayed in a graph, it could get somewhat difficult to read. If true, only the 20 most active series are displayed. If false, all available series are displayed.
- If true, a mark or label displaying the value is drawn near to each series point. If false, no marks or labels are drawn.
- If true, the y-axis is scaled automatically up/down according to the highest value displayed. If false, the y-axis is only scaled up (not down) indicating the highest value reached.
- If false, FC_RTSet does not allow empty values being send to the host. If true, FC_RTSet will send an empty string if no value has been specified which essentially overrides or wipes out an existing value!!
- Contains the fully qualified path and filename of the text file that contains the list of devices/remote hosts.
- Sets the initial left position of the component window at startup.
- Sets the initial top position of the component window at startup.
- Sets the initial width of the component window at startup. The window can be resized at runtime.
- Sets the initial height of the component window at startup. The window can be resized at runtime.
- Sets the IP address or DNS hostname of the device to connect to through snmp.
- Sets the community string to use in the SNMP requests (SNMP v1/v2).
- The port on the remote host on which the SNMP agent is listening. The default port is 161.
- The version of the snmp protocol to use. Possible values are 1 (SNMPv1), 2 (SNMPv2c) or 3 (SNMPv3). If left blank snmpV2 is taken by default.
- The username to use for SNMPv3 authentication.
- The password phrase used for SNMPv3 authentication. Password length should be at least 8 characters.
- Specifies the protocol to use for SNMPv3 authentication. Currently only "MD5" and "SHA" is supported.
- The password phrase used for SNMPv3 authentication. Password length should be at least 8 characters.
- Specifies the algorithm to use for SNMPv3 encryption. Valid algorithms are "DES", "AES" and "3DES".
- Sets the initial polling interval. The polling interval may range from 1 to 1000 seconds and can be modified at runtime through the "Polling. Int." control on the components control panel.
Tag descriptions - The <Shooter> block.
The <shooter> block contains the required data for building the actual snmp queries. It contains information about the SNMP version and port to use as well as the username and password in case of SNMPv3. The <shooter> block also "embeds" the <shootertargettable> block which, in turn, contains a repeating group of <shootertargetentry> blocks.
- If true, collected values are kept unmodified (as they are, raw). If set to "false", the difference between the values of the current sample and the previous one (delta) is calculated before continuing further processing. "True" is usually used for displaying utilization or percentage statistics. "False" for showing Bytes/sec, Frames/sec etc...
- If true, the y-axis of a graph component is scaled linearly, if false, the y-axis is scaled logarithmically.
- The <sortoid> tag can be used to specify whether the table should be sorted after each table update. If this tag is omitted or left blank, the table is left unsorted. The <sortoid> tag should be filled with an preceding "+" or "-", followed by the oid (without an instance) of the field or column to be used as the sort argument. A preceding "+" means, sort ascending. "-" of course means sort descending. <sortoid>+184.108.40.206.220.127.116.11.1.10</sortoid> sorts the rows of a table based on the value of the ifInOctets fields in ascending order.
Tag descriptions - The <Shootertargettable> block.
The <shootertargettable> block is the container for a so called repeating group of <shootertargetentry> blocks. The <Shootertargettable> block can contain one (or more) <Shootertargetentry> blocks. A number of rules apply to the OIDs specified in the targetentries:
- All OIDs specified in the <shootertargetentry> blocks used in the repeating group must have the same parent! In other words, all OIDs must belong to the same "mib branch". You cannot mix fields of different SNMP tables or branches. I.e. a Graph components that graphs information of the interfaces in a system can only contain OIDs from the mib-2 ifTable OR from the rmon etherStatsTable, not a mix of fields from both tables.
- Be aware of the type of an OID specified in a <shootertargetentry> block in relation to the component for which you're building the config file. I.e. It makes no sense to add a "string type" OID to a graph component!
- All "instance" fields specified in the <shootertargetentry> blocks from the repeating group must be of the same type. If you specify a "hard coded" instance like ".3" for the first <shootertargetentry> block, you must also specify "hard coded" instances for the rest of the <shootertargetentry> blocks in the repeating group. If you specify the "All Instances" or the "At runtime" keyword in the first <shootertargetentry> block, all other blocks must use the "all instances" keyword.
- The <oid> tag uniquely specifies the snmp field (without instance) from which to read its value. The instance is set in the <instance> tag specified separately. Valid oids have a format as in "18.104.22.168.22.214.171.124.1.2" or "126.96.36.199.188.8.131.52". (See rfc1213 for a detailed description of SNMP).
- Use the <instance> tag to specify the instance for the oid mentioned in the previous tag. There are three different options:
- A fixed dotted instance as in .7 or .123 (don't forget the preceding dot!).
- The keyword "at runtime". If the keyword "at runtime" is used, the user will be prompted to select an instance from a list of available instances at runtime. I.e. this option is useful if you want to have the option to zoom in on different ports of a switch or router (or whatever device) one at a time.
- The keyword "all instances". This option will i.e. display all occurrences of the specified oid in one graph. This option is useful if you want to graph the load of all ports of a switch or router in one single graph. Attention! The "all instances" keyword is not supported by FC_RTSet!
- If true, the retrieved target value is directly displayed in the component window. If false, the retrieved value is available for use in calculations etc but will not be displayed.
- A formula is a special form of a "Shooter Target". Normally the data provided by a target is the result of an snmp request operation. A formula provides data by performing a calculation on data provided by other targets. The <formula> tag specifies this calculation. The formula contains a number of fields separated by a comma. These fields are:
- a name for the result of the calculation
- the actual formula
- an enumeration of oids (targets) used in the formula
Valid formula strings are ie: "IO,(A+B)/$PI,A=184.108.40.206.220.127.116.11.1.10,B=18.104.22.168.22.214.171.124.1.16," or "Out,A*(0-1),A=126.96.36.199.188.8.131.52.1.16,". You can use the following mathematical operators in a formula: +, -, *, /. You can only use positive integers in a formula. If you need a negative integer, the following is wrong A*-1. Use A*(0-1) instead.
Tag descriptions - The <Oidtable> block.
The <oidtable> block contains information regarding the interpretation and formatting of snmp response values. The <oidtable> block is the container for a repeating group of <oidentry> blocks. The <oidtable> block can contain one (or more) <oidentry> blocks. By default, the components only have the information of the rfc1213 mib built-in. The <oidtable> block provides a way to easily extend this.
- See the description of the <oid> tag in the <shootertargettable> block.
- The <oiddescr> tag defines the name or description of the oid. It is recommended to keep it as short and clear as possible as it is often used in the charts legend!
- This tag specifies a formatting rule. A formatting rule consists of a keyword followed by a semicolon, sometimes followed by additional data (keyword dependent). Not all collected snmp values need special formatting. Most of the formatting is done automatically, without a special rule. The following special formatting rules are currently available:
- ipaddress: - Converts an octet string as defined in rfc1155 to a 4-byte dotted human readable IP address.
- timeticks: - Converts an integer value as defined in rfc1155 to a human readable time value.
- dateandtime: - Converts the DateAndTime structure as defined in SNMPv2-TC to a human readable date-and-time string.
- utc: - Converts a field value representing a UTC timestamp into a human readable date-and-time string.
- hex: - Converts an octet string to its hexadecimal equivalent.
- mapto: - Converts snmp enumeration integers to their textual equivalents. An example of this is the rfc1213 ifOperStatus field (mib-2.interfaces.ifTable.ifEntry.ifOperStatus). The tag value "mapto:1,up,2,down,3,testing," converts a retrieved snmp value of 2 to "2 (down)".
- The scolor tag can be used to set the series color in a graph. The scolor tag accepts two color formats: one of the predefined color strings from the list below or hexadecimal html color codes (#FF0066, #00FFAA Click here for a list)
- The type specification is used to validate user input and to determine to format of the snmp set-request. The following types are supported:
- The preset tag can be used to define a default value. This is very helpful when updating thousands of devices.
Tag descriptions - The <Vendorspecific> block.
The <vendorspecific> block of the xml file describes the tags vendors can use to integrate the Finnleys components into their own products.
- The fully qualified name of the file containing the vendors logo. This logo is shown in the about components "About" box. Without a vendor logo file, the default Finnleys logo is shown.
- The vendor can use this tag to specify the name of the vendors program or application that integrates the Finnleys components. The application name is shown in the components "About" box.
- The vendor can use this tag to specify the version of the vendors program or application. The version will be visible in the components "About" box.