Page History

...

Noprint

Panel

borderColor	green
bgColor	transparent
borderWidth	2

Back to Table of Contents

Back to CLI Configure Mode

Back to Operations and Maintenance - CLI

...

Back To Top

Multiexcerpt

MultiExcerptName	filterAdmin

Caption

0	Table
1	Filter Admin Event Log Parameters
3	Filter Admin Event Log Parameters

Parameter

Description

Mandatory parameters:

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.
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.

Noprint

Anchor
FilterStatus
FilterStatus
Filter Status

...

Back To Top

Multiexcerpt

MultiExcerptName	filterStatus

Caption

0	Table
1	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. `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.

Noprint

Anchor
InfoLevelLoggingEnable
InfoLevelLoggingEnable
INFO Level Logging Enable

...

Back To Top

Multiexcerpt

MultiExcerptName	platformAuditLogs

Caption

0	Table
1	Platform Audit Logs Parameters

Parameter

Length/Range

Description

platformAuditLogs

N/A

Use this command to enable/disable platform audit logging of administrative, privileged, and security actions.

state
- disabled (default)
- enabled

Noprint

Anchor
SubsystemAdmin
SubsystemAdmin
Subsystem Admin

...

noprint

Caption

0	Table
1	Subsystem IDs
3	ids

acm	arma	asg	atmrm	brm	cam
cassg	cc	chm	cli	cmtsg	cnh
cpx	dbug	diamc	dnsc	drm	ds
ema	enm	fm	frm	grm	gwfe
gwsg	h323sg	icmsvc	ike	im	ipacl
ipm	lvm	mgsg	mtp2	mtrm	ncm
ncomm	nim	nrm	nrma	nrs	ntp
pathchk	pes	pfa	pipe	pipehook	prm
reserved	rtcp	rtm	scpa	sec	sfm
sg	sgisdn	sgisup	sipfe	sipsg	sm
sma	ssa	trm	xrm

...

Back To Top

Anchor
TypeAdmin
TypeAdmin
Type Admin

...

Include Page

	Info level logs behavior
	Info level logs behavior

...

Command Parameters

Multiexcerpt

MultiExcerptName	typeAdmin1

Caption

0	Table
1	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.
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
Syslog is not supported for `acct` and `packet` event types.

fileCount

1-1024

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).

fileWriteMode

N/A

Event log NFS write mode. Options are:

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

Events that are at least as severe as the designated level will be logged. Options are:

critical – log only events of this threshold.
info – log every possible event.
major – log major and critical events only.
minor – log all events other than information.
noevents – do not log any events.

Note
The command to set the `filterLevel` for the `acct` event type is no longer applicable.

messageQueueSize

2-32

The number of event log message entries to buffer before writing to disk. (default = 10).

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 (see 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. Options are:

start – Start rollover action.
stop – Stop rollover action.

rolloverInterval

0-31536000

Event log rollover interval, in seconds.

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. Options are:

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

Accounting logs cannot be disabled.

syslogRemoteHost

0-255

The remote host where the messages are written to the syslog.

syslogRemotePort

1-65535

Specifies the port to use to send messages to the remote syslog. Default value is 514.

syslogRemoteProtocol

N/A

The protocol to use to send messages to the remote syslog. Options are:

relp
tcp (default)
udp

syslogState

N/A

Enable flag to log events of specified type to syslog.

disabled (default)
enabled

Back To Top

Multiexcerpt

MultiExcerptName	typeAdmin2

Caption

0	Table
1	Type Admin Event Log Parameters (request 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 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.
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

N/A

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

Noprint

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  -

To configure event log type “packet” by setting file count to “1”, maximum file size to 256 KB, roll-over interval to 2 secondsThis example configures 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 This example sends the command to request an immediate roll-over:

Code Block

language	none

% request oam eventLog typeAdmin system rolloverLogNow

To display This example displays typeAdmin event log details. It has been shortened for brevity.

noprint

Code Block

language	none

% show details oam eventLog typeAdmin

typeAdmin system {
    state                enabled;
    fileCount            32;
    fileSize             2048;
    messageQueueSize     10;
    saveTo               disk;
    filterLevel          major;
    rolloverInterval     0;
    rolloverType         nonrepetitive;
    rolloverAction       stop;
    fileWriteMode        default;
    syslogState          disabled;
    syslogRemoteHost     0.0.0.0;
    syslogRemoteProtocol tcp;
    syslogRemotePort     514;
    renameOpenFiles      disabled;
}
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;
}
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;
}
...

...

Pagebreak

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version 9

Key

Anchor
FilterStatus
FilterStatus
Filter Status

Anchor
InfoLevelLoggingEnable
InfoLevelLoggingEnable
INFO Level Logging Enable

Anchor
SubsystemAdmin
SubsystemAdmin
Subsystem Admin

Anchor
TypeAdmin
TypeAdmin
Type Admin

Command Parameters

Command Examples

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version 9

Key

AnchorFilterStatusFilterStatusFilter Status

AnchorInfoLevelLoggingEnableInfoLevelLoggingEnableINFO Level Logging Enable

AnchorSubsystemAdminSubsystemAdminSubsystem Admin

AnchorTypeAdminTypeAdminType Admin

Command Parameters

Command Examples

Anchor
FilterStatus
FilterStatus
Filter Status

Anchor
InfoLevelLoggingEnable
InfoLevelLoggingEnable
INFO Level Logging Enable

Anchor
SubsystemAdmin
SubsystemAdmin
Subsystem Admin

Anchor
TypeAdmin
TypeAdmin
Type Admin