Page History

Add_workflow_for_techpubs

AUTH1	UserResourceIdentifier{userKey=8a00a0c880e94aad0181077fa2530009, userName='null'}
JIRAIDAUTH	SBX-127221
REV5	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cb8305e9, userName='null'}
REV6	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cd5909df, userName='null'}
REV3	UserResourceIdentifier{userKey=8a00a0c863c32a720163c47764100001, userName='null'}
REV1	UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cb1f0553, userName='null'}

Panel

In this section:

Table of Contents

maxLevel	2

Info

icon	false

Overview

Multiexcerpt

MultiExcerptName	Event Log Mapping

Use the Event Log object to create, configure, disable and enable system and subsystem level log files to capture system, security, debug, packet, trace and accounting events.

Event Types

Event	Facility
System	16	local0
Debug	17	local1
Trace	18	local2
Security	19	local3
Audit	20	local4
Accounting	22	local6
Platform Audit Logs	23	local7
Console log		lpr
SFTP log		ftp
Kern Log		kern
User Log		user
Daemon Log		daemon
Auth Log		auth, authpriv
Syslog Log		news
NTP Log		uucp
Cron Log		cron
FIPS Log		local5

Include Page

	_FIPS_Releases
	_FIPS_Releases

For each event type, an event class (subsystem) and severity threshold can be configured. Event classes include:

Audit
Call processing
Directory services
Network management
Policy
Resource management
Network routing
Platform Rsyslog
Security
Signaling
System management
Call trace

The ROLLFILE facility provides a means of closing the active log file and opening a new one with an incremented (name) suffix. This facilitates real-time analysis of system events by allowing the analysis on closed, rather than opened and growing, files.

For more information on SBC's support for remote syslog servers and the supported log types, refer to Supported Log Types.

The Event Log object allows you to create event log filters to capture debug, security, system, trace, and accounting events using following parameters:

Filter Admin – Filter configuration for each event log type and event class
Filter Status – View filter status per each event log type and event class (using the request command)
INFO Level Logging Enable – Re-enable INFO level logging if it becomes disabled due to system congestion
Memory Usage – Measure memory usage of each process
Platform Audit Logs – View platform audit logs of administrative, privileged, and security actions
Platform Rsyslog – Method of sending event messages to a syslog server.
Subsystem Admin – Filter configuration for each subsystem
Type Admin – Event log for configuration items related to each event log type

Include Page

	_Netconf_security_protection
	_Netconf_security_protection

Multiexcerpt include

MultiExcerptName	UniqueHomeDirectory_6.0
PageWithExcerpt	ALLDOC:SBC Core Groups and Passwords

Anchor
FilterAdmin
FilterAdmin
Filter Admin

Multiexcerpt include

MultiExcerptName	Debug_Event_Log_Overview
PageWithExcerpt	Troubleshooting SBC Using Debug Event Logs

Command Syntax

Code Block

language	none

% set oam eventLog filterAdmin <node name>
	<event_type: audit | debug | memusage | security | system | trace>
	<event_class: audit | callproc | directory | netmgmt | policy |  resmgmt | routing | security | signaling | sysmgmt | trace>
	level <info | major | minor | noevents>
	state <off | on>

Command Parameters

Multiexcerpt

MultiExcerptName	filterAdmin

Filter Admin Event Log Parameters

Parameter	Description
`filterAdmin`	Event Log Class Filter configuration table.
`<node name>`	SBC node name.
`<event type>`	The type of event log to configure: `audit` – System audit data. These files contain a record of all management interactions that modify the state of the system, and includes all the changes made via the CLI and the Netconf interface. These files use .AUD extensions. `debug` – System debugging data. These files have .DBG extensions. `memusage` – Process heap memory usage data. These files have .MEM extensions. `security` – Security level events. These files have .SEC extensions. `system` – System level events. These files have .SYS extensions. `trace` – System trace data. These files have .TRC extensions.
`<event class>`	For each event type, configure one of the following event: `audit` – Audit subsystem. `callproc` – Call Processing subsystem. `directory` – Directory Services subsystem. `netmgmt` – Network Management subsystem. `policy` – Policy subsystem. `resmgmt` – Resource Management subsystem. `routing` – Network Routing subsystem. `security` – Security subsystem. `signaling` – Signaling subsystem. `sysmgmt` – System Management subsystem. `trace` – Call Trace subsystem.
`level`	Minimum severity level threshold for event logging: `critical` – log only critical events. `info` – log all events. `major` – log major and critical events. `minor` – log all events other than info. `noevents` – do not log any events. Note: Info level logs which are traps or faults are always reported in the system logs.
`state`	Administrative state of event logging for this event type. Set to “on” if filter entry should take precedence over per-node settings. `off` (default) – Logging is not activated. `on` – Logging is activated.

