PPT Configuration File

This chapter describes various parameters that can be configured according to the user requirements. The configuration file ppt.cfg is located at <ppt-install-dir>/etc directory.

The following table describes some of the parameters that can be modified.
Table 1. Configuration Parameters

Parameter Name

Description

Range

Default Value

Remarks

LOG_LEVEL

Level of the logging.

debug, info, warning, error or critical

Min = debug

Max = critical

Default = warning

The values are case sensitive.

Changing the value of LOG_LEVEL requires Apache, Scheduler, Monitor server and Notification server to be restarted.

MAX_LOG_FILE_SIZE

The size of each individual log file.

Min = 0

Max = 20 MB

Default = 10 MB

Setting this value to 0 will disable to log file rollover feature and a single log file of unlimited size will be created.

Changing the value of MAX_LOG_FILE_SIZE requires Apache, Scheduler, Monitor server and Notification server to be restarted.

LOG_FILE

The name of the log file.

NA

Default = <ppt-install-dir>/server/logs/ipcfpp.log_ipcfpp

Changing the value of LOG_FILE requires Apache, Monitor server and Notification server to be restarted.

TRACE_BACK_FILE

The name of the trace back file.

NA

Default = <ppt-install-dir>/server/logs/traceback_info.log

Changing the value of TRACE_BACK_FILE requires Apache, Scheduler, Monitor server and Notification server to be restarted.

NUMBER_LOG_FILES

If log file rotation is in place we need to specify the number of files we should rotate between.

Min = 1

Max = 10

Default = 10

If value of MAX_LOG_FILE_SIZE is set to 0 then, value of NUMBER_LOG_FILES is ignored and single file of unlimited size is created.

Changing the value of NUMBER_LOG_FILES requires Apache, Scheduler, Monitor server and Notification server to be restarted.

SCHEDULER_LOG_FILE

The file name of the scheduler log file.

NA

Default = <ppt-install-dir>/server/logs/scheduler.log_scheduler

Changing the value of SCHEDULER_LOG_FILE requires Scheduler to be restarted.

TCP_TIMEOUT

TCP timeout value for IPCF/SSC/PCEF reachability checking requests in seconds.

Min = 1

Max = 5

Default = 1

Changing the value of TCP_TIMEOUT requires Apache and Monitor server to be restarted.

KEEP_ALIVE_POLLING_INTERVAL

Polling interval for IPCF/SSC/PCEF keep alive requests in seconds.

Min = 5

Max = 60

Default = 30

Changing the value of KEEP_ALIVE_POLLING_INTERVAL requires Monitor server to be restarted.


Scheduler

The user can specify a variety of different expressions on each field, and when determining the next execution time, the scheduler finds the earliest possible time that satisfies the conditions in every field. This behavior resembles the Cron utility found in most UNIX like operating systems.

The following table lists all the available fields applicable in schedules.
Table 2. Available Fields in Schedules

Field

Description

Value Range

Default Value

HOUR

Hour field.

Min = 0

Max = 23

Default = 0

MINUTE

Minute field.

Min = 0

Max = 59

Default = 0


IMPORTANT:

The time format is HH:MM:SS. Changing the value of any field requires Scheduler to be restarted.

The following table lists all the available expressions applicable in schedules.
Table 3. Available Expressions in Schedules

Expression

Field

Description

*

any

Schedules are executed on every value.

a-b

any
Schedules are executed on any value within the a - b range.

IMPORTANT:

The value of a must be smaller than value of b.

a-b/c

any

Schedules are executed whenever value reaches c which is within a - b range.

x,y,z

any

Schedules are executed on any matching expression. It can combine any of the above expressions.



Here are some examples for the schedulers:
  • HOUR=0 MINUTE=0, the synchronization job will be executed everyday at 00:00:00 (This is default configuration).
  • HOUR=* MINUTE=20, then the synchronization job will be executed everyday at 20 minutes of every hour.
  • MINUTE=0-3, then the synchronization job will be executed everyday at 00:00:00, 00:01:00, 00:02:00 and 00:03:00.

Synchronization

It could happen that there are many state changes like manageable - unmanageable, unmanageable - manageable within a short time period. This state change can be due to network issues or they can be genuine state changes because of software malfunction on the IPCF/SSC/PCEF platform. To handle this scenario and to avoid repeated synchronization attempts because of this state change, synchronization will take place only if synchronization has not been done in recent past. This attribute defines the time period before which the synchronization should have taken place for state change trigger to be considered.

SHORT_TIME_PERIOD_BET_STATE_CHANGE_SYNC value is in seconds. The value range is given below:
  • Min = 0 (Disable)
  • Max = 86400 (1 day)
  • Default = 3600 (1 hour)

Changing the value of SHORT_TIME_PERIOD_BET_STATE_CHANGE_SYNC requires Monitor server to be restarted.

Postgres

This section contains attributes which are related to log files generated by PostgreSQL server. Log file rollover facility in PostgreSQL server is being used and new log file will be created when existing log file reaches a limit of 10 MB. The log files are generated in <ppt-install-dir>/3rdparty/postgres/pg_log directory and the log file name is of the format postgresql-%Y-%m-%d_%H%M%S.log where %Y, %m, %d, %H, %M, %S stand for year, month, day, hour, minute and seconds respectively. Log file location, name and size are configurable via PostgreSQL configuration file. PostgreSQL does not support cleanup of old log files, for this purpose a cleanup script is provided in PPT. This section allows user to configure the number of log files to be retained and the time at which cleanup script should be executed.

Setting the value of NUMBER_OF_LOG_FILES to 0 will disable cleanup of log files generated by PostgreSQL server. The value range is given below:
  • Min = 0
  • Max = 50
  • Default = 10
The user can configure the number of files to be retained after cleanup and the time at which the Postgres log file cleanup script is executed. The following table lists all the available fields applicable in schedules.
Table 4. Available Fields in Schedules

Field

Description

Value Range

Default Value

HOUR

Hour field.

Min = 0

Max = 23

Default = 1

MINUTE

Minute field.

Min = 0

Max = 59

Default = 0


IMPORTANT:

The time format is HH:MM:SS. Changing the value of any field requires Scheduler to be restarted.

The following table lists all the available expressions applicable in schedules.
Table 5. Available Expressions in Schedules

Expression

Field

Description

*

any

Schedules are executed on every value.

a-b

any
Schedules are executed on any value within the a - b range.

IMPORTANT:

The value of a must be smaller than value of b.

a-b/c

any

Schedules are executed whenever value reaches c which is within a - b range.

x,y,z

any

Schedules are executed on any matching expression. It can combine any of the above expressions.



Here are some examples for the schedulers:
  • HOUR=0 MINUTE=0, the cleanup script will be executed everyday at 00:00:00 (This is default configuration).
  • HOUR=* MINUTE=20, then the cleanup script will be executed everyday at 20 minutes of every hour.
  • MINUTE=0-3, then the cleanup script will be executed everyday at 00:00:00, 00:01:00, 00:02:00 and 00:03:00.

Cluster

This section contains the attributes being used by PPT in cluster mode. The value of HOST_IP is configured during PPT installation in cluster mode. In standalone mode, this value is ignored. HOST_IP is part of varbind information for traps generated by PPT application. The default host IP is 127.0.0.1.

Changing the value of HOST_IP requires Apache, Monitor server and Notification server to be restarted.