Previous 7.5 Equipment templates Next

7.5.3 other

This section may appear more than once too. The parameters can be divided into three groups: a) condition parameters, b) exclude parameter and c) configuration parameters. The first one regulates the time when a measurement falls within the scope of a section; the second one regulates whether the measurement should be created or not and the third one controls the values the system should create the measurement with.

 

Condition parameters:

·       otype: This is the only mandatory parameter. Its value must be a measurement type code (see 7.2 Measurement definitions)

·       onumber: The sequence number of the measurement, a regular expression. If not specified, then it is disregarded. For Example: the sequence number cannot be bigger than 15: (.|1[0-5])

·       odescription: The description of the measurement which also appears during normal equipment creation. If not specified, then it is disregarded.

·       if_add_descr: PVSR can use the Cisco specific descriptions for naming the interfaces. If this option is not turned on (this is the default) then this parameter can be used to filter the measurements based on the Cisco specific description or on the ifAlias if those measurements are for interfaces (for example interface packets or traffic percentage)

·       interface_section: its value is either a number or I+number. In both cases it identifies an interface section and the measurement only matches this section if there was an interface with the same index which matched the indicated interface section. For example if we want to have traffic and packets/sec measurements for some interfaces then we have to create a new measurement type for the packets/sec and use this interface_section parameter to refer to the appropriate interface section

The system takes into account the condition set for the measurement along with the one set here.

 

Exclusion parameter

If a measurement matches the filter parameters then it is created with the configuration parameters mentioned below, unless the

exclude=1

line is present in the section. If it present then the measurement will not be created, so in this case the section acts as an exlusion mechanism. This can be used for example to exclude the interface traffic percentage measurement for the loopback interface.

 

Configuration parameters:

The content of the configuration section depends on whether the measurement type is discoverable or not. If it is discoverable then all of the configuration parameters are optional, since either the parameter is not needed for the data collection (like remark) or it has an appropriate default value (like retention) or PVSR can get discover its value (like description). However if it is not discoverable then the section must contain at least the name of the measurement (description parameter) and the index of the measurement (port parameter). The section in this case may contain other measurement specific user defined attributes, similarly to the “equipment” section, except the values must be fixed, i.e. the <input…> format cannot be used.

 

Since for discoverable measurements PVSR automatically detects the index of the measurement, the “port” parameter cannot even be used for discoverable measurements, meaning the if the section contains the “port” parameter then it is treated as non-discoverable, otherwise it is treated as discoverable measurement.

 

The available default parameters are the following, for the user defined parameters see section 7.5.6 Parameters of non-SNMP data collectors:

·       port: The parameter must not be used for discoverable measurements but is is mandatory for non-discoverable measurements and it will be used as the Index parameter for the measurement

·       description: The name of the created measurement. If the measurement is discoverable then the <description> field may be used here, which is automatically replaced by the system with the discovered measurement description and if it is not specified then it takes its value from the measurement type definition. If the measurement is non-discoverable then the parameter is mandatory and must not contain the <description> field

·       retention: If it’s specified, then not the value set for the equipment is used for the measurement but the one set here. Only a concrete numerical value may be given, not an <input> type

·       interval: If it’s specified, then not the value set for the equipment is used for the measurement but the one set here. Only a concrete numerical value may be given, not an <input> type

·       minimum: If it is specified in the section, and the system has found fewer number of instances (e.g. interface) than this amount during equipment creation, then it does not create the equipment and displays an error

·       switch: It corresponds to the Switched field in normal equipment creation, with value 1 for yes and 0 for no. By default it is 0

·       remark: The measurement remark of the field

·       peek_y: It corresponds to the Year field in normal equipment creation with value 1 for yes and 0 for no. By default it is 0

·       peek_m: It corresponds to the Month field in normal equipment creation with value 1 for yes and 0 for no. By default it is 0

·       peek_w: It corresponds to the Day field in normal equipment creation with value 1 for yes and 0 for no. By default it is 0

 

In case of non-SNMP data collector there is no possibility to specify an optional parameter. If such a parameter is specified at the data collector for the measurements, then it receives the default value for the measurement.

 

Example:

[other1]

#interface packets/sec

otype=IFP

#but only for the Uplink interfaces in the previous example

interface_section=I2

[other2]

onumber=.+

#mandatory and cannot be a regular expression

otype=CC

odescription=.+

#mandatory

description=<description> measurement

peek_y=1

peek_m=0

peek_w=1

remark=Remark

minimum=1

 

[other3]

onumber=.+

otype=CM

odescription=.+

description=<description> measurement

remark=No remark

peek_m=1

 

Example of non-discoverable measurements (Netflow traffic measurement):

[o1]

otype=#NB

description=HTTP and HTTPS traffic

port=http

NETFLOW M 1 SRC=:80_NEW_LINE_:443