Anchor
FilterStatus
FilterStatus
Filter Status

Command Syntax

Code Block

language	none

% request oam eventLog filterStatus <node name>
   <event_type: audit | debug | memusage | security | system | trace>
   <event_class: audit | callproc | directory | netmgmt | policy |  resmgmt | routing | security | signaling | sysmgmt | trace>
   resetStats

Command Parameters

Multiexcerpt

MultiExcerptName	filterStatus

Filter Status Event Log Parameters

Parameter	Description
`filterStatus`	Event log class filter status table.
`<system name>`	SBC system name.
`<event type>`	The type of event log: `audit` – System audit data. These files contain a record of all management interactions that modify the state of the system, and includes all the changes made via the CLI and the Netconf interface. These files use .AUD extensions. `debug` – System debugging data. These files have .DBG extensions. `memusage` – Process heap memory usage data. These files have .MEM extensions. `security` – Security level events. These files have .SEC extensions. `system` – System level events. These files have .SYS extensions. `trace` – System trace data. These files have .TRC extensions.
`<event class>`	Event class for each event type: `audit` – Audit subsystem. `callproc` – Call Processing subsystem. `directory` – Directory Services subsystem. `netmgmt` – Network Management subsystem. `policy` – Policy subsystem. `resmgmt` – Resource Management subsystem. `routing` – Network Routing subsystem. `security` – Security subsystem. `signaling` – Signaling subsystem. `sysmgmt` – System Management subsystem. `trace` – Call Trace subsystem.
`resetStats`	Use this control to reset the value of Events Filtered column of the `filterStatus` display.

Anchor
InfoLevelLoggingEnable
InfoLevelLoggingEnable
INFO Level Logging Enable

The active and standby SBC are designed to turn off INFO level logging if the system becomes congested. The "request oam eventLog infoLevelLoggingEnable clearInfoLevelLoggingDisabled" command is used to re-enable INFO level logging once it is disabled. See sonusCpEventLogInfoLevelLoggingDisabledNotfication - MAJOR for associated trap details.

To view INFO LEVEL LOGGING DISABLED state, run the following command.

Code Block

language	none
title	'show table oam eventLog typeStatus' Example

> show table oam eventLog typeStatus
                                                                                                                    INFO
                                               TOTAL                                                                LEVEL
          CURRENT      FILE     FILE    TOTAL  FILE      FILES    NEXT      LOG                                     LOGGING
TYPE      FILE         RECORDS  BYTES   FILES  BYTES     DROPPED  ROLLOVER  DESTINATION  LAST FILE DROP             DISABLED
------------------------------------------------------------------------------------------------------------------------------
system    1000005.SYS  216      31756   32     1032744   0        0         localDisk    0000-00-00T00:00:00+00:00  false
debug     1000014.DBG  1601     188964  32     27489838  0        0         localDisk    0000-00-00T00:00:00+00:00  false
trace     1000005.TRC  0        128     32     5224      0        0         localDisk    0000-00-00T00:00:00+00:00  false
acct      1000085.ACT  1        202     32     7592      0        0         localDisk    0000-00-00T00:00:00+00:00  false
security  1000005.SEC  7        1047    32     23610     0        0         localDisk    0000-00-00T00:00:00+00:00  false
audit     1000005.AUD  1002     186238  32     4267027   0        0         localDisk    0000-00-00T00:00:00+00:00  false
packet    1000005.PKT  0        128     32     872       0        0         localDisk    0000-00-00T00:00:00+00:00  false

Command Syntax

Code Block

language	none

% request oam eventLog infoLevelLoggingEnable clearInfoLevelLoggingDisabled

Command Parameter

Multiexcerpt

MultiExcerptName	infoLevelLoggingEnable

Info Level Logging Enable Event Log Parameter

Parameter

Description

clearInfoLevelLoggingDisabled

Use this command to re-enable info level logging after it becomes disabled due to system congestion. If this command is executed while the system is still congested, this may cause the system to become further congested.

Note: Only issue this command once system congestion dissipates.

Anchor
MemUsage
MemUsage
Memory Usage

Multiexcerpt include

