Chapter 15. Advanced topics

Table of Contents

15.1. Custom configuration
15.1.1. Client custom configuration settings
15.1.2. Server custom configuration settings
15.2. Integrating sFlowTrend-Pro with other applications
15.2.1. How integration works
15.2.2. Default URLs available
15.2.3. Creating custom URLs
15.2.3.1. Custom URL example

This section contains information on advanced topics, which many users will not be concerned about.

15.1. Custom configuration

Some custom configuration is possible through the use of the sFlowTrend-Pro properties file. Modifying this is only recommended for advanced users. The file must be editing using a standard text editor, and sFlowTrend-Pro must be restarted before any of the changes will take effect.

If running sFlowTrend-Pro as a service, then both the client and the server have their own property files. Care must be taken to modify the appropriate one, depending on the desired outcome. The correct file to modify is indicated against each property, below. If the server property file needs to be modified, then this will affect all users using the server. The service must be restarted for the changes to take effect. If the client property file is modified, then this will only affect that client. In this case, the client must be closed and re-opened before the change will take effect.

The properties file is called config.prp, and it is located in the sFlowTrend-Pro home directory (which can be identified and changed through the sFlowTrend-Pro ToolsOptions menu selection). If you are running sFlowTrend-Pro as a service, then take care to locate the correct client home directory, on the local system (the first shown via the Options menu), or the server home directory, on the remote server system (the second shown).

If the config.prp file does not exist in the directory, then it must first be created. The file is organised as a series of lines, where each line is of the form:

propertyName = value
            

For example,

chart.topn = 8
            

would change the number of entries in a top-n to 8. Note that all properties and values must be entered exactly as specified. Some of the properties that can be modified using the properties file are:

15.1.1. Client custom configuration settings

The settings in this section apply to the client. If you are running sFlowTrend-Pro as an application, then the client and server share the configuration file. If you are running as a service, then the file should be modified on the client only.

chart.font, chart.legend.font, chart.title.font, chart.subtitle.font
These settings control the fonts used for the charts displayed in the Charts tab. The format for these settings is one of:
fontname-style-pointsize
fontname-pointsize
fontname-style
fontname
                        
where style is case insensitive "PLAIN", "BOLD", "BOLDITALIC", or "ITALIC"; for example Arial-BOLD-11.
chart.topn
Controls how many entries are displayed in each top-n chart (ie the value of n). The default value is 5.
circles.font, circles.legend.font, circles.title.font, circles.subtitle.font
These settings control the fonts used for the Circles charts. The format for these settings is one of:
fontname-style-pointsize
fontname-pointsize
fontname-style
fontname
                         
where style is case insensitive "PLAIN", "BOLD", "BOLDITALIC", or "ITALIC"; for example Arial-BOLD-11.
circles.maxFlows
Controls the number of flows displayed in the Circles charts. The default value is 100.
client.serverPort
This setting controls the TCP port used by the client to connect to the server. It must match the server.webserver.port of the server you are connecting to (unless the port is changed in the connect dialog of the client - for more information, see Section 12.3, “Connecting to a server”). The default is 8087.
client.webserver.enable
Set this to the value false to stop the client (when running both as an application or as a service) web server being started when sFlowTrend-Pro runs. Disabling the web server also disables the ability to integrate sFlowTrend-Pro with other applications.
client.webserver.port
The TCP port that the client web server will listen on. This default value is 8086.
client.webserver.localonly
By default, this setting is true, which means that the client web server only responds to localhost. It is a good idea to restrict the web server like this to avoid any security issues. However, if you desire any host to be able to access the web server, then set this to false.

15.1.2. Server custom configuration settings

The settings in this section apply to the server. If you are running sFlowTrend-Pro as an application, then the client and server share the configuration file. If you are running as a service, then the file should be modified on the server only.

database.hoursPersistent
Controls how many hours of data will be stored in the database, before being flushed. This number can be reduced from the default of 168 (1 week), if the database is getting too large.
sflowtrend.autoEnable
The default value for this setting is true. In this case, sFlowTrend-Pro will automatically enable and start collecting data from the first n switches that it receives unsolicited (command line configured) sFlow from, where n is the maximum number of switches allowed by the software license. To control manually which switches are enabled, set this value to false.
sflowtrend.samplingRate.[ifSpeed.]medium

If sFlowTrend-Pro is using SNMP to configure the switches to send sFlow, sFlowTrend-Pro will use this value to configure the sampling rate for all interfaces of the given ifSpeed. The default values are:

sflowtrend.samplingRate.medium = 512
sflowtrend.samplingRate.10.medium = 128
sflowtrend.samplingRate.100.medium = 256
sflowtrend.samplingRate.1000.medium = 512
sflowtrend.samplingRate.10000.medium = 1024
                            

For example

sflowtrend.samplingRate.100.medium = 256
                            

tells sFlowTrend-Pro to configure all interfaces with an ifSpeed of 100 Mb/s with a sampling rate of 1 in 256. The value for sflowtrend.samplingRate.medium is used by sFlowTrend-Pro when configuring an interface with an ifSpeed for which a sampling rate has not been specified. For example, with the default sampling rate settings, a 4 Gb/s trunk would be configured with a sampling rate of 1 in 512.

You can specify sampling rates for other ifSpeeds. For example

sflowtrend.samplingRate.8000.medium = 1024
                            

tells sFlowTrend-Pro to configure all interfaces, with an ifSpeed of 8 Gb/s, with a sampling rate of 1 in 1024.

sflowtrend.useForce
The default value for this setting is false. In this case, if sFlowTrend-Pro is using SNMP to configure the switches to send sFlow, and finds that a switch has already been configured by another application and there are no unclaimed receiver entries on the switch, then sFlowTrend-Pro will not configure the switch. In this case sFlowTrend-Pro will show the switch status as Already in use. If the value for this setting is true and there are no unclaimed receiver entries on the switch, then sFlowTrend-Pro will overwrite the first receiver entry forcibly claim it.
server.webserver.port
The TCP port that the server web server will listen on. This default value is 8087. If this is changed, then a client connecting to the server would also need to change to the same value (see client.serverPort).
server.webserver.localonly
By default, this setting is false, which means that the server web server can respond to requests from any client. If you want to disallow clients other than the system that is running the server from connecting to the server, then set this property to true.