The services objects allow you to configure ME event logging and virus scanning services.
The ME uses the filters you define in the event-log subobjects to determine the type and severity of event messages to send to the destination target. When creating a filter you specify the log class, which selects which type of event messages to send. Use the question mark at the command line to display the complete list of log classes. After selecting a class, select a severity level.
Event log messages can be written to:
A remote syslog server
A file
The local database
An external database
The CLI window
An SMTP server
A Tivoli server
When configuring the message destination, you can configure one or more filters to determine which message types are written to that destination. A filter sorts messages based on the event type (log class) and the severity level.
The log class indicates the subsystem that generated the message. The severity indicates the lowest level message to display. You get messages of that class and below, with Emergency being the lowest and Debug the highest. If you set severity to error, you will receive Emergency, Alert, Critical and Error events. The following severity levels are recognized by the ME:
emerg (Emergency)
alert (Alert)
crit (Critical)
error (Error)
warning (Warning)
notice (Notice)
info (Information)
debug (Debug)
For a complete description of the event message types and severity levels, see Net-Net 2600 – Using the NN2600 Management Tools.
Opens the services object from where you configure event log settings and enable virus scanning. In addition, you define locations and schedule tasks for the ME.
Enables and disables global event-log administration. This control manages syslog, file, local and external database, and CLI event log storage or display.
The ME has the ability to translate event logs into SNMP traps. When a log event is generated, the log system checks if the class and severity levels fall under any filters specified in the event-log config. If it is determined that this log event should be translated into an SNMP trap, the log system fills in the SNMP trap fields. Any interfaces that have SNMP targets configured transmit the trap.
The SNMP trap contains the following fields:
Box ID
Severity Level
Process
Log Class
Log Message
The filter that the ME uses for the event-to-SNMP feature is a list of regular expression filters which you configure as a regular expression that runs on the generated log string. The ME first checks the ”allowed-trap” list, then the ”blocked-trap” list. When a log string does not match either list, it is allowed through. If it matches the ”allowed” list, the log message is let through and the severity is modified. If it matches the ”blocked” list, the log event is not generated.
In addition, a filter for each category type has been created. This filter contains each trap that falls under the filter. The following are the eight trap categories:
CSTA
DOS
H.323
LB
SIP
System
TLS
generic
This filtering mechanism is now available under each event log type.
admin: Enables or disables the ME's ability to translate event logs into SNMP traps.
Default: enabled
Values: enabled | disabled
Example: set admin enabled
filter: Specifies the event message filter log class and severity level for transferring event-logs to SNMP traps. Repeat the command to specify multiple event filters.
Default: all
Example: set filter sipRouting debug
Secondary object. This object allows you to configure more granular snmp-trap events. Specify allowed and blocked events (for example the server state change).
config services event-log syslog advanced-filter config services event-log file advanced-filter config services event-log local-database advanced-filter config services event-log external-database advanced-filter config services event-log cli advanced-filter
allowed-event: Secondary object. Enter specific events you want allowed by the SNMP trap feature.
Default: There is no default setting
Example: set allowed-event ”SIP server peer (.+) server (.+) changed” info
blocked-event: Secondary object. Enter specific events you want blocked by the SNMP trap feature.
Default: There is no default setting
Example: set blocked-event (.*)
Enables and disables a remote syslog server, specified by the syslog server IP address, and sets the filters to define which events the ME sends.
admin: Enables or disables the ME event logging to the remote syslog server.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
filter <log-class><severity>: Specifies the event message filter log class and severity level for messages forwarded to the syslog server. Repeat the command to specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter snmp warning
facility: Sets the user-defined syslog facility to which the ME logs system events. Syslog facilities help isolate the origin of messages written to the syslog server.
Default: user
Values: user | local0 | local1 | local2 | local3 | local4 | local5 | local6 | local7
Example: set facility local5
Specifies the ME configuration settings for the named event log file. Specify the name using up 64 alphanumeric characters with no blank spaces. Optionally, you can specify directory file paths using the forward slash (/) character. Additionally, you set the filters to define which events the ME sends with this object.
admin: Enables or disables the system event log file.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
filter: Specifies the event filter type and severity level for messages written to the event log. Repeat the command specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter snmp warning
size: Set the maximum allowable size, in megabytes, of the event log file.
Default: 10
Values: Min: 1 / Max: 100
Example: set size 25
count: Specifies the maximum number of event log files to create when the event log file reaches the maximum size in megabytes.
When the maximum count is reached, the first file in the rotation is cleared for rewriting and the count is resumed.
Default: 5
Values: Min: 1 / Max: 20
Example: set count 15
Specifies the configuration settings for storing events in the ME local database and sets the filters to define which events the ME sends.
admin: Enables or disables the system local database. When disabled, the system does not write event log messages to the local database. However, you can still view any messages previously in the local database using the show event-log command.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
filter: Specifies the event filter type and severity level for messages written to the local database. Repeat the command to specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter snmp warning
history: Sets the maximum number of days to store events in the local database. When the maximum number of days is reached, the local database is cleared and is restarted at the first day.
Default: 100
Values: Min: 1 / Max: 10000
Example: set history 50
Specifies the external (remote) database that serves as a target for event messages. Define this database with the database object. Additionally, you set the filters to define which events the ME sends with this object.
For more information on the services/database object, refer to the Oracle Communications WebRTC Session Controller Administration Guide.
admin: Enables or disables the external database configuration. When disabled, the system does not write event log messages to the database.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
filter: Specifies the event filter type and severity level for messages written to the external database. Repeat the command to specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter snmp warning
history: Sets the maximum number of days to store events in the external database. When the maximum number of days is reached, the local database is cleared and is restarted at the first day.
Default: 100
Values: Min: 1 / Max: 10000
Example: set history 50
Globally enables or disables writing of events to the CLI and sets the filters to define which events the ME sends. Use the log-target action to enable or disable the feature for the current CLI.
admin: enables or disables writing event messages to the CLI.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
filter: Specifies the event filter type and severity level for messages written to the CLI. Repeat the command to specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter snmp warning
Enables and disables mailing of events to a designated SMTP server and sets the filters to define which events the ME sends. The ME then collects the events into an email and sends them to the SMTP server once every minute. Enter the host name or IP address of the SMTP server to open this object.
admin: Enables or disables the SMTP server event log archiving configuration. When enabled, the system emails session event logs to the specified address. When disabled, the system does not email the log files.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
destination-mailbox: Specifies the email address to which the system sends the session event logs.
Default: There is no default setting
Example: set destination-mailbox admin@companyABC.com
reply-mailbox: Specifies the address that appears in the ”From” field of the emailed event logs. If you do not specify this property, the ”From” field is empty.
Default: There is no default setting
Example: set reply-mailbox events@companyABC.com
port: Specifies the port number over which the system should communicate with this SMTP server.
Default: 25
Values: Min: 1 / Max: 65535
Example: set port 100
connection-keepalive: Specifies the length of time, in minutes, that the system keeps the connection to the SMTP server open. This prevents opening and closing the connection with each event.
Default: 5
Values: Min: 5 / Max: 60
Example: set connection-keepalive 20
filter <log-class><severity>: Specifies the event filter type and severity level for messages forwarded to the SMTP server. Repeat the command to specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter dns crit
Enables and disables sending of events to a designated Tivoli server and sets the filters to define which events the ME sends. Enter the host name or IP address of the Tivoli server to open this object.
admin: Enables or disables the Tivoli server event log archiving configuration. When enabled, the system sends session event logs to the specified address. When disabled, the system does not send the log files.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
protocol: Specifies the protocol the system uses to communicate with the Tivoli server.
Default: tcp
Values: tcp | udp
Example: set protocol udp
port: Specifies the port number over which the system should communicate with this Tivoli server.
Default: 7500
Values: Min: 1 / Max: 65535
Example: set port 7501
filter <log-class><severity>: Specifies the event filter type and severity level for messages forwarded to the Tivoli server. Repeat the command to specify multiple event filters. See Using Filters with Event Log Messages for complete information.
Default: There is no default setting
Example: set filter dns crit
Defines the external database. Configure the ME to use this database as an external log target using the external-database object. Consult your database administrator for information regarding authentication on the remote database before configuring this object.
driver: Specifies the name of the Open Database Connectivity (ODBC) driver associated with the database.
Default: There is no default setting
Example: set driver psq10DBC
username: Specifies the user name needed for the system to access the database. This is the name the database expects to see when authenticating requests.
Default: There is no default setting
Example: set username nnos-e
secret-tag: Specifies the secret tag (and password) needed for the system to access the database. This is the secret the database expects to see when authenticating requests. See Understanding Passwords and Tags for information on the ME two-part password mechanism.
Default: There is no default setting
Example: set secret-tag 123
options: Sets the options specified by the database. Use this to identify the location of the database.
Default: There is no default setting
Example: set options connection 192.168.100.100
The instrumentation settings are for debugging and are intended for Technical Support use only. Do not use this object without specific instructions from Oracle personnel.
Specifies the directory and path locations on the ME where you would like to save certain types of information. This information includes:
Accounting records prior to their being written to accounting targets.
RTP media and mixed, for recording and playback of recorded calls.
File transfer records.
Log files.
Configuring these locations is optional; the ME provides default directory path locations. If you choose not to configure locations, the default directory path for all file types is /cxc_common/* on the system hard-drive-1.
You can also configure multiple path locations. When you set a location, the ME adds the location to the list of possible paths. The ME uses these secondary locations when it reaches the fail-threshold (set with the storage-device object). You must use the remove command to delete an entry from the save/search list.
The ME handles the location selection as follows:
For files being written (call recordings, file transfer records, and log files), the ME searches for an available location in the order in which the files were created. An available location is one that is mounted and not full.
For files being read (call playback), the ME searches all locations.
You can display the default directory file paths or the search order using the show command.The accounting process then reads those records in and services the various accounting targets. The file system acts as a large storage queue, providing two distinct benefits:
The ME Media Engine saves all accounting records to an internal files system before writing them to defined targets. Therefore, the accounting function has a more secure backup and more efficient record writing:
Records can be saved until they are successfully written to the target. In addition, for a configurable amount of time they can be reapplied from the file system to the destination target if the target encounters problems, providing record recovery.
Record writing is more efficient because it is not bound to call flow or dependent on target capabilities. The queueing mechanism of an external target could cause queue overflow and data loss. With an internal file system, files can be written to the target at a rate the target can handle.
The file system is made up of a root directory and subdirectories to hold the records. See the VSP accounting object for configurable options such as subdirectory size, purge criteria, and record retention periods.
accounting-root-directory: Sets the location where the system writes accounting records prior to their being sent to various configured accounting targets. For optimal record access, the ME maintains an internal file structure of subdirectories within this specified root directory. Use the VSP accounting object to set the number of records stored in each subdirectory.
Default: /cxc_common/accounting
Example: set accounting-root-directory /acme_common/acct_records
rtp-recorded: Sets the location in which the system saves call recordings.
Default: /cxc_common/rtp_recorded; the backup is /cxc/recorded
Example: set rtp-recorded /acme_common/rtp_recorded
rtp-recorded-rotation: Sets the rotation scheme for writing recorded files to a directory. The system writes the files to the directories configured with the rtp-recorded property.
Default: first-available
Values: first-available: The system writes to the first directory listed with the rtp-recorded property that has enough space to hold the recording. The system will continue to write to that directory until the disk fills, and then it will move to the next directory in the list.
round-robin: The system rotates through all configured directories in a round-robin manner. This can allow an increase in the volume of simultaneous recorded calls by spreading the load across multiple disks.
Example: set rtp-recorded-rotation round-robin
rtp-mixed: Sets the location in which the system writes for playback of recorded calls. This is where RTP files are ”mixed” to create files that can then be played back.
Default: /cxc_common/rtp_mixed; the backup is /cxc/mixed
Example: set rtp-mixed /acme_common/rtp_mixed
file-transfer-recorded: Sets the location in which the system saves file transfer records.
Default: /cxc_common/ft_recorded; the backup is /cxc/recorded
Example: set rtp-mixed /acme_common/ft_recorded
log: Sets the location in which the system saves log files.
Default: /cxc_common/log
Example: set log /acme/log
lnp-record-directory: Provides a customer-specific application implementation and is not otherwise applicable.
Default: /cxc_common/lnp
Example: set lnp-record-directory /acme_common/lnp
rtp-on-demand-recorded: Sets the location to which the ME writes files for on-demand recorded calls.
Default: /cxc_common/rtp_on_demand_recorded
Example: set rtp-on-demand-recorded /recorded_directory
rtp-on-demand-recorded-rotation: Sets the rotation scheme for writing on-demand recorded files to a directory. The ME writes the files to the directories configured in rtp-on-demand-recorded.
Default: first-available
Values: first-available: The ME writes to the first directory listed in the rtp-on-demand-recorded property that has enough space to hold the recording. The ME continues to write to that directory until the disk fills, and then moves to the next directory in the list.
round-robin: The ME rotates through all configured directories in a round-robin manner. This allows an increase in the volume of simultaneous recorded calls by spreading the load across multiple disks.
Example: set rtp-on-demand-recorded-rotation round-robin
Configures the ME as a Network File System (NFS) client. NFS is Sun Microsystems' open protocol suite that allows computers running different operating systems to access shared files and share disk storage. It is the UNIX equivalent of Server Message Block (SMB). NFS allows users to import and export local files through an interface called the Virtual File System (VFS), which runs on top of TCP/IP.
When you enable an NFS entry, the ME acts as an NFS client, enabling remote mounted disk storage. Enter a name to open the nfs object. This specifies a mount point (a node in the ME file directory). For example, if you name your nfs object alpha, then the external files are visible at /mnt/alpha/. You may want access to multiple servers, and/or multiple directories from a single server. In that case, each would have a separate NFS configuration object, with a unique mount point.
admin: Enables or disables the mount point.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
server: Specifies the IP address or host name of the NFS server. The system, as a NFS client, has access to the server file system.
Default: There is no default setting
Example: set server 192.168.10.10
share: Specifies the point in the file system that is being shared. When you configure an NFS server, you specify which directory is shared out (as well as read/write permissions and other properties).
Default: There is no default setting
Example: set share /home/staff/nfs
version: Specifies the version on NFS to use. The ME supports versions 2 and 3.
Default: 3
Values: 2 | 3
Example: set version 2
protocol: Specifies the protocol to use when communicating with the server.
Default: udp
Values: udp | tcp
Example: set protocol tcp
timeout: Specifies how long the system waits when trying to read from or write to the server. When the timeout value expires, the system cancels the action. If timeout is set to default, the driver determines the best value, depending on the version and/or protocol set.
Default: default Values: default | custom milliseconds (100-65535)
Example: set timeout 150
Sets the levels at which the ME warns of approaching disk capacity and the frequency of those warnings. In addition, you set the level at which writes to the disk drive fail. If you have set backup file path locations (using the data-locations object), when a disk drive reaches the configured fail threshold setting, The ME begins WRITE operations to the next available disk drive.
The storage-device object operates on all installed disk drives. If all disk drives have reached the configured free space threshold, media call recording, file transfers, and log files will no longer be written to the ME disks.
Note:
Currently, the ME devices support multiple disk drives.fail-threshold: Sets a threshold, in megabytes, at which the system no longer writes recorded calls or IM files to the disk drive. The system sends a warning message to the event log (and an SNMP trap) indicating that space on the internal disk drive has been exceeded. The system checks the fail threshold each time it receives a call.
Default: 10000
Values: Min: 200 / Max: 400000
Example: set fail-threshold 15000
Opens the tasks object, from where you can configure and schedule archiving and maintenance tasks for a VSP.
Sets the action and the schedule for a task. A task can only contain one action. To schedule additional actions, create separate tasks. Each action uses its own set of arguments, described in the arguments property. (These are the same arguments you would supply when executing the function as an action instead of a task.)
schedule: Sets the frequency with which the system executes the task. When entering the time (for time-of-day and once), you can enter the time in regular time format (for example, 3:00). The system displays the time in the format hh:mm:ss (for example, (03:00:00).
Default: disabled
Values: disabled: The task is not executed, but the configuration remains.
period: The task is executed with the specified frequency. Enter the interval, in hours from 1 to 288, between executions.
time-of-day: The task is executed at the specified time for the number of days specified, between 1 and 12.
days: The task is executed at the specified time on the days specified.
once: The task is executed once at the specified time. If you do not enter a date, the system uses the current day.
Example: set schedule time-of-day 1:00
action: Sets the action that the task performs. Each action has a dependent set of arguments. See descriptions below for complete action/argument details.
arguments: Sets the arguments for the selected action. See descriptions below for complete action/argument details.
Note that when you are entering more than one word or value for an argument you must enclose the string in quotation marks.
The following table shows the task actions and arguments.
Table 38-1 Task Actions and Arguments
| Action name | Description |
|---|---|
|
action archive: arguments vspName |
Saves stored sessions for the VSP. You must also enable archiving through the archiving object. See the archive action for more information. Note that if you have the record-count property of the archiving object set to any value other than 0, the archiving task will fail. set arguments vsp1 The default VSP archived is default. |
|
action call-failover arguments flush |
Flushes the call-failover database of any signaling and media-session records used to maintain call state between redundant ME devices. See the call-failover action for more information. set arguments flush There is no default setting. |
|
action database arguments {{delete | vacuum | vacuum-full | drop} database [table] | repair {translate | data-recovery} | initialize | snapshot {integer | force | automatic}} |
Deletes or cleans database records (for databases you configured with the master services' database object). See the database action for more information. set arguments ”snapshot log force” There is no default setting. |
|
action database-maintenance |
Executes a multistep maintenance operation on entries found in the system database tables to optimize database access. See the database action for argument descriptions and more information. set arguments ”save backup.xml” Requires no arguments. |
|
action directory-clean |
Removes empty recorded media directories. You may have an empty directory, for example, if the system cleaned a directory as part of a scheduled maintenance operation. That action removes data but leaves the directories. This action takes no arguments. |
|
action directory-reset arguments vspName [true | false] |
Resets the enterprise directory, causing the system to reread the directory and update the user information. Enter the name of the VSP that houses the directory. In addition, you can set a directory purge action of true or false: true: Clears out the contents of the database and then repopulates it. false: Updates the database but leaves users that are no longer in the directory itself in the database. set arguments ”vsp1 false” If you do not enter a VSP name, the system uses the VSP default. For the directory-reset action, the default purge action is true. |
|
action external-normalization arguments {replace-file fileName | replace-url source | flush} |
Manages the file used to maintain DNIS-to-ANI translation data. See the external-normalization action for more information. set arguments flush There is no default setting. |
|
action external-presence arguments {delete url | flush} |
Clears all or a specified entry from the external presence cache. The external cache is the database running on the backup ME device in a cluster configuration. See the external-presence action for argument descriptions and more information. set arguments flush There is no default setting. |
|
action external-session arguments flush |
Removes all entries from the external CSTA SIP session cache. See the external-session action for more information. set arguments flush There is no default setting. |
|
action file-based-word-lists-refresh |
Rereads any saved word-list or url-list file entry into memory. See the file-based-word-lists-refresh action for argument descriptions and more information. set arguments ”delete 5085551212@abc.com” This action takes no arguments. |
|
action file-transfer-delete-old arguments days |
Deletes all files brought on to the system, via a file transfer, that are older than the specified number of days. See the file-transfer-delete-old action for more information. set arguments 30 Enter a number of days between 1 and 1,000. The default number of days is 7. |
|
action install arguments {file source [box | cluster | controlled] | url source [box | cluster | controlled] | nic [model] | nic-reinitialize | module | cancel} |
Manages system software releases and network interface cards (NICs). See the install action for more information. set arguments ”file release.tar.gz controlled” There is no default setting. |
|
action load-balancing-failover arguments flush |
Deletes all recorded media files older than the specified number of days. See the media-delete-old action for more information. set arguments flush There is no default setting. |
|
action location-database arguments {merge [filePath] | replace [filePath] | save [filePath] | delete aor | flush} |
Manages the location database across the cluster. See the location-database action for argument descriptions and more information. set arguments ”save backup.xml” For merge, replace, and save options, the default location is /cxc/location.xml. |
|
action loopback arguments {packet | packet-init} seconds to [from] [any | udp | tcp | tls] |
Establishes an outgoing SIP loopback call. See the loopback action for more information. set arguments packet 10 sip:5554443211@jane.cov.com The default duration is 10 seconds. |
|
action media-delete-old arguments days |
Deletes all recorded media files older than the specified number of days. See the media-delete-old action for more information. set arguments 30 Enter a number of days between 1 and 1,000. The default number of days is 7. |
|
action orderly-restart arguments {warm | cold | halt | cluster} |
Causes a restart of the type specified after gracefully terminating any existing connections. See the orderly-restart action for argument descriptions and more information. set arguments cluster The default type is warm. |
|
action presence arguments {merge fileName | replace fileName | save fileName | delete URL | flush} |
Manages the presence cache. See the presence action for argument descriptions and more information. set arguments ”delete 5085551212@abc.com” The default type is warm. |
|
action restart arguments {warm | cold | halt | cluster} |
Causes an immediate restart of the type specified. See the restart action for argument descriptions and more information. set arguments cluster There is no default setting. |
|
action uri-alias arguments {lookup AOR | reset | purge | seek AOR} |
Causes an immediate restart of the type specified. See the uri-alias action for argument descriptions and more information. set arguments purge There is no default setting. |
Sets system network parameters. By fine-tuning these settings, you gain greater control over network behavior. Generally the default TCP settings are adequate, however, so use caution before making changes.
tcp-keepalive: Specifies the time, in seconds, that an established TCP connection can remain idle before the system sends a keepalive to the client. The idle time expiration initiates the keepalive process.
Default: 600
Values: Min: 30 / Max: 14400
Example: set tcp-keepalive 1200
tcp-keepalive-probes: Specifies the number of unanswered TCP keepalive probes that are allowed before the system disconnects an idle session.
Default: 5
Values: Min: 2 / Max: 16
Example: set tcp-keepalive-probes 10
tcp-keepalive-interval: Specifies the time, in seconds, that the system waits for a response from a keepalive probe before ending the next one. The system continues to send probes until it has sent the number specified in the tcp-keepalive-probes property.
Default: 6
Values: Min: 1 / Max: 60
Example: set tcp-keepalive-interval 10
tcp-max-syn-backlog: Specifies the maximum number of queued (unacknowledged) connection requests allowed before the system begins dropping requests. This value is set to help prevent a TCP SYN flood attack.
Default: 1024
Values: Min: 16 / Max: 131027
Example: set tcp-max-syn-backlog 1536
tcp-synack-retries: Specifies the number of times the system will retransmit a SYN-ACK in response to a SYN. If the number of retries is reached without a successful response, the system deletes the new connection from the table. This value helps minimize the effects of a SYN flooding attack.
Default: 5
Values: Min: 1 / Max: 5
Example: set tcp-synack-retries 4
tcp-syncookies: Enables or disables SYN cookie support in the kernel. When enabled, the kernel handles TCP SYN packets normally until the queue is full. Then, the kernel replies to a SYN with an intentionally modified TCP sequence number. A legitimate connection uses the number in the third packet of the three way handshake, allowing the system to verify and allow the connection, even though there is no corresponding entry in the SYN queue. An attacker would not respond with the sequence number and the connection is dropped.
Default: enabled
Values: enabled | disabled
Example: set tcp-syncookies disabled
tcp-fin-timeout: Specifies the number of seconds the system waits for a final FIN packet before forcibly closing the socket. The system uses the FIN packet to disconnect a TCP connection, whether it's idle or not.
Default: 60
Values: Min: 2 / Max: 300
Example: set tcp-fin-timeout 100
Opens the monitors object, through which you create monitoring configurations for tracking usage and TLS statistic threshold violations.
Sets threshold monitors for usage and TLS activity. When the threshold is exceeded, the ME sends a message to the event log and creates an SNMP trap. You can set the interval at which the ME polls the system and compares the current statistics against parameter thresholds.
interval: Specifies the number of minutes the system waits between polls of the specified parameters.
Default: 10
Values: Min: 1 / Max: 60
Example: set interval 50
parameter: Sets the parameter to monitor and the threshold that, when exceeded, results in a message to the event log and an SNMP trap. Re-execute the command to add parameters.
Default: There is no default setting
Values: cpu-usage percentage
memory-usage percentage
kernel-memory-usage percentage
memory-failures failures
tls-connections connections
tls-failures failures
storage-devices device percentage
mos-failures value
syn-cookies cookies
dropped-media-packets packets
sip-parse-errors errors
Example: set parameter cpu-usage 90
Sets the number of troubleshooting web service requests that can be handled by the ME at one time. The object also sets an allowed wait time for pending requests.
concurrent-requests: Specifies the number of concurrent web service troubleshooting requests the system attempts to service. If this threshold is reached, subsequent requests are queued for processing. They remain in the queue until:
They are processed because the queue dropped below the threshold.
They time out because they exceeded the maximum wait time assigned with the concurrent-timeout property.
Default: 2
Values: Min: 1 / Max: 20
Example: set concurrent-request 5
concurrent-timeout: Specifies the maximum amount of time a troubleshooting request waits to be serviced before the system cancels the request.
Default: 2000
Values: Min: 10 / Max: 120000
Example: set concurrent-timeout 5000
Configures the handling of data collection output files.
directory: Specifies where the data collection output files will be stored. While the default directory is sufficient in most cases, if you are collecting the contents of a large database, this property allows you to specify a mount with more available disk space.
Default: /cxc_common/collect
Example: set directory /cxc_common/collect_directory
max-old-files: Specify the maximum number of old files the AA-SBC saves before backups are deleted.
Default: 5
Values: Min: 1 / Max: 50
Example: set max-old-files 25
Enables or disables the default collection parameters. When one of these properties is set to disabled, the corresponding data is not collected.
config: Enable or disable the collection of configuration data.
Default: enabled
Values: enabled disabled
Example: set config disabled
certificates: Enable or disable the collection of certificate data.
Default: enabled
Values: enabled disabled
Example: set certificates disabled
status: Enable or disable the collection of status data.
Default: enabled
Values: enabled disabled
Example: set status disabled
crash-files: Enable or disable the collection of crash file data.
Default: enabled
Values: enabled disabled
Example: set crash-files disabled
log-files: Enable or disable the collection of log file data.
Default: enabled
Values: enabled disabled
Example: set log-files disabled
status-class: Enable or disable the collection of status class data.
Default: enabled
Values: enabled disabled
Example: set status-class disabled
database: Specifies the databases you want to collect. This property is a vector, so you can specify multiple entries. Note: Use this property with caution as it is possible to specify the collection of enormous amounts of data.
Default: There is no default setting
Values: log
spotlite
status
dos
directory
accounting
Example: set database accounting
directory: Specifies any additional directories you want collected. This property is a vector, so you can specify multiple entries.
Note: Use this property with caution as it is possible to specify the collection of enormous amounts of data.
Default: There is no default setting
Example: set directory /cxc_common/data1/dir1
trace-files: Enables or disables the collection of trace files on the ME.
Default: enabled
Values: enabled | disabled
Example: set trace-files disabled
license-files: Enables or disables the collection of license files on the ME.
Default: enabled
Values: enabled | disabled
Example: set license-files disabled
Configures custom collection parameters as well as the default parameters.
config: Enable or disable the collection of configuration data for this collect-group.
Default: enabled
Values: enabled disabled
Example: set config disabled
certificates: Enable or disable the collection of certificate data for this collect-group.
Default: enabled
Values: enabled disabled
Example: set certificates disabled
status: Enable or disable the collection of status data for this collect-group.
Default: enabled
Values: enabled disabled
Example: set status disabled
crash-files: Enable or disable the collection of crash file data for this collect-group.
Default: enabled
Values: enabled disabled
Example: set crash-files disabled
log-files: Enable or disable the collection of log file data for this collect-group.
Default: enabled
Values: enabled disabled
Example: set log-files disabled
status-class: Specifies additional status classes to be collected for this collect-group. This property is a vector, so you can specify multiple entries. In addition, wildcards can be specified as well as the -v property to specify a verbose display in the status output file.
Default: There is no default setting
Example: set status-class location-bindings-rejected -v
database: Specifies the databases you want to collect for this collect-group. This property is a vector, so you can specify multiple entries. Note: Use this property with caution as it is possible to specify the collection of enormous amounts of data.
Default: There is no default setting
Values: log
spotlite
status
dos
directory
accounting
Example: set database accounting
directory: Specifies any additional directories you want collected for this collect-group. This property is a vector, so you can specify multiple entries.
Note: Use this property with caution as it is possible to specify the collection of enormous amounts of data.
Default: There is no default setting
Example: set directory /cxc_common/data1/dir1
trace-files: Enables or disables the collection of trace files on the ME.
Default: enabled
Values: enabled | disabled
Example: set trace-files disabled
license-files: Enables or disables the collection of license files on the ME.
Default: enabled
Values: enabled | disabled
Example: set license-files disabled