MultiExcerptName	Memory Usage
PageWithExcerpt	Resource Monitoring and Statistics

Command Syntax

Code Block
% set oam eventLog process memusage state <enable \| disable> level <summary \| detailed> interval <0...140>

Command Parameters

Multiexcerpt

MultiExcerptName	MemUsage

Memory Usage Parameters

Parameter	Length/Range	Description
`memusage`	N/A	The peer process memory usage configuration details.
`state`	N/A	Enable this flag to measure the memory usage of each active process. `disable` (default) `enable`
`level`	N/A	Specifies the level of details to be displayed. `summary` (default) `detailed`
`Interval`	0-1440 minutes	The time interval, in minutes, to elapse between the recording of each memory usage file to the hard drive. (Default = 5) Note: An interval of 1440 minutes (24 hours) equates to one log entry per day for a process.

Anchor
PlatformAuditLogs
PlatformAuditLogs
Platform Audit Logs

Command Syntax

Code Block

language	none

% set oam eventLog platformAuditLogs
      state <disabled | enabled>

Command Parameters

Multiexcerpt

MultiExcerptName	platformAuditLogs

Platform Audit Logs Parameters

Parameter Length/Range Description

platformAuditLogs

N/A

Use this object to configure a remote server IP address, port, and protocol type to push the platform audit logs to a remote server.

state

N/A

Enable this flag to allow platform audit logging of administrative, privileged, and security actions.

disabled (default)
enabled

Anchor
Rsyslog
Rsyslog
Platform Rsyslog

Use Rsyslog to configure a remote server IP address, port, and protocol type to push platform logs of administrative, privileged, and security actions to a remote server.

When platformRsyslog is enabled, the /etc/rsyslog.conf file is configured to send the configured platform logs to the remote syslog server. The remote server's /etc/rsyslog.conf file must match the configuration of the SBC to receive platform logs. The SBC automatically adds an Access Control List (ACL) rule to send the audit logs through the network processor to the remote server.

Include Page

	_Platform Rsyslog note
	_Platform Rsyslog note

Info
The following logs are not supported: Monit, Mail, Printer, dpkg and the /var/log/messages file.

Info

title	Note

The ACL rule is removed automatically from the default ACL rules when platformRsyslog is disabled.

Info

title	Note

For a High Availability (HA) pair, the /etc/rsyslog.conf file is updated both on the Active and the Standby SBCs to push the audit logs to the remote server.

Command Syntax

Code Block

% set oam eventLog platformRsyslog 
	linuxLogs
		authLog <disabled | enabled> 
		consoleLog <disabled | enabled> 
		cronLog <disabled | enabled> 
		daemonLog <disabled | enabled> 
		fipsLog <disabled | enabled> 
		kernLog <disabled | enabled> 
		ntpLog <disabled | enabled> 
		platformAuditLog <disabled | enabled> 
		sftpLog <disabled | enabled> 
		syslogLog <disabled | enabled> 
		userLog <disabled | enabled>
	servers server <server1 | server2 | server3>
		port <port #>
		protocolType <relp | tcp | tls-tcp | udp>
		remoteHost <host_ip>  
	syslogState <disabled | enabled>

New Server Configuration Command Parameters

Info

title	Note

Ensure the Platform Rsyslog state is set to "disabled" before configuring/re-configuring the IP address, port, and/or protocol type of the remote server.

Parameter	Length/Range	Default	Description	M/O
`no`	1-3	1	Number of server.	M
`host_ip`	N/A	N/A	Host IP of server.	M
`protocolType`	N/A	TCP	The protocol used to send messages to the Remote Server. `relp` `tcp` `tls-tcp` `udp`	M
`port`	N/A	514	Specifies the port used to send messages to the remote Server.	M

Sys log state Command Parameters

Parameter Description

syslogState

Use this flag to enable/disable the Rsyslog service:

disabled (default)
enabled

Linux logs Command Parameters

To determine which types of logs the Rsyslog service sends to a remote syslog server when the service is enabled, use linuxLogs.

Parameter Description

platformAuditLog

Platform Linux audit log messages (/var/log/audit/audit.log)

consoleLog

Console activity messages (/var/log/session/session*)

sftpLog

Internal-sftp messages (/var/log/sftp.log)

kernLog

Kernal messages (/var/log/kern.log)

userLog

User-level messages (/var/log/user.log)

daemonLog

System daemon messages (/var/log/daemon.log)

authLog

Auth and authpriv security/authorization messages (/var/log/auth.log)

sysLog

Internally generated syslogd messages (/var/log/syslog)

ntpLog

NTP subsystem messages (/var/log/sonus/tmp/ntp.log)

cronLog

Clock deamon messages (/var/log/cron.log)

fipsLog

Fips messages (/var/log/fips.log)

Include Page

	_FIPS_Releases
	_FIPS_Releases

Anchor
SubsystemAdmin
SubsystemAdmin
Subsystem Admin

Command Syntax

Mandatory parameters required to configure an Event log subsystem event type:

Code Block

language	none

% set oam eventLog subsystemAdmin <system_name> <subsys_ID>

Non-mandatory parameters to configure an Event log subsystem event type:

Code Block

language	none

% set oam eventLog subsystemAdmin <system_name> <subsys_ID>
	infoLogState <disabled | enabled>
 	infoLogFiltered <comma-separated event list: mm,options,register,subscribe,notify,transparency>
	maxEventID <0-4.294967295E9>
	minEventID <0-4.294967295E9>

Command Parameters

Multiexcerpt

MultiExcerptName	subsystemAdmin

Subsystem Admin Event Log Parameters

Parameter

Description

subsystemAdmin

Subsystem event logging configuration.

<system_name>

Name of system.

<subsys_ID>

The subsystem/task ID. See Subsystem IDs table below for a list of subsystem IDs.

infoLogState

Use this flag to enable/disable event logging of INFO level messages to DBG and SYS logs for the specified subsystem. By default, infoLogSate is enabled for all subsystems.

disabled
enabled (default)

Note:

If infoLogState is disabled for CHM, nothing is written to AUD logs.
If infoLogState is disabled for CPX, request commands are not recorded to AUD logs.

infoLogFiltered

Use this parameter to configure a category containing one or more of the following events for which not to generate INFO level logs.

mm- Relating to SIP Message Manipulation (SMM) feature.
options- Relating to Options message and subsequent transaction processing.
register- Relating to Register message and subsequent transaction processing.
subscribe- Relating to Subscribe message and subsequent transaction processing.
notify- Relating to Notify message and subsequent transaction processing.
transparency- Relating to SIP transparency feature.

Info

title	Note

You can only configure this parameter when <subsys_ID> = sipsg

Subsystem IDs

aka	arm	asg	brm	cam	cc
chm	cpx	dbl	dcm	debug	dfe
dht	diamc	dnsc	drm	ds	dsa
dtls/srtp	ema	enm	enm_am	enm_test	fm
gcl mbs	gclcomm	gwcm	gwfe	gwsg	h248fe
h323fe	h323sg	ice	iceapp1	iceapp2	iceapp3
iceapp4	iceapp5	iceapp6	iceapp7	iceapp8	icms_test1
icms_test2	ike	im	ipacl	ipm	kfqdn
les	license_sm	lvm	lwresd	mgsg	mim
mrm	mtrm	nim	nrm	nrma	nrs
pathchk	perfs	perfs	pes	pipe	prsnp
rgm	rtm	rtma	sbcintf	scpa	sec
sg	sipcm	sipfe	sipsg	sm	sma
ssa	ssreq	surrreg	trcrt	trm	xrm

Anchor
TypeAdmin
TypeAdmin
Type Admin

Info

title	Note

The syslog ACL rules are added and removed by enabling/disabling syslogState and configuring the syslog log fields.

Info

title	Note

To guard against overlogging, the SBC logs up to 4,294,976,295 messages per second in the event logs (configurable with set oam eventLog typeAdmin system diskThrottleLimit), but additional event messages above that threshold are discarded. If log events must be discarded, the SBC writes an error message about the skipped messages in the system (.SYS) log.

Command Syntax

The following syntax applies to the set oam eventLog typeAdmin command:

Code Block

language	none

% set oam eventLog typeAdmin <acct | audit | debug | memusage | packet |  security | system | trace>
   cdrFileTransferType <compressed | uncompressed>
   compressionSupport <both | none | only>
   compressionDaysToKeep <1-14>
   compressionCleanupDirectory <alternate directory name>
   diskThrottleLimit <0-4294976295>
   encryptFile <disabled | enabled>
   encryptionPublicKey <encryptionPublicKey_name>
   eventLogValidation
   fileCount <1-2048>
   fileSize <256-65535>
   fileWriteMode <default | optimize>
   filterLevel <info>
   messageQueueSize <2-100>
   renameOpenFiles <disabled | enabled>
   rolloverAction <start | stop>
   rolloverInterval <0-31536000>
   rolloverStartTime <time>
   rolloverType <repetitive | nonrepetitive>
   saveTo <none | disk>
   servers <syslogRemoteHost | syslogRemotePort | syslogRemoteProtocol>
   syslogState <disabled | enabled>

Note

Only the Administrator can execute the above command using the audit and security attributes:

% set oam eventLog typeAdmin audit...

% set oam eventLog typeAdmin security...

Info

title	Note

The SBC logs configuration changes made to the encryptFile and encryptionPublicKey parameters. For more detailed information, refer to Encrypting Auto-traced Media.

The following syntax applies to the request oam eventLog typeAdmin command:

Code Block

language	none

% request oam eventLog typeAdmin <acct | audit | debug | memusage | packet |  security | system | trace> rolloverLogNow

% request oam filterStatus <card name> <audit | debug | memusage | security | system | trace> 
	<audit | callproc | directory | netmgmt | policy | resmgmt | routing | security | signaling | sysmgmt | trace

Note

Only the Administrator can execute the following commands using the "audit" and "security" attributes:

% request oam eventLog typeAdmin audit rolloverLogNow
% request oam eventLog typeAdmin security rolloverLogNow
% request oam eventLog filterStatus <card name> security security resetStats

Include Page

	_Info level logs behavior
	_Info level logs behavior

Command Parameters

Multiexcerpt

MultiExcerptName	typeAdmin1

Type Admin Event Log Parameters (set command)

Parameter

Length/Range

Description

typeAdmin

N/A

Event Log configuration table for configuration items related to each Event Log type.

<event_type>

N/A

Specifies the type of event log being configured:

acct – System account data. These files have .ACT extensions.
audit – System audit data. These files contain a record of all management interactions that modify the state of the system. These files have .AUD extensions. It includes all the changes made via the CLI and the Netconf interface. (This attribute is only available to an Administrator)
debug – System debugging data. These files have .DBG extensions.
memusage – Process heap memory usage data. These files have .MEM extensions.
packet – Packet information details. These files have .PKT extensions. If enabled, stores the packet details to .PKT files.
security – Security level events. These files have .SEC extensions. (This attribute is only available to an Administrator)
system – System level events. These files have .SYS extensions.
trace – System trace data. These files have .TRC extensions.

Note: packet (.PKT) and memusage (.MEM) logs are not supported for syslog service. Refer to Supported Log Types for more information on supported log types.

Note: The memusage value printed at the end of the line is in bytes.

cdrFileTransferType

N/A

Write CDRs as compressed, or uncompressed.

compressed
uncompressed (default)

cnfLogFormat

N/A

For backwards compatibility, use this flag to switch between the legacy and CNF logging formats of the debug, system, and security Type Admin options at runtime by either enabling or disabling the cnfLogFormat flag.

disable (default)
enable

For CNF, the format is: YYYY-MM-DD HH:MM:SS ZONE File administratively closed

For non-CNF, the format remains: MMDDYYYY HHMMSS ZONE: File administratively closed

Info

title	Note

This flag is applicable for SBC CNe deployments only with respect to the debug, system, and security files.

compressionSupport

N/A

Type of compression.

both – The SBC generates both compressed and uncompressed CDR files
none (default) – For backward compatibility, uncompressed CDR files
only – The SBC generates compressed CDR files

compressionDaysToKeep 1-14 The number of days to keep compressed files before deleting. Default = 5.

compressionCleanupDirectory

N/A

The alternate directory name (containing no slashes) under the evlog file directory from which compressed files are removed after compressionDaysToKeep days.

Info

title	Note

You must create a script to transfer the compressed file to the newly-created directory.

diskThrottleLimit

0-4294976295

Specifies the limit on INFO level messages logged to the disk in one second. A value of 0 disables the limit. The default value is 10000.

Note: For the trace log, if tracing is being performed to capture all of the SIP PDU for all of the calls on the system for use in conjunction with Ribbon Analytics, then this value needs to be tuned to accommodate the maximum call load anticipated for the SBC instance. For example, for a call rate of 1350 cps and assuming 14 messages in a basic SIP call (ingress and egress legs), it would require a total of 18,900 messages. Adding this to the default 10000, the recommendation in this case would be to set the limit at 30,000.

encryptFile

N/A

Specifies whether the packet files are encrypted.

disabled (default) - The .PKT files contain unencrypted data.
enabled - The .PKT files contain encrypted data. When enabled, the encryptionPublicKey parameter is mandatory.

Note: You can configure this parameter only when typeAdmin is set to packet.

For more detailed information, refer to Encrypting Auto-traced Media.

encryptionPublicKey

128-1024 bytes

This is the RSA public key without ssh-rsa at the beginning of the key contents and without the user email at the end of the key contents. This key uses a minimum of 2048 bits and accommodates public keys of up to 4096 bits in length.

Note: This parameter is mandatory when encryptFile is set to enabled.

Note: You can configure this parameter only when typeAdmin is set to packet.

For more detailed information, refer to Encrypting Auto-traced Media.

eventLogValidation

N/A

Specifies whether the logs at rest for this log type should be cryptographically hashed.

Hashing is only recommended for the security and audit logs. These are the main logs required to triage security issues and do not roll very frequently. Hashing must be disabled for logs that are rolling over frequently as would occur for the trace log if the call rate is 1350 cps and it is being used to capture all SIP PDU's for use with Ribbon Analytics.

If logs are being exported using Rsyslog then there is no need to enable Event Log Validation as the logs are copied off the SBC before they could be modified. Refer to OAM - Event Log - Platform Rsyslog.

disabled (default)
enabled

IMPORTANT: You must disable this control for any logs which are rolling at a very high rate (e.g. capturing trace logs of all SIP PDUs for use with Ribbon Analytics).

Hash Notes:

Hashes are stored in /.../evlog/eventLogValidation/
The hash file name format is <evLogfilename>.hash.<keyName>
Hashes must be retrieved using SFTP

fileCount

1-2048

Specifies the number of event log files that will be maintained for this event type. (default = 32).

fileSize

256-65535

Maximum size (in KB) that a single event log file will ever grow to. (default = 2048).

Note: Set the file size to 65535 for trace and account logs when attempting to trace all calls on the system for use with Ribbon Analytics.

fileWriteMode

N/A

Event log NFS write mode.

default – Log data is written as a 1344-byte packet.
optimize – Log data is written as a 8000-byte packet. Optimize write mode results in IP fragmentation but yields better throughput.

filterLevel

N/A

Logs every possible event.

messageQueueSize

2-100

The number of event log message entries to buffer before writing to disk. (default = 10). If capturing all of the SIP PDU messages in the trace log for use with Ribbon Analytics, set this value to 100 for the trace log.

renameOpenFiles

N/A

Enable this flag to append an ".OPEN" extension to accounting and files which are open for writing.

disabled (default)
enabled

Note: You must enable the global callTrace signalingPacketCapture parameter (set state to "enable") to capture SIP and H.323 packets (Refer to Call Trace - CLI for configuration details).

Once signalingPacketCapture is enabled, any subsequent changes to SBC device configurations or filter information will not be available to signaling packet captures until signalingPacketCapture is reset (state is disabled, and then re-enabled).

rolloverAction

N/A

Event log rollover actions.

start – Start rollover action
stop – Stop rollover action

rolloverInterval

0-31536000

Event log rollover interval, in seconds.

Note: When using this service, you must set a value of 15 seconds or more.

rolloverStartTime

N/A

Specifies the start time for event log rollover. The format is CCYY-MM-DDTHH:MM:SS. For example: 2010-01-01T01:01:01

rolloverType

N/A

Event log rollover type.

nonrepetitive (default) – The rollover will occur once at the specified single instance.
repetitive – The rollover will occur repeatedly at the specified intervals.

saveTo

N/A

Use flag to specify that the events are saved to disk or not saved.

disk (default)
none

state

N/A

Specifies the requested state of the given Event Log type.

disabled – Logging is not activated.
enabled – (default) Logging is activated.
rollfile – Use this option to close the active log file and open a new one with an incremented (name) suffix. This facilitates real-time analysis of system events by performing the analysis on closed, rather than opened and growing, files.

Do not disable accounting and audit logs.

servers

N/A

Configure a remote Rsyslog Server for a single log type:

syslogRemoteHost – (0-255) The remote host where the messages are written to the syslog.
syslogRemotePort – (1-65,535) Specifies the port to use to send messages to the remote syslog. Default value is 514.
syslogRemoteProtocol – The protocol to use to send messages to the remote syslog.
- relp
- tcp (default)
- tls-tcp
- udp

Note: packet (.PKT) and memusage (.MEM) logs are not supported for syslog service. Refer to Supported Log Types for more information on supported log types.

syslogState

N/A

Enable flag to log events of specified type to syslog.

disabled (default)
enabled

Info

title	Notes on Compression-Related File Naming

For Hardware and SWe-Based Systems

The compressed files are named using the following convention:

<System Name>_<timestamp>_xxxxxxx.ACT.gz

...where System Name is the name of the Redundancy group.
Example: SBX30_1571352583_1000018.ACT.gz

The number of files created and maintained concurrently is unlimited, and is not constrained by the fileCount configured for the accounting log.

For N:1 Cloud-Based Systems

The compressed files are named using the following convention:

< Hostname i.e. VM Name >_<timestamp>_xxxxxxx.ACT.gz

You cannot use the system name because, in an N:1 system, multiple instances running in active mode would have the same system name.

The SBC uses the actualCeName as the Hostname because this is the name specified in the user metadata.
Example: vsbc1Site1_1571352902_1000003.ACT.gz

The number of files created and maintained concurrently is unlimited, and is not constrained by the fileCount configured for the accounting log.

For 1:1 Cloud-Based Systems

The compressed files are named using the following convention:

<System Name>_<timestamp>_xxxxxxx.ACT.gz

...where System Name is the actualSystemName, as this is the name specified in the user metadata.
Example: vsbcSystem22_1571348519_1000001.ACT.gz

The number of files created and maintained concurrently is unlimited, and is not constrained by the fileCount configured for the accounting log.

Multiexcerpt

MultiExcerptName	typeAdmin2

Type Admin Event Log Parameters (request command)

Parameter

Description

typeAdmin

Event Log configuration table for configuration items related to each Event Log type.

<event_type>

Specifies the type of event log to roll over:

acct – System account data. These files have .ACT extensions.
audit – System audit data. These files contain a record of all management interactions that modify the state of the system. These files have .AUD extensions. It includes all the changes made via the CLI and the Netconf interface. (This attribute is only available to an Administrator)
debug – System debugging data. These files have .DBG extensions.
memusage – Process heap memory usage data. These files have .MEM extensions.
packet – Packet information details. These files have .PKT extensions. If enabled, stores the packet details to .PKT files.
security – Security level events. These files have .SEC extensions. (This attribute is only available to an Administrator)
system – System level events. These files have .SYS extensions.
trace – System trace data. These files have .TRC extensions.

rolloverLogNow

This control is used with request command to perform a roll-over of the specified log immediately.

Hide

Note TO TECH DOCS: This content is hidden based on Christopher John's comments until there is bandwidth to document correct examples.

Command Examples

To view typeAdmin status from the system-level prompt:

Info
Refer to Show Table OAM for additional details.

Code Block

> show table oam eventLog typeAdmin
                                                MAX
                                 MESSAGE        EVENT           ROLLOVER                                     FILE               SYSLOG   SYSLOG    SYSLOG  RENAME    DISK
                   FILE   FILE   QUEUE    SAVE  MEMORY  FILTER  START     ROLLOVER                 ROLLOVER  WRITE    SYSLOG    REMOTE   REMOTE    REMOTE  OPEN      THROTTLE
TYPE      STATE    COUNT  SIZE   SIZE     TO    SIZE    LEVEL   TIME      INTERVAL  ROLLOVER TYPE  ACTION    MODE     STATE     HOST     PROTOCOL  PORT    FILES     LIMIT
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
system    enabled  32     2048   10       disk  16      major   -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  5000
debug     enabled  32     10240  10       disk  16      info    -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -
trace     enabled  32     2048   10       disk  16      info    -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -
acct      enabled  32     2048   10       disk  16      major   -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -
security  enabled  32     2048   10       disk  16      major   -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -
audit     enabled  32     2048   10       disk  16      minor   -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -
packet    enabled  32     2048   10       disk  16      major   -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -
memusage  enabled  32     2048   10       disk  16      major   -         0         nonrepetitive  stop      default  disabled  0.0.0.0  tcp       514     disabled  -

To configure event log type “packet” by setting file count to “1”, maximum file size to 256 KB, roll-over interval to 2 seconds, and then enabling the event log but disabling the logging of events to syslog:

Code Block

language	none

% set oam eventLog typeAdmin system fileCount 1 fileSize 256 rolloverInterval 2 state enabled syslogState disabled
% show oam eventLog typeAdmin system
   state enabled;
   fileCount 1;
   fileSize 256;
   rolloverInterval 2;
   syslogState disabled;

To send the command to request an immediate roll-over:

Code Block

language	none

% request oam eventLog typeAdmin system rolloverLogNow

To display typeAdmin event log details (shortened for brevity).

Code Block

language	none

% show details oam eventLog typeAdmin

typeAdmin system {
    state                enabled;
    fileCount            32;
    fileSize             2048;
    messageQueueSize     10;
    saveTo               disk;
    filterLevel          info;
    rolloverInterval     0;
    rolloverType         nonrepetitive;
    rolloverAction       stop;
    fileWriteMode        default;
    syslogState          disabled;
    syslogRemoteHost     0.0.0.0;
    syslogRemoteProtocol tcp;
    syslogRemotePort     514;
    renameOpenFiles      disabled;
}

Code Block

language	none

typeAdmin debug {
    state                enabled;
    fileCount            32;
    fileSize             2048;
    messageQueueSize     10;
    saveTo               disk;
    filterLevel          info;
    rolloverInterval     0;
    rolloverType         nonrepetitive;
    rolloverAction       stop;
    fileWriteMode        default;
    syslogState          disabled;
    syslogRemoteHost     0.0.0.0;
    syslogRemoteProtocol tcp;
    syslogRemotePort     514;
    renameOpenFiles      disabled;
}

Code Block

language	none

typeAdmin trace {
    state                enabled;
    fileCount            32;
    fileSize             2048;
    messageQueueSize     10;
    saveTo               disk;
    filterLevel          info;
    rolloverInterval     0;
    rolloverType         nonrepetitive;
    rolloverAction       stop;
    fileWriteMode        default;
    syslogState          disabled;
    syslogRemoteHost     0.0.0.0;
    syslogRemoteProtocol tcp;
    syslogRemotePort     514;
    renameOpenFiles      disabled;
}

Code Block

language	none

typeAdmin memusage {
    state                enabled;
    fileCount            32;
    fileSize             2048;
    messageQueueSize     10;
    saveTo               disk;
    filterLevel          info;
    rolloverInterval     0;
    rolloverType         nonrepetitive;
    rolloverAction       stop;
    fileWriteMode        default;
    syslogState          disabled;
    syslogRemoteHost     0.0.0.0;
    syslogRemoteProtocol tcp;
    syslogRemotePort     514;
    renameOpenFiles      disabled;
}
...

Parameters for Configuring New Remote Rsyslog Servers

Parameter	Length/Range	Default	Description
no	1-3	1	Number of server.
host_ip	N/A	N/A	Host IP of server.
protocol	N/A	tcp	The protocol used to send messages to the Remote Server. tcp relp udp
port	N/A	514	Specifies the port used to send messages to the remote Server.

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Overview

Event Types

AnchorFilterAdminFilterAdminFilter Admin

Command Syntax

Command Parameters

Filter Admin Event Log Parameters

AnchorFilterStatusFilterStatusFilter Status

Command Syntax

Command Parameters

Filter Status Event Log Parameters

AnchorInfoLevelLoggingEnableInfoLevelLoggingEnableINFO Level Logging Enable

Command Syntax

Command Parameter

Info Level Logging Enable Event Log Parameter

AnchorMemUsageMemUsageMemory Usage

Command Syntax

Command Parameters

Memory Usage Parameters

AnchorPlatformAuditLogsPlatformAuditLogsPlatform Audit Logs

Command Syntax

Command Parameters

Platform Audit Logs Parameters

AnchorRsyslogRsyslogPlatform Rsyslog

Command Syntax

New Server Configuration Command Parameters

Sys log state Command Parameters

Linux logs Command Parameters

AnchorSubsystemAdminSubsystemAdminSubsystem Admin

Command Syntax

Command Parameters

Subsystem Admin Event Log Parameters

Subsystem IDs

AnchorTypeAdminTypeAdminType Admin

Command Syntax

Command Parameters

Type Admin Event Log Parameters (set command)

Type Admin Event Log Parameters (request command)

Command Examples

Anchor
FilterAdmin
FilterAdmin
Filter Admin

Anchor
FilterStatus
FilterStatus
Filter Status

Anchor
InfoLevelLoggingEnable
InfoLevelLoggingEnable
INFO Level Logging Enable

Anchor
MemUsage
MemUsage
Memory Usage

Anchor
PlatformAuditLogs
PlatformAuditLogs
Platform Audit Logs

Anchor
Rsyslog
Rsyslog
Platform Rsyslog

Anchor
SubsystemAdmin
SubsystemAdmin
Subsystem Admin

Anchor
TypeAdmin
TypeAdmin
Type Admin