Cisco ACNS Software Configuration Guide for Centrally Managed Deployments, Release 5.2
Chapter 18: Monitoring the ACNS Network

Table Of Contents

Monitoring and Troubleshooting the ACNS Network

Monitoring System Status

Device Alarms

Troubleshooting Devices Using the System Status Bar

Using the Content Distribution Manager GUI show Command Tool

Content Alarms

Troubleshooting Content Replication Issues Using the System Status Bar

Monitoring Device Status

Monitoring Device Statistics

Viewing Content Engine Statistics

Viewing Device Group Statistics

Viewing Routing Statistics

Configuring Report Options

Bytes Served Report

Bandwidth Efficiency Gain Report

Streaming Sessions Report

CPU Utilization Report

Monitoring Content Replication Status

Viewing the System-Wide Replication Status by Channel

Viewing the Replication Status for a Specific Channel

Viewing the Detailed Replication Status of Content Items for a Specific Channel

Viewing the Detailed Replication Status of Content Items for a Channel by Device

Viewing the Detailed Replication Status of Content Items Across All Content Engines in a Channel

Viewing the System-Wide Replication Status by Content Engine

Viewing the Replication Status for a Specific Content Engine

Viewing the Detailed Replication Status of Content Items for a Selected Channel by Content Engine

Using CLI Commands for Replication Status

Using the System Message Log

Configuring System Event Logging Using the Content Distribution Manager GUI

About Multiple Hosts for System Logging

Configuring System Event Logging Using CLI Commands

Viewing the System Message Log

Transaction Logging

Understanding Transaction Log Formats

Squid-Style Transaction Logging

Extended Squid Log Format

Apache-Style Transaction Logging

Custom Format Transaction Logging

Transaction Logging and NTLM Authentication

Usage Guidelines for Log Files

Understanding Working Logs

Archive Working Log

Sanitizing Transaction Logs

Exporting Log Files

Exporting Transaction Logs to External FTP Servers

Exporting Transaction Logs to External SFTP Servers

Enabling Transaction Logging with the Content Distribution Manager GUI

Using WMT Transaction Logging

Log Formats Accepted by Windows Media Services 9

Configuring WMT Transaction Logging

Using Real-Time Transaction Logging

Configuring Real-Time Transaction Logging

About Specifying the Transaction Log Entry Type when Logging to a Remote Syslog Host

Monitoring with SNMP

Configuring SNMP General Settings

Configuring SNMP Community Settings

Configuring SNMP Group Settings

Configuring SNMP User Settings

Configuring SNMPv2 View Settings

Configuring SNMP Host Settings

Configuring SNMP Asset Tag Settings

Supported MIBs

Key SNMP CLI Commands

Configuring SNMP Traps Using the CLI


Monitoring and Troubleshooting the ACNS Network


This chapter provides information on monitoring and troubleshooting devices and content replication in the ACNS network, and on using the system message logs, transaction logs, and SNMP.

This chapter contains the following sections:

Monitoring System Status

Monitoring Device Status

Monitoring Device Statistics

Monitoring Content Replication Status

Using the System Message Log

Transaction Logging

Monitoring with SNMP

Monitoring System Status

The ACNS 5.2 Content Distribution Manager GUI displays the system status in a system status bar that is located above the navigation tabs in every window. The system status bar presents the overall device and content health of the system. You can use this feature to monitor devices and content replication in your ACNS network. The system status bar helps you immediately identify any problems on the network, allowing you to act and respond to problems quickly. (See Figure 18-1.)

Figure 18-1 System Status Bar

The system status reporting mechanism uses four alarm lights to identify problems that need to be resolved. Each light represents a different alarm level, as follows:

Green—No alarms (the system is in excellent health)

Yellow—Minor alarms

Orange—Major alarms

Red—Critical alarms

When you roll your mouse over an alarm light in the system status bar, a popup message provides further details about the device or channel status (see Figure 18-2). When you click the alarm light, a troubleshooting window opens (Troubleshooting Devices or Troubleshooting Content), listing the individual devices or channels that need attention.

Figure 18-2 Status Details

When you roll your mouse over an item under the Alarm Information column in the Troubleshooting Devices or Troubleshooting Content window, a contextual popup menu appears. The popup menu provides links to all the diagnostic tools, troubleshooting tools, logs, and monitoring applications for troubleshooting and resolving the problem. Figure 18-3 shows the troubleshooting tools menu for device alarms.

Figure 18-3 Troubleshooting Tools Menu

Device Alarms

Device alarms are associated with device objects and pertain to applications and services running on Content Engines, Content Routers, and Content Distribution Managers. Device alarms are defined by the reporting application or service. Device alarms can also reflect reporting problems between the device and the Content Distribution Manager. (See Table 18-1.)

Table 18-1 Device Alarms for Reporting Problems

Alarm
Alarm Severity
Device Status
Description

Device is offline

Critical

Offline

The device has failed to communicate with the Content Distribution Manager.

Device is pending

Major

Pending

The device status cannot be determined.

Device is inactive

Minor

Inactive

The device has not yet been activated or accepted by the Content Distribution Manager.

Device has lower software version

Minor

Online

The device is not interoperable with the Content Distribution Manager because it has an earlier software version.


Troubleshooting Devices Using the System Status Bar

To troubleshoot a device from the system status bar, follow these steps:


Step 1 In the system status bar, click the Devices alarm light or click the alarm message next to the Devices alarm light panel. The Troubleshooting Devices window pops up as a separate window.

Step 2 In the Alarm Information column, hold your mouse over the alarm message until the Troubleshooting tools menu appears. (See Figure 18-3.)

Step 3 Choose the troubleshooting tool that you want to use and click the link. The link takes you to the appropriate window in the Content Distribution Manager GUI. Table 18-2 describes the tools available for all device alarms.

Table 18-2 Troubleshooting Tools for Device Alarms

Item
Navigation
Description

Get Alarm Description(s)

None

Replaces alarm counts with alarm descriptions

Telnet to Device

Opens a Telnet window

Initiates a Telnet session using the device IP address

View Device Logs

Devices > Monitoring > Logs

Displays system message logs filtered for this device

Edit Device

Device Home

Displays device home window for configuration

Monitor Device

Device Home

Displays device home window for monitoring

Run Show Commands

Devices > Monitoring > Show/Clear Commands > Show Commands

Displays device show command tool



Using the Content Distribution Manager GUI show Command Tool

To use the Content Distribution Manager GUI show command tool, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Devices.

Step 2 Click the Edit icon next to the name of the device for which you want to issue a show command.

Step 3 In the Contents pane, choose Monitoring > Show/Clear Commands and then click Show Commands.

Step 4 Choose a show command from the drop-down list.

Step 5 Enter arguments for the command, if any. (Refer to the Cisco ACNS Software Command Reference, Release 5.x publication for more command information.)

Step 6 Click Submit. A window appears, displaying the show command output for that device.


Content Alarms

Content alarms pertain to content replication problems and are associated with channels. Content alarms are raised by the Content Distribution Manager based on replication status reports. To view the content alarms, click the Content alarm light or click the Channels link next to the alarm light in the status bar. The Troubleshooting Content window pops up. (See Figure 18-4.) Table 18-3 lists the content alarms.

Figure 18-4 Troubleshooting Content—Content Alarms

Table 18-3 Content Alarms for Channel Replication Status

Alarm
Severity
Description

Replication Status is Failed

Critical

The number of Content Engines in the channel that failed to replicate the content is greater than zero.

Replication Status is Pending

Minor

The number of Content Engines in the channel with content replication status unknown is greater than zero.


Troubleshooting Content Replication Issues Using the System Status Bar

To troubleshoot content replication issues from the system status bar, follow these steps:


Step 1 In the system status bar, click the Content alarm light or click the alarm message next to the Content alarm light panel. The Troubleshooting Content window pops up as a separate window.

Step 2 In the Alarm Information column, hold your mouse over the alarm message until the Troubleshooting tools menu appears.

Step 3 Choose the troubleshooting tool that you want to use and click the link. The link takes you to the appropriate window in the Content Distribution Manager GUI. Table 18-4 describes the tools available for all content alarms.

Table 18-4 Troubleshooting Tools for Content Alarms

Item
Navigation
Description

View Replication Status

Content > Channels > Replication Status

Displays second-level replication status for a channel.

Edit Channel

Content > Channels > Definition

Opens the Modifying Channel window.



Monitoring Device Status

The Device Home window provides device and alarm status for individual devices. (See Figure 18-5.)

Figure 18-5 Monitoring Device Status

Monitoring Device Statistics

It is often useful to be able to assess the performance of Content Engines across your network. You can do this using the Content Engine statistics feature in the Content Distribution Manager GUI. The System Home window displays system-wide statistics in a graphical form and enables you to view, at a glance, which Content Engines are online, as well as assess their available resources, the volume of traffic being routed to them, and their performance in serving requests. (See Figure 18-6.)

Figure 18-6 System Home

The information displayed is based on a snapshot of your ACNS network that represents the state of your Content Engines at the end of every two polling periods. You can configure the interval between polls in the Content Distribution Manager GUI (System > System Configuration > System.datafeed.pollRate). The default polling rate is 300 seconds (5 minutes).

The Content Distribution Manager GUI also allows you to view statistics for Content Engines, device groups, and Content Routers in tabular form based on the type of server. (See the next three sections.)

Viewing Content Engine Statistics

To view Content Engine statistics in tabular form, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Statistics.

Step 2 In the Contents pane, click Content Engines, and then choose one of the following submenu options to view the Content Engine statistics for that option:

Cisco Streaming Engine

HTTP

RTSP

WMT

Table 18-5 explains the meaning of each Content Engine statistic presented in the GUI.

Step 3 To print the statistics data, click the Printer icon.

Table 18-5 Content Engine and Device Group Statistics 

Content Engine Property
Description

Cisco Streaming Engine

Bandwidth (bits/sec)

Current bandwidth output by the server in bits per second.

Total Bytes

Total bytes output by the server since it was started.

Total Packets

Total packets output by the server since it was started.

RTSP Connections

Number of clients currently connected over RTSP.

All Connections

Number of clients currently connected since startup.

Updated

Time stamp indicating when the statistics were updated.

HTTP

Requests/Sec

Number of requests per second.

Bytes/Sec

Number of bytes per second.

Request Latency

Average number of seconds per HTTP request. Corresponds to the output from the show statistics http performance EXEC command as the "Seconds / Request Avg."

Hit Rate

Average number of content items per minute successfully served from the cache of the Content Engine or from all the Content Engines in the channel or virtual ACNS network during the preceding quarter hour.

Updated

Time stamp indicating when the statistics were updated.

RTSP

Requests

Number of requests. Corresponds to the output from the show statistics rtsp proxy media-real savings command.

Bytes

Number of bytes. Corresponds to the output from the show statistics rtsp proxy media-real savings command.

Hit Rate

Average number of content items per minute successfully served from the cache of the Content Engine or from all the Content Engines in the channel or virtual ACNS network during the preceding quarter hour.

Updated

Time stamp indicating when the statistics were updated.

WMT

Concurrent Requests

Number of simultaneous requests the WMT proxy/server is serving at the current time.

Kbits/Sec

Number of kilobits per second.

Cache Hit Rate

Average number of content items per minute successfully served from the cache of the Content Engine or from all the Content Engines in the channel or virtual ACNS network during the preceding quarter hour.

Updated

Time stamp indicating when the statistics were updated.



Viewing Device Group Statistics

To view device group statistics for your ACNS network, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Statistics.

Step 2 In the Contents pane, click Device Groups, and then choose one of the following submenu options to view the Content Engine statistics for that option:

Cisco Streaming Engine

HTTP

RTSP

WMT

Statistics for device groups are the same as for Content Engines. See Table 18-5 for an explanation of the meaning of each device group statistic presented in the GUI.

Step 3 To print the statistics data, click the Printer icon.


Viewing Routing Statistics

To view routing statistics for Content Routers and routing Content Engines, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Statistics.

Step 2 In the Contents pane, click Routing Statistics, and then choose one of the following submenu options to view the Content Engine statistics for that option:

Routing Requests

Routing Redirects

Table 18-6 explains the meaning of each Content Router statistic presented in the GUI.

Table 18-6 Content Router Statistics 

Content Router Property
Description

Routing Requests

Total Requests

Total number of content requests received by simplified hybrid routing.

Http Requests

Number of ASX and traditional HTTP web requests received.

Rtsp Requests

Number of RTSP requests received.

Updated

Time stamp indicating when the statistics were updated.

Routing Redirects

Total Requests

Total number of content requests received by simplified hybrid routing.

Reqs Redirected

Total number of content requests received by simplified hybrid routing that were redirected.

Reqs Not Directed

Total number of content requests received by simplified hybrid routing that were not redirected.

Updated

Time stamp indicating when the statistics were updated.


Step 3 To print the statistics data, click the Printer icon.


You can also view additional content routing statistics through the Content Distribution Manager GUI using the show command tool (see the "Using the Content Distribution Manager GUI show Command Tool" section). The show commands are further documented in the Cisco ACNS Software Command Reference, Release 5.2 publication.

Configuring Report Options

The Content Distribution manager GUI provides four different monitoring reports. Report data is available in both tabular and graphical form.

Bytes Served Report

The Bytes Served report allows you to view Content Engine usage over time, and to identify usage trends. To view the Bytes Served report and configure the reporting options, follow these steps:


Step 1 Choose Devices > Devices.

Step 2 Click the Edit icon for the Content Engine that you want to view or configure.

Step 3 In the Contents pane, choose Monitoring > Statistics > Bytes Served. The Bytes Served Report for Content Engine window appears, displaying the statistical data.

Step 4 To change the report parameters and display characteristics, modify the report options as desired.

Step 5 Click Update to reset the report parameters.


Bandwidth Efficiency Gain Report

After a Content Engine has been in use for some time and has collected statistics, the bandwidth efficiency gain report can demonstrate the value of the Content Engine in terms of bandwidth savings.

To view the Bandwidth Efficiency Gain report and configure the reporting options, follow these steps:


Step 1 Choose Devices > Devices.

Step 2 Click the Edit icon for the Content Engine that you want to view or configure.

Step 3 In the Contents pane, choose Monitoring > Statistics > Bandwidth Efficiency Gain. The Bandwidth Efficiency Gain Report for Content Engine window appears, displaying the statistical data.

Step 4 To change the report parameters and display characteristics, modify the report options as desired.

Step 5 Click Update to reset the report parameters.


Streaming Sessions Report

The Streaming Sessions report lists the total number of streaming sessions in progress at the collection time. It allows you to plan for future hardware provisioning and licensing requirements based on utilization data.

To view the Streaming Sessions report and configure the reporting options, follow these steps:


Step 1 Choose Devices > Devices.

Step 2 Click the Edit icon for the Content Engine that you want to view or configure.

Step 3 In the Contents pane, choose Monitoring > Statistics > Streaming Sessions. The Streaming Sessions Report for Content Engine window appears, displaying the statistical data.

Step 4 To change the report parameters and display characteristics, modify the report options as desired.

Step 5 Click Update to reset the report parameters.


CPU Utilization Report

To view the CPU Utilization report and configure the reporting options, follow these steps:


Step 1 Choose Devices > Devices.

Step 2 Click the Edit icon for the Content Engine that you want to view or configure.

Step 3 In the Contents pane, choose Monitoring > Statistics > CPU Utilization. The CPU Utilization Report for Content Engine window appears, displaying the statistical data.

Step 4 To change the report parameters and display characteristics, modify the report options as desired.

Step 5 Click Update to reset the report parameters.


Monitoring Content Replication Status

The replication status feature allows you to view the status of content replication using the Content Distribution Manager GUI, output from CLI commands, or an API file.

In the Content Distribution Manager GUI, replication status is provided under the Content tab and the Devices tab. You can view the replication status by channel or by device. The Content Distribution Manager GUI also allows you to obtain a detailed view for a specific Content Engine or channel. You can also view detailed replication status for a particular content item in a channel.

Under the Content tab, you can obtain the following views:

Viewing the System-Wide Replication Status by Channel

Viewing the Replication Status for a Specific Channel

Viewing the Detailed Replication Status of Content Items for a Specific Channel

Viewing the Detailed Replication Status of Content Items for a Channel by Device

Viewing the Detailed Replication Status of Content Items Across All Content Engines in a Channel

Under the Devices tab, you can obtain the following views:

Viewing the System-Wide Replication Status by Content Engine

Viewing the Replication Status for a Specific Content Engine

Viewing the Detailed Replication Status of Content Items for a Selected Channel by Content Engine


Note Individual Content Engines report their known status, but the Content Distribution Manager has a global view of the channel and may modify the state that the Content Engine reports. If the root Content Engine is processing an updated manifest file or has found new content that a receiver Content Engine is unaware of, the receiver Content Engine reports the replication status as "Completed", whereas the Content Distribution Manager reports the status as "Update Pending." If the root Content Engine fails to update files, the status of all the receiver Content Engines is reported as "In Process."


Viewing the System-Wide Replication Status by Channel

The Channels window lists all channels on the system and displays the replication status information for each channel. This display summarizes the replication status of all Content Engines associated with a specific channel in a given state.

To view system-wide replication status for each channel, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Content > Channels to display the Channels window. (See Figure 18-7.)

Figure 18-7 Channels Window—System-Wide Replication Status by Channel

Step 2 View the replication status information for each channel. Table 18-7 describes the status information that is displayed in this window.

Table 18-7 System-Wide Replication Status by Channel—Channels Window 

Column Heading
Description

Channel

Name of the channel.

Type

Type of channel. The channel types are Live and Content.

Website

Name of the website assigned to the channel.

Status

Graphical display indicating acquisition, replication, and device errors. Status lights represent the highest level of errors encountered:

Green—No errors encountered

Yellow—Only minor errors encountered

Red—At least one critical error encountered, such as an acquisition failure, a content replication failure, or a failed or nonresponding Content Engine

For details of the errors, click the status light for a particular channel, which takes you to the Replication Status for Channel window. See Table 18-8 for a description of status errors and their corresponding status lights.

State

State of the channel. States are reported for the root Content Engine and for receiver Content Engines. See Table 18-9 for a definition of the different channel states.

The state is also a link to the Replication Status for Channel window that provides a more detailed view of the replication status for the channel. (See Figure 18-9.)

Manifest State

State of the manifest file. States reported are as follows:

Fetching—The manifest file is being fetched.

Fail Fetching—The manifest file has failed to be fetched.

Parsing—The manifest file is being parsed.

Fail Parsing—The manifest file has failed to be parsed.

Completed—The manifest file was successfully fetched and parsed.

No Status Reported—Root Content Engine is in a Pending or Disabled state.


Table 18-8 Channel Status Errors 

Status Light
Error
Description

Yellow

Manifest retrieval error

The root Content Engine cannot retrieve the manifest file for 1 or 2 consecutive attempts.

Red

Manifest retrieval error

The root Content Engine cannot retrieve the manifest file for 3 consecutive attempts.

Red

Manifest syntax error

The root Content Engine fails to parse the manifest file.

Red

Crawl job processing error

The root Content Engine encounters problems while crawling for content.

Red

Acquisition or content replication error

The Content Engine fails to obtain the content.

Red

Disk quota exceeded error

The Content Engine cannot store or process the content because there is no more disk space available.

Yellow

Replication status update error

Content replication failed for 1 or 2 consecutive attempts.

Red

Replication status update error

Content replication failed for 3 or more consecutive attempts.

Red

Content Engine unreachable error

The Content Engine is offline or the Content Engine has not responded to replication status requests for 3 consecutive polling periods.

Red

Root Content Engine failover

The root Content Engine has failed over to a temporary root Content Engine. Receiver Content Engines have not identified a valid root Content Engine.

Red

Receiver Content Engine device or channel error

Receiver Content Engine is not reporting replication status or any other content replication problem.


Table 18-9 Channel States in Replication Status for Channel Window

State
Description

Completed

All receiver Content Engines are in the Completed state, and the root Content Engine is either in the Completed, Re-checking, Retrieving Manifest, or Processing Manifest state. (See Table 18-12 for a description of Content Engine states.)

When the root Content Engine in the Re-checking state determines that new content needs to be acquired, the channel state changes to In Process.

In Process

In Process can mean:

The root Content Engine is in the Retrieving Manifest, Processing Manifest, Acquiring Content, or Re-checking Content state.

Any receiver Content Engine is in the Pending Update, Replicating, or Recovering from Failure state.

The root Content Engine has failed and receiver Content Engines are still reporting status.

Failed

Failed can mean:

An acquisition or content replication error has occurred. (See Table 18-8.)

A Content Engine has gone offline or has not reported status in 3 consecutive polling periods.

The channel has more than 1 root Content Engine

The channel has no root Content Engine, but has receiver Content Engines reporting replication status.



Viewing the Replication Status for a Specific Channel

To view the replication status for a particular channel, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Content > Channels. When you roll your mouse over an alarm light in the Status column for a particular channel, the content replication status for that channel is displayed. (See Figure 18-8.)

Figure 18-8 Channels Window

Step 2 Click an alarm light in the Status column or a link in the State column. The Replication Status for Channel window appears. This window displays the replication status for the particular channel chosen. (See Figure 18-9.)

Table 18-10 describes the acquisition status information that is displayed in this window, and Table 18-11 describes the replication status information for individual devices that is displayed in this window.


Note Alternatively, you can choose Channels > Channels, click the Edit icon next to the channel for which you want to view the replication status, and choose Replication Status from the Contents pane.


Figure 18-9 Replication Status for Channel Window

This window also allows you to do the following:

See a detailed view of replication status using search criteria. (See the "Viewing the Detailed Replication Status of Content Items for a Specific Channel" procedure.)

Query the replication status of content items (by pattern) for a selected Content Engine in the channel. (See the "Viewing the Detailed Replication Status of Content Items for a Channel by Device" procedure.)

Table 18-10 Acquisition Status for a Channel 

Field
Description

User Selected Root CE

Name of the user-selected root Content Engine.

Current Root CE

Name of the current root Content Engine. The current root Content Engine will be the same as the user-selected root Content Engine as long as the user-selected root is active; if it fails for any reason, the temporary root Content Engine becomes the current root Content Engine.

Disk Quota Used

Amount of available disk space used for the channel.

Status

State of the root Content Engine. For a description of root Content Engine states, see Table 18-12.

Manifest Last Modified Time

Time when the manifest file was last saved, as recorded on the Content Engine.

Manifest Last Checked Time

Time when the root Content Engine last checked the manifest file for changes.


Table 18-11 Replication Status for Devices Assigned to a Channel 

Field
Description

Device

Name of the Content Engine assigned to the channel.

Type

Type of Content Engine: root, receiver, or temporary root.

Status

Graphical display indicating acquisition, replication, and device errors. Status lights represent the highest level of errors encountered:

Green—No errors encountered

Yellow—Only minor errors encountered

Red—At least one critical error encountered, such as an acquisition failure, a content replication failure, or a failed or nonresponding Content Engine

For details of the errors, click the status light. A dialog box pops up, listing the errors. See Table 18-8 for a description of status errors and their corresponding status lights.

State

State of either the root Content Engine or receiver Content Engines. See Table 18-12 for a description of Content Engine states.

Last Report Time

Time when the last report from the Content Engine was received by the Content Distribution Manager. This time stamp uses the Content Distribution Manager clock.

File Count

Completed

Number of files that the Content Engine has successfully acquired or received.

In Process

Number of new files to be acquired or replicated. Includes only files for which no acquisition or replication attempts have previously been made.

Failed

For the root Content Engine: Number of files that failed to be acquired in at least 1 attempt.

For receiver Content Engines: Number of files that failed to be replicated in at least 1 attempt.

Note The failure count for the receiver Content Engine has no relationship to the failure count for the root Content Engine. If the root Content Engine fails to replicate an item, the receiver counts this item as "In Process."

Total

Total number of Completed, In Process, and Failed files.


Table 18-12 Content Engine States

State
Description

Root Content Engine

Retrieving Manifest

The root Content Engine is retrieving the manifest file from the origin server or rechecking the manifest file for changes.

Processing Manifest

The root Content Engine has retrieved the manifest file and is parsing it.

Acquiring Content

The root Content Engine has processed the manifest file and is crawling or fetching content.

Re-checking Content

The root Content Engine is checking the content or crawl job freshness.

No Status Reported

No Status Reported can mean:

The root Content Engine is unreachable for 3 consecutive polling periods.

The root Content Engine is offline.

The Content Distribution Manager has recently restarted and has not yet received a report from the root Content Engine.

Completed

The root Content Engine is not in the Retrieving, Processing, Acquiring Re-checking, or Unreachable state.

Receiver Content Engine

Pending Update from Root

The receiver Content Engine is not synchronized with the root Content Engine.

Replicating

The receiver Content Engine is synchronized with the root Content Engine and is replicating content.

Completed

The receiver Content Engine has finished replicating all the content with no errors.

Recovering from Failure

The receiver Content Engine has not identified the root Content Engine. This state occurs during a failover from the root Content Engine to a temporary root Content Engine.

No Status Reported

No Status Reported can mean:

The receiver Content Engine is unreachable for 3 consecutive polling periods.

The receiver Content Engine is offline.

The Content Distribution Manager has recently restarted and has not yet received a report from the receiver Content Engine.



Viewing the Detailed Replication Status of Content Items for a Specific Channel

To view the detailed replication status of content items for a channel, follow these steps:


Step 1 Choose Content > Channels. The Channels window appears.

Step 2 Click the Edit icon next to the channel for which you want to view the replication status.

Step 3 In the Contents pane, choose Replication Status. The Replication Status for Channel window appears.

Step 4 In the View Detailed Replication Status section (see Figure 18-9), enter a string in the Get Detailed Status using Search Criteria field. Use an asterisk (*) to match one or more characters, or a question mark (?) to match only a single character.

The criteria are matched against the relative cdn-url attribute specified in the <item> tag in the manifest file. It is recommended that you start the search criteria by specifying wildcards such as *.htm or *clip.mpeg.

Step 5 Click the Go button. The Replication Items window appears, displaying replication status for content items for a specific channel. (See Figure 18-10.) Table 18-13 describes the information that is displayed in the window.

Figure 18-10 Replication Status for Content Items for a Specific Channel

Table 18-13 Replication Status of Items for a Channel

Column Heading
Description

Url

URL of the origin web server that stores the website content.

Size

Size of the file to be acquired or crawled.

Status

Status of replication of content in the channel. The status will be shown as Complete if the replication is complete on all Content Engines assigned to the channel.

Replied CEs

Number of Content Engines that have replicated this item.

Playtime

Duration of playback of the file.

Modification Time

Time stamp of the earliest update for that channel from an active Content Engine.



Viewing the Detailed Replication Status of Content Items for a Channel by Device

Queries to determine the detailed replication status of a content item trigger extensive CPU cycles and high consumption of memory, because all the Content Engines assigned to a channel need to be polled, and the retrieved replication status is cached in the memory of the Content Distribution Manager. This results in performance degradation. To optimize the use of memory resources without compromising the need to obtain detailed replication status of a particular content item, you can choose a Content Engine assigned to a channel and generate a query.

To view the detailed replication status for a channel by device, follow these steps:


Step 1 Choose Content > Channels. The Channels window appears.

Step 2 Click the Edit icon next to the channel that you want to view.

Step 3 In the Contents pane, choose Replication Status. The Replication Status for Channel window appears.

Step 4 In the Devices Assigned to Channel section (see Figure 18-9), click the radio button next to the name of the device that you want to view.

Step 5 In the View Detailed Replication Status for Channel by Device section, do the following:

a. Choose content items (all, replicated, or nonreplicated) from the Get drop-down list.

b. In the Search Criteria for Selected Device field, enter a string that specifies the type of content items that you want displayed.

c. Click the Go button.

For example, enter Get replicated content items using Search Criteria *.bin for selected Device.


Note Use an asterisk (*) to match one or more characters, or a question mark (?) to match only a single character.


The Replication Items window for the selected device appears. (See Figure 18-11.) Table 18-14 describes the fields displayed in this window.

Figure 18-11 Replication Items for a Selected Device

Table 18-14 Replication Status of Items for a Channel by Device

Column Heading
Description

Url

URL of the origin web server that stores the website content.

Size

Size of the file to be acquired or crawled.

Status

Status of replication of content for the selected Content Engine.

Playtime

Duration of playback of the file.

Modification Time

Time stamp in Greenwich mean time (GMT) of the latest update to the content item as recorded on the origin server.



Note When you click the Force replication information refresh icon in the taskbar of the Replication Items window for the selected device, the system displays a dialog box asking you to confirm whether you want to refetch the information from Content Engines assigned to this channel. Click OK to continue with the refresh process. You are notified that the request has been queued and asked to check back later.


Step 6 To refine your search from this window, do the following:

a. Make a choice from the Get drop-down list.

b. Enter a search string in the Search Criteria field.

c. Click the Go button.

Step 7 To return to the Replication Status for Channel window click the straight blue Back arrow in the Content Distribution Manager GUI taskbar (not the Back button for your browser).


Viewing the Detailed Replication Status of Content Items Across All Content Engines in a Channel

You can choose the URL of the origin server and request a detailed replication status of content items across all Content Engines to trigger an aggregated replication status request. The detailed item replication status window shows a time stamp indicating the time in Greenwich mean time (GMT) at which the replication status was last cached to provide information about the freshness of the detailed content replication status.

To view the detailed replication status of an item across all Content Engines in a channel, follow these steps:


Step 1 Choose Content > Channels. The Channels window appears.

Step 2 Click the Edit icon next to the channel for which you want to view the replication status.

Step 3 In the Contents pane, choose Replication Status. The Replication Status for Channel window appears.

Step 4 In the View Detailed Replication Status section (see Figure 18-9), enter a string in the Get Detailed Status using Search Criteria field. Use an asterisk (*) to match one or more characters, or a question mark (?) to match only a single character.

The criteria are matched against the relative cdn-url attribute specified in the <item> tag in the manifest file. We recommend that you start the search criteria by specifying wildcards such as *.htm or *clip.mpeg.

Step 5 Click the Go button. The Replication Items window appears, displaying replication status for content items for a specific channel. (See Figure 18-10.)

Step 6 Click the View icon next to the URL that you want to view. The Replication Item window appears, displaying the replication status of the content item for each Content Engine in the channel. (See Figure 18-12.) Table 18-15 describes the fields in this window.

Figure 18-12 Replication Status of the Content Item for All Content Engines in the Channel


Note The Replication Item window is specifically designed to limit listings to 5000 objects for scalability reasons. These are system limits and not specifically enforced for replication status reporting.


Table 18-15 Replication Status of an Item for All Content Engines in a Channel

Column Heading
Description

CE

Name of the Content Engine to which the item has been replicated.

Size

Size of the file to be acquired or crawled.

Status

Status of replication of content in the channel. Status is shown as Complete if replication is complete on all Content Engines assigned to the channel.

Playtime

Duration of playback of the file.

Modification Time

Time stamp of the latest update for the content item as recorded on the origin web server.


Step 7 To return to the Replication Status for Channel window, click the straight blue Back arrow in the Content Distribution Manager GUI taskbar (not the Back button for your browser).


Viewing the System-Wide Replication Status by Content Engine

To view the system-wide replication status by device, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Statistics > Replication Status. The Device Replication Status window appears.

This window summarizes the replication status of all channels associated with a specific Content Engine in a given state. (See Figure 18-13.)

Figure 18-13 Device Replication Status Window

Step 2 View the replication status information for each device. Table 18-16 describes the status information that is displayed in this window.

Table 18-16 Device Replication Status Window

Column Heading
Description

Device

Name of the Content Engine.

Status

Graphical display indicating acquisition, replication, and device errors. Status lights represent the highest level of errors encountered:

Green—No errors encountered

Yellow—Only minor errors encountered

Red—At least one critical error encountered, such as an acquisition failure, a content replication failure, or a failed or nonresponding Content Engine

See Table 18-8 for a description of status errors and their corresponding status lights.

Channel Count

Number of channels reporting Content Engines in a particular state. (See Table 18-12 for a description of Content Engine states.)

Completed

Number of channels reporting this Content Engine in a Completed state.

In Process

In Process can mean:

Number of channels reporting this Content Engine (as a root Content Engine) in the Retrieving Manifest, Processing Manifest, Acquiring Content, or Re-checking Content state.

Number of channels reporting this Content Engine (as a receiver Content Engine) in the Pending Update, Replicating, or Recovering from Failure state.

Failed

Number of channels reporting this Content Engine in the Failed or Failed Update state.

Unknown

Number of channels reporting this Content Engine in the No Status Reported state.


Step 3 To view the replication status of individual channels assigned to a particular Content Engine, proceed to the next section, "Viewing the Replication Status for a Specific Content Engine."


Viewing the Replication Status for a Specific Content Engine

To view the replication status for a particular Content Engine, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine that you want to view.

Step 3 In the Contents pane, choose Monitoring > Replication Status. The Replication Status for Device window appears.

The Replication Status for Device window displays the replication status of individual channels assigned to a particular Content Engine. You can filter the information by channels or by any of the other categories displayed in this window. (See Figure 18-14.)

Table 18-11 describes the status information that is displayed in this window with the exception that the first column in this window displays the names of the channels to which the Content Engine is assigned rather than the names of the devices in the channel, as described in Table 18-11.

Figure 18-14 Replication Status for Device Window

Step 4 To view the Content Engine forwarder path for a selected channel, click the View icon next to the name of the channel. To return to the Replication Status for Device window, click Replication Status in the Contents pane.

Step 5 To view replication details for the selected channel, see the next section, "Viewing the Detailed Replication Status of Content Items for a Selected Channel by Content Engine."


Viewing the Detailed Replication Status of Content Items for a Selected Channel by Content Engine

A request for a detailed replication status triggers an aggregated replication status update request. This ensures that the cache status is refreshed on both the Content Engine and the Content Distribution Manager simultaneously.

To view the status of replication of content items for a selected channel by Content Engine, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next the name of the Content Engine that you want to view.

Step 3 In the Contents pane, choose Monitoring > Replication Status. The Replication Status for Device window appears. (See Figure 18-14.)

Step 4 Click the radio button next to a channel name to view replication details for the selected channel.

Step 5 Choose the type of items to display from the Get drop-down list (all, replicated, or non replicated).

Step 6 Enter a regular expression (such as *.html, *.mpg, *.jpg, or *.*) in the Search Criteria for Selected Device field. Use an asterisk (*) to match one or more characters, and a question mark (?) to match exactly one character.

Step 7 Click the Go button. The Replication Items - Channel: Content Engine window appears. (See Figure 18-15.) Table 18-17 describes the fields displayed in this window.


Note The Replication Items - Channel: Content Engine window is specifically designed to limit listings to 5000 objects for scalability reasons. These are system limits and not specifically enforced for replication status reporting.


Figure 18-15 Replication Items - Channel: Content Engine Window

Table 18-17 Replication Status of Items for Content Engines in a Selected Channel 

Column Heading
Description

URL

URL of the origin web server that stores the website content.

Size

Size of the file to be acquired or crawled.

Status

Status of replication of content from the root Content Engine.

Playtime

Duration of playback of the file.

Modification Time

Time stamp of the earliest update for that channel from an active Content Engine.


Step 8 To further qualify your search, change the item type from the drop down list, if you wish, or specify another file type (such as *.html, *.mpg, or *.jpg) in the Search Criteria field. Click the Go button to retrieve the specified items.

Step 9 To forcibly refetch the latest content replication information, click the Force replication information refresh icon in the taskbar. You are asked to confirm whether you wish to refetch the information from the Content Engine assigned to the particular channel.

Step 10 Click OK to continue with the refresh process. You are notified that your request has been sent and prompted to check back after a few minutes.

Step 11 To return to the Replication Status for Device window, click the straight blue Back button in the taskbar.


Using CLI Commands for Replication Status

You can use the Content Engine CLI to view the content replication status for a channel by using the following commands:

Use the show distribution channel channel-id command to see if there is an unfinished job listed for the channel. The last line in this example shows that there are no unfinished jobs.

ContentEngine# show distribution channel channel-id 158
                        Channel ID:                  158
                      Channel Name:                sz300
                      Website Name:             website3
                  Channel Priority:                  500
          ID of Configured Root CE:                  140
        Name of Configured Root CE:               sz590b
          IP of Configured Root CE:           10.1.1.170
                    This CE's Role:        Not a Root CE
                    In Full Reload:                   No
                   Mcast Receiving:                   No
                     Mcast Sending:                   No
             Metadata-Forwarder ID:                  140
           Metadata-Forwarder Name:               sz590b
             Metadata-Forwarder IP:           10.1.1.170
                Ucast-Forwarder ID:                  140
              Ucast-Forwarder Name:               sz590b
                Ucast-Forwarder IP:           10.1.1.170
                Last gen-id Switch:                Never
           ID of Effective Root CE:                  140
               Current root-ce-uid:           1042665163
          Current low-water-marker:                    1
                Current max-gen-id:                  300
            Current max-del-gen-id:                    0
                Has Unfinished Job:                   No

Note The Has Unfinished Job line is only available if the Content Engine is not a root Content Engine. It is only available on a receiver Content Engine.


Use the show statistics replication channels command to view the replication status of the channel. The show statistics replication commands display the progressive file count status during acquisition and replication.

The following sample output is from the Content Distribution Manager show statistics replication command.

CDM# show statistics replication channels selected-channel ws1 ch1c
Channel: ch1c
State: Completed
Status: Green
User Selected Root CE: ce-s4
Current Root CE: ce-s4
Receiver CEs Completed: 1
Receiver CEs In Progress: 0
Receiver CEs Failed: 0
Receiver CEs Not Responding: 0

Displaying Device Acquisition Replication Status
Device: ce-s4 (CE ID: 92)
Channel: ch1c (Channel ID: 246)
Website: ws1
Type: Root
State: Completed
Status: Green
Completed: 1
To Do: 0
Failed: 0
Total: 1
Last Report Time: Mon Apr 19 20:37:43 GMT 2004
Disk Quota Used: 281.171 KB
Manifest Last Modified: Mon Sep 29 14:59:01 GMT 2003
Manifest Last Check: Wed Apr 14 18:19:12 GMT 2004
Manifest State: Completed

Displaying Device Distribution Replication Status
Device: CE2 (CE ID: 97)
Channel: ch1c (Channel ID: 246)
Website: ws1
Type: Receiver
State: Completed
Status: Green
Completed: 1
To Do: 0
Failed: 0
Total: 1
Last Report Time: Mon Apr 19 20:32:16 GMT 2004

Detailed Error for CE2

The following sample output shows the replication status for the Content Engines of a selected channel.

CDM# show statistics replication content-engines selected-channel ws1 ch1c
Displaying Device Acquisition Replication Status
Device: ce-s4 (CE ID: 92)
Channel: ch1c (Channel ID: 246)
Website: ws1
Type: Root
State: Completed
Status: Green
Completed: 1
To Do: 0
Failed: 0
Total: 1
Last Report Time: Mon Apr 19 20:42:38 GMT 2004
Disk Quota Used: 281.171 KB
Manifest Last Modified: Mon Sep 29 14:59:01 GMT 2003
Manifest Last Check: Wed Apr 14 18:19:12 GMT 2004
Manifest State: Completed

Displaying Device Distribution Replication Status
Device: CE2 (CE ID: 97)
Channel: ch1c (Channel ID: 246)
Website: ws1
Type: Receiver
State: Completed
Status: Green
Completed: 1
To Do: 0
Failed: 0
Total: 1
Last Report Time: Mon Apr 19 20:42:12 GMT 2004

Detailed Error for CE2

The following sample output is from the Content Engine show statistics replication command.

ContentEngine# show statistics replication channels selected-channel ws1 ch1c
Displaying Device Acquisition Replication Status
Device: ce-s4 (CE ID: 92)
Channel: 5001Item (Channel ID: 412)
Website: ws1
Type: Root
State: Re-checking Content
Status: Green
Completed: 5001
To Do: 0
Failed: 0
Total: 5001
Last Report Time: Mon May 03 14:09:45 GMT 2004
Disk Quota Used: 1.340 GB
Manifest Last Modified: Wed Dec 18 15:15:49 GMT 2002
Manifest Last Check: Thu Apr 29 12:02:45 GMT 2004
Manifest State: Completed

Displaying Device Acquisition Replication Status
Device: ce-s4 (CE ID: 92)
Channel: syntaxError (Channel ID: 280)
Website: ws1
Type: Root
State: Processing Manifest
Status: Red
Completed: 0
To Do: 0
Failed: 0
Total: 0
Last Report Time: Mon May 03 14:09:45 GMT 2004
Disk Quota Used: 0 Bytes
Manifest Last Modified: Thu Oct 03 11:00:19 GMT 2002
Manifest Last Check: Mon May 03 14:08:13 GMT 2004
Manifest Error: Syntax Error: Parser Error at (line 5, char 35): Datatype error: 
Type:InvalidDatatyp
eValueException, Message:The unary operation node had a binary node type.
Manifest State: Fail Parsing Manifest
7.3.4.2	Get selected channel
CE#sh statistics replication channels selected-channel ws1 ch1c
Displaying Device Acquisition Replication Status
Device: ce-s4 (CE ID: 92)
Channel: ch1c (Channel ID: 246)
Website: ws1
Type: Root
State: Completed
Status: Green
Completed: 1
To Do: 0
Failed: 0
Total: 1
Last Report Time: Mon May 03 14:08:50 GMT 2004
Disk Quota Used: 281.171 KB
Manifest Last Modified: Mon Sep 29 14:59:01 GMT 2003
Manifest Last Check: Wed Apr 14 18:19:12 GMT 2004
Manifest State: Completed

Using the System Message Log

Use the ACNS system logging feature to set specific parameters for the system log file (syslog). This file contains authentication entries, privilege level settings, and administrative details. System logging is always enabled. The system log file is located on the system file system (sysfs) partition as /local1/syslog.txt.

You can use either of the following methods to configure the Content Engine to send varying levels of event messages to disk, console, or host.

Content Distribution Manager GUI, as described in the "Configuring System Event Logging Using the Content Distribution Manager GUI" section

Content Engine CLI, as described in the "Configuring System Event Logging Using CLI Commands" section

Configuring System Event Logging Using the Content Distribution Manager GUI

To enable system logging, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Devices.

Step 2 Click the Edit icon next to the Content Engine for which you want to enable system logging. The Contents pane appears on the left.

Step 3 From the Contents pane, choose General Settings > Notification and Tracking > System Logs. The System Log Settings for Content Engine window appears. (See Figure 18-16.)

Figure 18-16 Syslog Settings Window

Step 4 Under the System Log Settings heading, check the Enable check box to enable system logging.

Step 5 Choose the appropriate facility from the Facility drop-down list.

Step 6 Click Submit to save the settings.


You can enable sending syslog files to the console, disk, or a host.

To enable syslog files to be sent to the console, follow these steps under Console Settings:


Step 1 Check the Enable check box to enable sending syslog files to the console.

Step 2 From the Priority drop-down list, choose the severity level of the message that should be sent to the specified remote syslog host. The default priority-code is "warning" (level 4). Each syslog host is capable of receiving a different level of event messages. (See Table 18-19 for a list of priority levels.)

Step 3 Click Submit to save the settings.


To enable syslog files to be sent to disk, follow these steps under Disk Settings:


Step 1 Check the Enable Disk Settings check box to enable sending syslog files to disk.

Step 2 In the File Name field, enter a path and a filename where the syslog files will be stored on disk.

Step 3 From the Priority drop-down list, choose the severity level of the message that should be sent to the specified remote syslog host. The default priority-code is "warning" (level 4). Each syslog host is capable of receiving a different level of event messages. (See Table 18-19 for a list of priority levels.)

Step 4 In the Recycle field, specify the size of the syslog file (in bytes) that can be recycled when it is stored on disk. The default value of the file size is 10000000.

Whenever the current log file size surpasses the recycle size, the log file is rotated. (The default recycle size for the log file is 10,000,000 bytes.) The log file cycles through at most five rotations, and each rotation is saved as log_file_name.[1-5] under the same directory as the original log.

The rotated log file is configured in the File Name field (or using the logging disk filename command).

Step 5 Click Submit to save the settings.


To enable syslog files to be sent to a host, follow these steps under Host Settings:


Step 1 Check the Enable Host Settings check box to enable sending syslog files to a host. You can configure up to four hosts to which syslog messages can be sent. (See the next section, "About Multiple Hosts for System Logging.")

Step 2 Enter a host name or IP address of the remote syslog host in the Hostname field. Specify up to three more remote syslog hosts in the Hostname fields 2 through 4. You must specify at least one host name if you have enabled system logging to a host.

Step 3 From the Priority drop-down list, choose the severity level of the message that should be sent to the specified remote syslog host. The default priority-code is "warning" (level 4). Each syslog host is capable of receiving a different level of event messages. (See Table 18-19 for a list of priority levels.)

Step 4 In the Port field, specify the destination port on the remote host to which the Content Engine should send the message. The default port number is 514.

Step 5 In the Rate Limit field, specify the number of messages that are allowed to be sent to the remote syslog host per second. To limit bandwidth and other resource consumption, messages to the remote syslog host can be rate limited. If this limit is exceeded, the specified remote syslog host drops the messages. There is no default rate limit, and by default all syslog messages are sent to all of the configured syslog hosts.

Step 6 Click Submit to save the settings.


About Multiple Hosts for System Logging

Each syslog host can receive different priority levels of syslog messages. Therefore, you can configure different syslog hosts with a different syslog message priority code to enable the Content Engine to send varying levels of syslog messages to the four external syslog hosts. For example, the Content Engine can be configured to send messages that have a priority code of "error" (level 3) to the remote syslog host that has an IP address of 172.31.2.160 and messages that have a priority code of "warning" (level 4) to the remote syslog host that has an IP address of 172.31.2.161.

However, if you want to achieve syslog host redundancy or failover to a different syslog host, you must configure multiple syslog hosts on the Content Engine and assign the same priority code to each configured syslog host (for example, assigning a priority code of "critical" (level 2) to sylog host 1, sylog host 2, and syslog host 3).

In addition to configuring up to four logging hosts, you can also configure the following for multiple syslog hosts:

A port number different from the default port number, 514, on the Content Engine to send syslog messages to a logging host.

A rate limit for the syslog messages, which limits the rate at which messages are sent to the remote syslog server (messages per second) to control the amount of bandwidth used by syslog messages.

Configuring System Event Logging Using CLI Commands

Use the logging command to set specific parameters for the system log file (syslog). This file contains authentication entries, privilege level settings, and administrative details. System logging is always enabled. The system log file is located in the system file system (sysfs) storage area as /local1/syslog.txt.

Logging can be configured to send messages to the console, to disk, or to an external syslog host. See Table 18-18 for a list of the key system logging parameters, descriptions, and CLI commands.

Table 18-18 System Logging Parameter Settings 

GUI Parameter
Function
CLI Command

Host Server

IP address or host name of the host that receives syslog messages from the device group.

logging host hostname or ip-address

Console

Enables sending syslog files to the console.

logging console enable

Disk

Enables sending syslog files to disk.

logging disk enable

Priority

Determines priority level when system logging is enabled to disk, console, or host.

logging disk priority, logging console priority, logging host priority

Syslog file

Path of the syslog file on the hard drive.

logging disk filename filename

Recycle

Rewrites the syslog file when it surpasses the specified recycle size.

logging recycle size


Logging can be configured to send various levels of messages to disk, console, or host using the priority option of the logging command. Table 18-19 lists the different priority levels of detail to send to the recipient of the syslog messages for a corresponding event.

Table 18-19 System Logging Priority Levels and Descriptions 

Priority Code
Condition
Description

0

Emergency

System is unusable.

1

Alert

Immediate action needed.

2

Critical

Critical condition.

3

Error

Error conditions.

4

Warning

Warning conditions.

5

Notice

Normal but significant conditions.

6

Information

Informational messages.

7

Debug

Debugging messages.


Viewing the System Message Log

Using the system message log feature of the Content Distribution Manager GUI, you can view information about events that have occurred in your ACNS network.

To view logged information for your ACNS network, follow these steps.


Note The Content Distribution Manager logs messages only of the severity level "critical" or higher from registered nodes.



Step 1 From the Content Distribution Manager GUI, choose System > Logs. The System Message Log window appears. (See Figure 18-17.)

Figure 18-17 System Message Log (Showing All Messages)

Step 2 Choose one of the following types of messages to display from the System Message Log drop-down list:

All

CLI

Critical

Database

A table listing and describing each message is displayed.

Step 3 Click a column heading to sort the messages chronologically, by node type, node name, module, severity, or message text. By default, messages are listed chronologically. (See Figure 18-17.)


Note If no name is available for a node, the name displayed is "Unavailable." This might occur if the node has been deleted or has been reregistered with Cisco ACNS software.


Step 4 If you have many event messages, you might need to view multiple pages to view the activity that you are interested in. Click the forward (>>) and back (<<) buttons to move between pages. Alternatively, click the link for a specific page number to jump to that page.


Note You can choose the number of rows to be displayed in the System Message Log window by choosing a number from the Rows drop-down list.



Transaction Logging

Transaction logs allow administrators to view the traffic that has passed through the Content Engine. Typical fields in the transaction log are the date and time when a request was made, the URL that was requested, whether it was a cache hit or a cache miss, the type of request, the number of bytes transferred, and the source IP address.

Understanding Transaction Log Formats

In ACNS 5.x software, the user can choose among Squid, Extended Squid, Apache, or customized log formats for the transaction log.

Squid-Style Transaction Logging

The Squid-style log format is the default format for transaction logging in the Content Engine. The Squid log file format used is the native log file format associated with the Squid-1.1 access.log file format. For details on the Squid-1.1 native log file format, refer to the Squid documentation "Frequently Asked Questions," section 6.6, access.log heading at the following URL:

http://www.squid-cache.org/doc/FAQ/FAQ.html

The Squid log file format is:

time elapsed remotehost code/status bytes method URL rfc931 peerstatus/peerhost type

A Squid log format example looks like this:

1012429341.115 100 172.16.100.152 TCP_REFRESH_MISS/304 1100 GET http://www.cisco.com/images/homepage/news.gif - DIRECT/www.cisco.com -

Extended Squid Log Format

The Extended Squid format logs the associated username for each record in the log file in addition to the fields logged by the Squid-style format, and is used for billing purposes. In this format the Rfc931 field associated with the Squid format is used to log the authorized user. This field always contains a "-" (dash) if no user information is available.

An Extended Squid-style log format example looks like this:

1012429341.115 100 172.16.100.152 TCP_MISS/302 184 GET http://www.cisco.com myloginname DIRECT/www.cisco.com

Apache-Style Transaction Logging

The Apache format is the Common Log File (CLF) format defined by the World Wide Web Consortium (W3C) working group. This format is compatible with many industry-standard log tools. For more information, see the W3C Common Log Format website at the following URL:

http://www.w3.org/Daemon/User/Config/Logging.html.

The Apache-style log file format is:

remotehost rfc931 authuser date request status bytes

An Apache-style log file format example looks like this:

172.16.100.152 - - [Wed Jan 30 15:26:26 2002] "GET/http://www.cisco.com/images/homepage/support.gif HTTP/1.0" 200 632

Custom Format Transaction Logging

The transaction-logs format custom command allows you to use a log format string to log additional fields that are not included in the predefined native Squid or Extended Squid formats, or the Apache CLF format. The log format string is a string which can contain the tokens listed in Table 18-20 and which mimics the Apache log format string. The log format string can contain literal characters that are copied into the log file. Double backslashes (\\) can be used to represent a literal backslash, and a backslash followed by a single quote (\') can be used to represent a literal single quote. A literal double quote cannot be represented as part of the log format string. The control characters \t and \n can be used to represent a tab and a new line character, respectively.

Table 18-20 lists the acceptable format tokens for the log format string. The "..." portion of the format tokens shown in this table represents an optional condition. This portion of the format token can be left blank, as in %a. If an optional condition is included in the format token and the condition is met, then what is shown in the Value column of Table 18-20 is included in the transaction log output. If an optional condition is included in the format token but the condition is not met, the resulting transaction log output is replaced with a hyphen (-). The form of the condition is a list of HTTP status codes, which may or may not be preceded by an exclamation point (!). The exclamation point is used to negate all of the status codes that follow it, meaning that the value associated with the format token is logged if none of the status codes listed after the ! match the HTTP status code of the request. If any of the status codes listed after the ! match the HTTP status code of the request, then a hyphen (-) is logged.

For example, "%400,501{User-Agent}i" logs the User-Agent header value on 400 errors and 501 errors (Bad Request, Not Implemented) only, whereas "%!200,304,302{Referer}i" logs the Referer header value on all requests that did not return a normal status.

The custom format currently supports the following request headers:

User-Agent

Referer

Host

Cookie

The output of each of the following Request, Referer, and User-Agent format tokens specified in the custom log format string is always enclosed in double quotation marks in the transaction log entry:

%r

%{Referer}i

%{User-Agent}i

The %{Cookie}i format token is generated without the surrounding double quotation marks, because the Cookie value itself can contain double quotes. The Cookie value can contain multiple attribute-value pairs that are separated by spaces. For this reason, it is recommended that when the Cookie format token is used in a custom format string, it be positioned as the last field in the format string. This positioning of the Cookie format token allows it to be more easily parsed by transaction log reporting tools. Alternatively, if you use the format token string "\'%{Cookie}i\'", the Cookie header can be surrounded by single quotes.

The following command can be entered to generate the well-known Apache Combined Log Format:

transaction-logs format custom "[%{%d}t/%{%b}t/%{%Y}t:%{%H}t:%{%M}t:%{%S}t %{%z}t] %r %s %b %{Referer}i %{User-Agent}i"

The following transaction log entry example in the Apache Combined Format is configured using the preceding custom format string:

[11/Jan/2003:02:12:44 -0800] "GET http://www.cisco.com/swa/i/site_tour_link.gif HTTP/1.1" 200 3436 "http://www.cisco.com/" "Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)"

Table 18-20 Custom Format Log Format String Values 

Format Token
Value

%...a

IP address of the requesting client.

%...A

IP address of the Content Engine.

%...B
%...b

Bytes sent, excluding HTTP headers.

%...c

Connection status when response is completed, where:

X = Connection was aborted before the response was completed.
+ = Connection can be kept alive after the response is sent.
- = Connection is closed after the response is sent.

%...f

Filename.

%...h

Remote host (IP address of the requesting client is logged).

%...H

Request protocol.

%...{Foobar}i

Contents of Foobar: header lines in the request that is sent to the server. The value of Foobar can be one of the following headers: User-Agent, Referer, Host, or Cookie.

%...l

Remote log name. Not implemented on the Content Engine, so a hyphen (-) is logged.

%...m

Request method.

%...p

Canonical port of the server servicing the request. Not applicable on the Content Engine, so a hyphen (-) is logged.

%...P

Process ID of the child that serviced the request.

%...q

Query string (which is preceded by a ? if a query string exists; otherwise, it is an empty string).

%...r

First line of the request.

%...s

Status. The translog code always returns the HTTP response code for the request.

%...t

Time in common log time format (or standard English format).

%...{format}t

Time in the form given by the format token specified in Table 18-21.

%...T

Time consumed to serve the request in seconds (a floating point number with 3 decimal places).

%...u

Remote user.

%...U

URL path requested, not including query strings.

%...v
%...V

Value of the host request header field reported if the host appeared in the request. If the host did not appear in the host request header, the IP address of the server specified in the URL is reported.


Table 18-21 specifies the format token for the date and time of the format token %...{format}t listed in Table 18-20.

Table 18-21 Format Token for Date and Time 

Format Token
Value

%a

Abbreviated weekday name.

%A

Full weekday name.

%b

Abbreviated month name.

%B

Full month name.

%c

Date and time representation.

%C

Century number (year/100) as a 2-digit integer.

%d

Day of the month as a decimal number (01-31).

%D

Equivalent to %m/%d/%y. (Note that in countries other than the USA, the form %d/%m/%y is commonly used. This means that in international context this format is ambiguous and should not be used.)

%e

Like %d, the day of the month as a decimal number, but a leading zero is replaced by a space.

%G

ISO 8601 year with the century as a decimal number. The 4-digit year corresponding to the ISO week number (see %V). This has the same format and value as %y, except that if the ISO week number belongs to the previous or next year, that year is used instead.

%g

Like %G, but without century; that is, with a 2-digit year (00-99).

%h

Equivalent to %b.

%H

Hour as a decimal number using a 24-hour clock (00-23).

%I

Hour as a decimal number using a 12-hour clock (01-12).

%j

Day of the year as a decimal number (001-366).

%k

Hour (24-hour clock) as a decimal number (0-23); single digits are preceded by a blank. (See also %H.)

%l

Hour (12-hour clock) as a decimal number (1-12); single digits are preceded by a blank. (See also %I.)

%m

Month as a decimal number (01-12).

%M

Minute as a decimal number (00-59).

%n

New line character.

%p

Either AM or PM according to the given time value, or the corresponding strings for the current locale. Noon is treated as pm and midnight as am.

%P

Like %p but in lowercase: am or pm or a corresponding string for the current locale.

%r

Time in a.m. or p.m. notation. This is equivalent to `%I:%M:%S %p.'

%R

Time in 24-hour notation (%H:%M). For a version including the seconds, see %T below.

%s

Number of seconds since the epoch; that is, since 1970-01-01 00:00:00 UTC.

%S

Second as a decimal number (00-61).

%t

Tab character.

%T

Time in 24-hour notation (%H:%M:%S).

%u

Day of the week as a decimal (1-7), Monday being 1. See also %w.

%U

Week number of the current year as a decimal number (00-53), starting with the first Sunday as the first day of week 01. See also %V and %W.

%V

ISO 8601:1988 week number of the current year as a decimal number (01-53), where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week. See also %U and %W.

%w

Day of the week as a decimal (0-6), Sunday being 0. See also %u.

%W

Week number of the current year as a decimal number (00-53), starting with the first Monday as the first day of week 01.

%x

Date representation without the time.

%X

Time representation without the date.

%y

Year as a decimal number without a century (00-99).

%Y

Year as a decimal number, including the century.

%z

Time zone as hour offset from GMT. Required to emit RFC 822-conformant dates (using "%a, %d %b %Y %H:%M:%S %z").

%Z

Time zone or name or abbreviation.

%%

Literal % character.


Transaction Logging and NTLM Authentication

If your device is configured for NT LAN Manager (NTLM) authentication and uses Apache-style or Extended Squid-style format, you can record the Windows domain name and username in the "authenticated username" field of the transaction log. If the domain name is available, both the domain name and the username are recorded in the "authenticated username" field, in the form domain\username. If only the username is available, only the username is recorded in the "authenticated username" field. If neither a domain name nor a username is available, a "-" (hyphen) is recorded in the field.

Usage Guidelines for Log Files

This section provides some guidelines for working with log files.

Understanding Working Logs

Depending upon where the sysfs is mounted, transactions are logged to a working log on the local disk in one of these files:

/local1/logs/working.log

/local2/logs/working.log

Depending upon where the sysfs is mounted, the following log files are logged to a working log on the local disk as follows:

WMT logs are logged to a working log on the local disk in one of these files:

/local1/logs/export/working.log

/local2/logs/export/working.log

RealSubscriber logs are logged to a working log on the local disk in one of these files:

/local1/logs/real-subscriber-logs/working.log

/local2/logs/real-subscriber-logs/working.log

Cisco Streaming Engine logs are logged to a working log on the local disk in one of these files:

/local1/logs/cisco-streaming-engine/working.log

/local2/logs/cisco-streaming-engine/working.log

RealProxy logs are logged to a working log on the local disk in one of these files:

/local1/logs/real-proxy/working.log

/local2/logs/real-proxy/working.log

Archive Working Log

You can specify the interval at which the working log should be cleared by moving the data to an archive log. The archive log files are located on the local disk in the directory /local1/logs/ or /local2/logs/, depending upon where the sysfs is mounted.

Because multiple archive files are saved, the filename includes the time stamp when the file was archived. Because the files can be exported to an FTP/SFTP server, the filename also contains the IP address of this Content Engine.

The archive file name format is:

celog_IPADDRESS_YYYYMMDD_HHMMSS.txt.

Sanitizing Transaction Logs

You can disguise the IP address and usernames of clients in the transaction log file. The default is that transaction logs are not sanitized. A sanitized transaction log disguises the network identity of a client by changing the IP address in the transaction logs to 0.0.0.0.

Exporting Log Files

In order to facilitate the postprocessing of cache log files, it is possible to export transaction logs to an external host. This feature allows log files to be automatically exported by FTP to an external host at configurable intervals. The username and password used for FTP are configurable, as is the directory to which the log files are uploaded.

The log files automatically have a filename of:

<type>_<ipaddr>_yyyymmdd_hhmmss.txt

where

<type> represents the type of log file with celog for cache logs such as HTTP, HTTPS, and FTP, and mms_export for Windows Media Technologies (WMT) logs.

<ipaddr> represents the Content Engine IP address.

yyyymmdd_hhmmss represents the date and time when the log was archived for export.


Note For WMT logs, there is no .txt extension in the filename.


Exporting Transaction Logs to External FTP Servers

To export transaction logs to an FTP server, you must first enable exporting of transaction logs and then configure the FTP or secure FTP (SFTP) server parameters. This feature can support up to four FTP servers. The following information is required for each target FTP server:

Server IP address or the host name

The Content Engine translates the host name with a DNS lookup and then stores the IP address in the configuration.

FTP user login and user password

Path of the directory where transferred files are written

Use a fully qualified path or a relative path for the user login. The user must have write permission to the directory.

You can also compress archived log files into gzip format before exporting them to external FTP servers. The compressed filename has a .gz extension in the filename. This compression feature uses less disk space than that required for noncompressed archived files on both the Content Engine and the FTP export server and also requires less bandwidth during export because of the smaller size of the files to be exported.

Restarting Export After Receiving a Permanent Error from the External FTP Server

When an FTP server returns a permanent error to the Content Engine, the archive transaction logs are no longer exported to that server. You must reenter the Content Engine transaction log export parameters for the misconfigured server to clear the error condition.

A permanent error (Permanent Negative Completion Reply, RFC 959) occurs when the FTP command to the server cannot be accepted, and the action does not take place. Permanent errors can be caused by invalid user logins, invalid user passwords, and attempts to access directories with insufficient permissions or directories that do not exist.

Exporting Transaction Logs to External SFTP Servers

You can also export transaction logs to an SFTP server. You must first enable the feature and configure the SFTP server parameters. The following information is required for each target SFTP server:

SFTP server IP address or the host name

The Content Engine translates the host name with a DNS lookup and then stores the IP address in the configuration.

SFTP user login and user password

Path of the directory where transferred files are written

Use a fully qualified path or a relative path for the user login. The user must have write permission to the directory.

Enabling Transaction Logging with the Content Distribution Manager GUI

To enable transaction logging, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Devices.

Step 2 Click the Edit icon next to the name of the Content Engine that you want to configure. The Contents pane appears on the left.

From the Contents pane, choose General Settings > Notification and Tracking > Transaction Logs. The Transaction Logs settings window appears. (See Figure 18-18.) Table 18-22 describes the fields in this window and provides the corresponding CLI global configuration commands.

Figure 18-18 Transaction Log Settings Window—General Settings

Step 3 Under the General Settings heading, check the Transaction Log Enable check box to activate transaction logging on your device.

Step 4 Check the Enable Sanitize Transaction Logs check box to disguise the IP address and username of clients.

Step 5 Check the Enable File-Marker check box to add markers to the transaction logs, indicating where the files begin and end.

Step 6 Check the Log Windows Domain check box to record the Windows domain name and username in the "authenticated username" field of the transaction log.


Note This option is operational if your device is configured for NT LAN Manager (NTLM) authentication and uses either the Apache-style or the Extended Squid-style transaction log format.


Step 7 Check the Compress Files before Export check box to enable compression of archived log files into gzip format before exporting them to external FTP servers.

Step 8 Click the Log File Format radio button and choose a log file format from the drop-down list. Choose apache, extended-squid, or squid.

Alternatively, click the Log Format Custom radio button if you want to use a custom format for the transaction log. Then enter a custom format string in the field provided. (See the "Custom Format Transaction Logging" section.)

Step 9 Under the Archive Settings heading (see Figure 18-19), in the Max Size of Archive File field, specify a value for the maximum size of the archive file in kilobytes. Table 18-22 describes the fields in this window and provides the corresponding CLI global configuration commands.

This is the value of the maximum size of the archived file to be maintained on the local disk.

Figure 18-19 Transaction Log Settings Window—Archive Settings

Step 10 Choose the interval when the working log should be cleared by moving data into the archive log. Schedule the Archive occurs interval using the time options given.

Step 11 Click Submit to save the settings.

Table 18-22 Transaction Log General and Archive Settings 

GUI Parameter
Function
CLI Command

General Settings

   

Transaction Log Enable

Enables transaction logging on the Content Engine.

transaction-logs enable

Enable Sanitize Transaction Logs

Disguises the IP address and username of clients.

transaction-logs sanitize

Enable File-Marker

Adds markers to the transaction logs to indicate where files begin and end.

transaction-logs file-marker

Log Windows Domain

Records the Windows domain name and username in the "authenticated username" field of the transaction log.

transaction-logs log-windows-domain

Compress Files before Export

Enables compression of archived log files into gzip format before exporting them to external FTP servers.

transaction-logs export compress

Log File Format

Configures the log file format (apache, extended-squid, or squid).

transaction-logs format {squid | extended-squid | apache}

Log Format Custom

Configures a custom log file format.

transaction-logs format custom string

Archive Settings

   

Max Size of Archive File

Maximum size (in kilobytes) of the archive file to be maintained on the local disk.

transaction-logs archive max-file-size kilobytes

Archive occurs every (interval)

Interval for the working log to be cleared by moving data into the archive log.

transaction-logs archive interval {seconds | every-week[on weekdays at hour:minute] | every-day {at hour:minute | every hours} | every-hour {at minute | every minutes}



If you want to enable exporting to an FTP server, follow these steps:


Step 1 From the Content Distribution Manager GUI, choose Devices > Devices.

Step 2 Click the Edit icon next to the name of the Content Engine that you want to configure. The Contents pane appears on the left.

Step 3 From the Contents pane, choose General Settings > Notification and Tracking > Transaction Logs. The Transaction Logs settings window appears.

Step 4 Under the Export Settings heading, check the Enable Export check box. (See Figure 18-20.) Table 18-23 describes the fields in this window and provides the corresponding CLI global configuration commands.

Figure 18-20 Transaction Log Settings Window—Export Settings

Step 5 Specify the interval when the working log should be cleared by moving data into the FTP server. Schedule the interval using the time options shown.

Step 6 Enter an IP address or host name information for the FTP server in the Export Server field.


Note The FTP export feature can support up to four servers. Each server must be configured with a username, password, and directory that are valid for that server.


Step 7 Enter a user ID in the Name field.

Step 8 In the Password and Confirm Password fields, enter a password for the user specified in Step 7.

Step 9 Enter the name of a working directory that will contain the transaction logs in the Directory field.


Note The user specified in the Name field must have write permission to the specified directory.


Step 10 Check the SFTP check box if the server chosen is a secure FTP server.

Step 11 Click Submit to save the settings.

Table 18-23 Transaction Log Export Settings 

GUI Parameter
Function
CLI Command

Enable Export

Enables transaction log export to an external FTP server.

transaction-logs export enable

Export occurs (interval)

Interval for the working log to be cleared by moving data to the FTP or SFTP server.

transaction-logs export interval {minutes | every-week [on weekdays at hour:minute] | every-day {at hour:minute | every hours} | every-hour{at minute | every minutes}

Export Server

IP address or hostname of the FTP server.

transaction-logs export ftp-server {hostname | servipaddrs} login passw directory

Name

Name of the user.

Password

Password for the user.

Confirm Password

Confirms the password for the user.

Directory

Name of a working directory that will contain the transaction logs.

SFTP

Configures a secure FTP server.

transaction-logs export sftp-server {hostname | servipaddrs} login passw directory



Using WMT Transaction Logging

For certain companies, streaming media is a source of revenue and therefore needs to be tracked closely. Because these companies charge their customers to stream on-demand content and live broadcasts, they must rely on logged information to track what content a particular customer viewed, how long they viewed it, and what their viewing quality was. Consequently, the accuracy and reliability of transaction logging is very important to these companies.

The Windows Media Services 9 Series provides a more robust logging model than Windows Media Services Version 4.1. ACNS 5.2 software supports Windows Media Services 9 logging.


Note In ACNS software (Release 5.1 and earlier), only the standard Windows Media Services 4.1 and the extended Windows Media Services 4.1 logging formats were supported.


In ACNS 5.2 software, the following logging formats are supported for WMT transaction logging:

Standard Windows Media Services 4.1

Extended Windows Media Services 4.1

Standard Windows Media Services 9.0

Extended Windows Media Services 9.0

The extended versions of the logging formats contain additional fields that are Content-Engine specific (for example, the CE-action field specifies a cache hit or miss, and the CE-bytes field specifies the number of bytes that were sent from the Content Engine).

The Content Engine's transaction logging format for WMT streaming is consistent with that of the Windows Media Services and the World Wide Web Consortium (W3C)-compliant log format. A log line is written for every stream accessed by the client. The location of the log is not configurable. These logs can be exported using FTP. When transaction logging is enabled, daemons create a separate working.log file in /local1/logs/export for WMT transactions.

All client information in the transaction logs is sent to the origin server by default.

Log Formats Accepted by Windows Media Services 9

Windows Media Players connect to a Windows Media server using the following protocols:

Windows Media Players earlier than Version 9.0 use HTTP/1.0 or the MMS protocol.

Windows Media Player Version 9.0 uses HTTP/1.1 and RTSP.

Depending on the version of the Windows Media Player, logs are sent in different formats, such as text, binary, or Extensible Markup Language (XML). Table 18-24 describes the log formats accepted by Windows Media Services 9.

Table 18-24 Windows Media Services 9 Log Formats

Protocol
Player and Distributor
Log Type

HTTP/1.0

Windows Media Player earlier than Version 9.0

Content Engine (caching and proxy server) is running Windows Media Services Version 9.0 and streaming from a WMT server that is running Windows Media Services 4.1

World Wide Web Consortium (W3C) standard space-delimited text log

MMS

Windows Media Player earlier than Version 9.0

Binary structure log

HTTP/1.1

Windows Media Player Version 9.0

Distribution server is running Windows Media Services 9.0

Content Engine (caching and proxy server) is running Windows Media Services 9.0

XML structure log

RTSP

Windows Media Player Version 9.0

Distribution server is running Windows Media Services 9.0

Content Engine (caching and proxy server) is running Windows Media Services 9.0

XML structure log



Note ACNS 5.2 software supports Extensible Markup Language (XML) logging for MMS-over-HTTP. The posted XML log file from the Windows Media Player to the Content Engine (Windows Media server) can be parsed and saved to the normal WMT transaction logs that are stored on the Content Engine. MMS-over-RTSP (RTSP over Windows Media Services 9) is currently not supported in ACNS software.


Configuring WMT Transaction Logging

To configure WMT transaction logging, follow these steps:


Step 1 Navigate to the Transaction Logs Settings for Content Engine window.

a. From the Content Distribution Manager GUI, choose Devices > Devices.

b. Click the Edit icon next to the name of the Content Engine that you want to configure. The Contents pane appears on the left.

c. From the Contents pane, choose General Settings > Notification and Tracking > Transaction Logs. The Transaction Log Settings window appears. (See Figure 18-18.)

Step 2 Under the WMT Settings heading (see Figure 18-21), check the Enable WMT Settings check box to generate transaction logs for WMT streaming sessions.

Figure 18-21 Transaction Log Settings Window—WMT and Logging Settings

Step 3 Choose the logging format for WMT transaction logs from the Log File Format drop-down list. Table 18-25 describes the drop-down list options.

Table 18-25 WMT Log File Format Options

Log Format
Description

extended

Specifies the WMT extended configurations for transaction logs. Enables username logging in the WMT transaction log.

wms-41

Sets WMT to generate transaction logs in extended Windows Media Services 4.1 format.

When this option is used, the Content Engine uses the standard Windows Media Services 4.1 format to generate the transaction log and includes the following three additional fields in the transaction log:

CE_action (cache hit or cache miss)

CE-bytes (number of bytes sent from the Content Engine for a cache hit)

username (username of the WMT request when NTLM, Negotiate, Digest, and basic authentication is used)

wms-90

Sets WMT to generate transaction logs in extended Windows Media Services 9 format.

When this option is used, the Content Engine uses the standard Windows Media Services 9 format to generate the transaction log and includes the following three additional fields in the transaction log:

CE_action (cache hit or cache miss)

CE-bytes (number of bytes sent from the Content Engine for a cache hit)

username (username of the WMT request when NTLM, Negotiate, Digest, and basic authentication is used)

wms-41

Sets WMT to generate transaction logs in the standard Windows Media Services 4.1 format.

wms-90

Sets WMT to generate transaction logs in the standard Windows Media Services 9 format.



To configure WMT transaction logging from the CLI, use the following global configuration command:

wmt transaction-logs format {extended {wms-41 | wms-90} | wms-41 | wms-90}

Using Real-Time Transaction Logging

You can monitor transaction logs in real-time for particular errors such as authentication errors. By sending HTTP transaction log messages to a remote syslog server, you can monitor the remote syslog server for HTTP request authentication failures in real-time. This real-time transaction log feature allows you to monitor transaction logs in real-time for particular errors such as HTTP request authentication errors. The existing transaction logging to the local file system remains unchanged.

For this purpose, you must configure the Content Engine to send transaction log messages to a remote syslog server using UDP as the transport protocol. Because UDP is an unreliable transport protocol, message transport to remote syslog host is not reliable and you must monitor the syslog messages received at the remote syslog server. You can limit the rate at which the transaction logging module is allowed to send messages to the remote syslog server. The format of the syslog message is in standard syslog message format with the transaction log message as the payload of the syslog message.

Real-time transaction logging to a remote syslog server uses the standard syslog message format with the message payload as the transaction log entry. A new syslog error identifier is defined for this type of real-time transaction log message. You can configure the Content Engine to send transaction log messages in real-time to one remote syslog host. The message format of the transaction log entry to the remote syslog host is the same as in the transaction log file and prepended with Cisco's standard syslog header information.

The following is an example of the format of the real-time syslog message sent from the transaction logging module (Content Engine) to the remote syslog host:

fac-pri Apr 22 20:10:46 ce-host cache: %CE-TRNSLG-6-460012: translog formatted msg

The fields in the message are described as follows:

fac-pri denotes the facility parameter and priority for transaction log messages encoded (as in standard syslog format) as a 32-bit decimal value between 0 and 1023 (0x0000 and 0x03FF). The least significant 3 bits denote priority (0-7) and the next least significant 7 bits denote facility (0-127).

The facility parameter used by the transaction logging module when a real-time transaction log message is logged to the remote syslog host is "user". The same facility is sent to the remote syslog host unless you configure a different facility parameter for transaction logging. The priority field is always set to LOG_INFO for real-time transaction log messages.

In the above example, the default value of fac-pri is 14 (0x000E) where facility = user (LOG_USER (1)) and priority = LOG_INFO (6).

The next field in the message is the date, which follows the format as shown in the above example.

ce-host is the hostname or IP of the Content Engine that is sending the message.

cache is the name of the process on the Content Engine that is sending the message.

%CE-TRNSLG-6-460012 is the Cisco standard formatted syslog header on the Content Engine for a real-time transaction log message. This identifier indicates a priority level of 6, which denotes informational messages.


Note The Content Engine system syslog messages report communication errors with the remote syslog host that is configured for transaction logging. These syslog messages are in the error message range: %CE-TRNSLG-6-460013 to %CE-TRNSLG-3-460016. Note that the last error message (%CE-TRNSLG-3-460016), shows level "3" (for error-level messages) instead of "6" (for information-level messages). Information-level messages are reported when messages are dropped due to rate limiting and the number of dropped messages are reported. For more information about these syslog messages, refer to the ACNS Syslog Error Book.


translog formatted msg is the transaction log message as it appears in the transaction log file.


Note The total length of the real-time syslog message is 1024 characters and therefore if the actual transaction log entry exceeds this limit, it is truncated.

To include the username and domain name in the transaction log, check the Log Windows Domain check box or use the transaction-logs log-windows-domain global configuration command.


When the remote syslog server logs this message to a file, the format appears as follows:

Apr 22 20:10:46 ce-host cache: %CE-TRNSLG-6-460012: translog formatted msg

where ce-host is the host name of the Content Engine that sent the real-time transaction log message to the remote syslog server.

The configuration of host settings for transaction logs is identical to the configuration settings for syslog messages except that you need not specify the priority level of the message for real time transaction logs. All messages are associated with the priority level of 6 (LOG_INFO). Therefore, it is not required to filter messages based on priority levels.

Configuring Real-Time Transaction Logging

To configure real-time transaction logging, follow these steps:


Step 1 Navigate to the Transaction Logs Settings for Content Engine window.

a. From the Content Distribution Manager GUI, choose Devices > Devices.

b. Click the Edit icon next to the name of the Content Engine that you want to configure. The Contents pane appears on the left.

c. From the Contents pane, choose General Settings > Notification and Tracking > Transaction Logs. The Transaction Logs settings window appears. (See Figure 18-18.)

Step 2 Under the Logging Settings section (see Figure 18-21), check the Enable check box to enable real-time transaction logging. You can retain the logging host configuration for transaction logs even if you temporarily disable real-time transaction logging by unchecking the check box. This new logging option applies only to the cache's HTTP transaction log entries. The real-time transaction logging feature is disabled by default.


Note You must check the Transaction Log Enable check box in the General settings section before you check the Enable check box. Otherwise, the second setting does not apply unless you enable transaction logging for the entire Content Engine.


Step 3 Choose the appropriate transaction log facility from the Facility drop-down list.

This drop-down list is set to an initial value of Do not set. This denotes that the facility sent to the syslog host will be the facility on the local host that is sending the syslog message, which in the case of the transaction logging module that sends the real-time transaction log message is the "user" facility.

Step 4 From the Entry Type drop-down list, choose the type of transactions that you want to log from the Content Engine to the remote syslog host. Choose request-auth-failures to send only those transactions associated with HTTP request authentication failures to the remote syslog host. Choose all to send all of the transaction messages to the remote syslog host. See the "About Specifying the Transaction Log Entry Type when Logging to a Remote Syslog Host" section.

Step 5 Check the Enable Host Settings check box to enable sending of transaction log files to a remote syslog host.

Step 6 In the Hostname field, enter a host name or an IP address of the remote syslog server to which transaction logs must be sent. No remote syslog server is specified by default.

Step 7 In the Port field, specify the destination port on the remote syslog host to which the Content Engine should send the message. The default port number is 514. This port is a well-known port for system logging.

Step 8 In the Rate Limit field, specify the number of messages that are allowed to be sent to the remote syslog host per second. To limit bandwidth and other resource consumption, messages to the remote syslog host can be rate limited. If this limit is exceeded, the specified remote syslog host drops the messages. There is no default rate limit (rate-limit is set to 0), and by default all syslog messages are sent to all of the configured syslog hosts. The range is 1 to 10,000 messages per second.

Step 9 Click Submit to save the settings.

A "Click Submit to Save" message appears in red next to the Current Settings line when there are pending changes to be saved after you have applied default or device group settings. You can also revert to the previously configured settings by clicking Reset. The Reset button is visible only when you have applied default or group settings to change the current device settings but have not yet submitted the changes.

If you try to leave this window without saving the modified settings, a warning dialog box prompts you to submit the changes. This dialog box only appears if you are using the Internet Explorer browser.


About Specifying the Transaction Log Entry Type when Logging to a Remote Syslog Host

You can configure the Content Engine to send only the transactions associated with HTTP request authentication failures, or to send all of the transactions.

Typically, organizations are interested in only HTTP request authentication failures for security purposes. By monitoring these types of authentication failures in real time, it enables organizations to identify which end users failed to be authenticated through the Content Engine.

Note that only the authentication failure transaction that is associated with an end user who is attempting to contact the authentication server is logged. The "pending" transactions that are waiting for a response from the transaction that contacted the authentication servers are not logged. This approach provides you with the information needed to determine which user fails to authenticate with the Content Engine and minimizes the traffic to the syslog host. In order for you to track which users failed to authenticate, you must configure a transaction log format that logs the username by configuring either Extended Squid-style format or the custom log format with the custom format token %u . For more information about specifying the format of the transaction log, see the "Understanding Transaction Log Formats" section and the "Custom Format Transaction Logging" section.

When you check the Enable check box to enable real-time transaction logging (or specify the transaction-logs logging enable global configuration command), the logging of only HTTP request authentication failures is the default. If you want to change this default and log all transactions, then you must choose all from the Entry Type drop-down list (or enter the transaction-log logging entry-type all global configuration command on the Content Engine). However, if you log all transactions, there may be a significant UDP drop rate if your syslog host cannot handle the rate of incoming traffic.

Monitoring with SNMP

ACNS 5.x software supports Simple Network Management Protocol (SNMP), which is an interoperable standards-based protocol that allows external monitoring of the Content Engine through an SNMP agent. ACNS 5.x software supports the following versions of SNMP:

Version 1 (SNMPv1)—This is the initial implementation of SNMP. Refer to RFC 1157 for a full description of its functionality.

Version 2 (SNMPv2c)—This is the second release of SNMP, described in RFC 1902. It provides additions to data types, counter size, and protocol operations.

Version 3 (SNMPv3)—This is the most recent version of SNMP, defined in RFC 2271 through RFC 2275.

SNMPv1 and SNMPv2c do not have any security (that is, authentication or privacy) mechanisms to keep SNMP packet traffic on the wire confidential. As a result, packets on the wire can be detected and SNMP community strings compromised.

To solve the security shortcomings of SNMPv1 and SNMPv2c, SNMPv3 provides secure access to Content Engines by authenticating and encrypting packets over the network. In ACNS 5.x software, SNMPv3 features are added to the SNMP agent in addition to SNMPv1 and SNMPv2c features.


Note Registering a new SNMP agent with your ACNS network, as well as modifying or removing a registered SNMP agent, causes each of your ACNS nodes to restart as they register the configuration change. Restarting your ACNS devices results in a temporary interruption in service across your ACNS network for the time it takes for each of your devices to come back online—usually a few minutes.


Each Cisco device running ACNS 5.x software contains the software necessary to communicate information about device configuration and activity using the SNMP protocol. Before you can begin logging SNMP data, you must acquire and deploy an SNMP manager application for use with the ACNS network.

This section contains the following Content Distribution Manager GUI procedures for configuring SNMP traps, recipients, community strings and group associations, user security model groups, and user access permissions:

Configuring SNMP General Settings

Configuring SNMP Community Settings

Configuring SNMP Group Settings

Configuring SNMP User Settings

Configuring SNMPv2 View Settings

Configuring SNMP Host Settings

Configuring SNMP Asset Tag Settings

Configuring SNMP General Settings

To enable the Content Engine to send SNMP traps, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine that you want to enable. The Content Engine Device Home window appears with the Contents pane on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > General Settings. The SNMP General Settings for Content Engine window appears. (See Figure 18-22.) Table 18-26 describes the fields in this window.

Figure 18-22 SNMP General Settings Window

Table 18-26 SNMP General Settings 

GUI Parameter
Function
CLI Command

Traps

Content Engine

Enables SNMP Content Engine traps:

Disk Read—Enables disk read error trap.

Disk Write—Enables disk write error trap.

Disk Fail—Enables disk failure error trap.

Overload Bypass—Enables WCCP overload bypass error trap.

Transaction Logging—Enables transaction log write error trap.

snmp-server enable traps content-engine

SNMP

Enables SNMP-specific traps:

Authentication—Enables authentication trap.

Cold Start—Enables cold start trap.

snmp-server enable traps snmp authentication

snmp-server enable traps snmp cold-start

CE Alarm

Enables Content Engine alarm traps:

Raise Critical—Enables raise-critical alarm trap

Clear Critical—Enables clear-critical alarm trap

Raise Major—Enables raise-major alarm trap

Clear Major—Enables clear-major alarm trap

Raise Minor—Enables raise-minor alarm trap

Clear Minor—Enables clear-minor alarm trap

 

Entity

Enables SNMP entity traps.

snmp-server enable traps entity

Event

Enables the Event MIB.

snmp-server enable traps event

Config

Enables CiscoConfigManEvent error traps.

snmp-server enable traps config

Miscellaneous Settings

Contact

Specifies a string for the MIB-II object sysContact. The name identifies the contact person for this managed node.

snmp-server contact line

Location

Specifies a string for the MIB-II object sysLocation. The name identifies the physical location of the node.

snmp-server location line

MIB Persistent Event

Enables persistence for the SNMP Event MIB.

snmp-server mib persist event

Notify Inform

Enables the SNMP notify inform request.

snmp-server notify inform


Step 4 Check the appropriate check boxes to enable SNMP traps.

Step 5 Click Submit to save the settings.

A "Click Submit to Save" message appears in red next to the current settings when there are pending changes to be saved after you have applied default or device group settings. You can also revert to the previously configured window settings by clicking Reset. The Reset button is visible only when you apply default or device group settings to change the current device settings but the settings have not yet been submitted.


Configuring SNMP Community Settings


Note Community strings are listed in the order in which they have been created. The maximum number of SNMP communities that can be created is ten. By default, an SNMP agent is disabled and a community string is not configured. When a community string is configured, it permits read-only access to all agents by default.


To enable the SNMP agent and configure a community string to permit access to the SNMP agent, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine for which you want to configure an SNMP community setting. The Contents pane appears on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > Community. The SNMP Community Strings for Content Engine window appears.

Step 4 Click the Create New SNMP Community String icon in the taskbar. The Creating New SNMP Community String for Content Engine window appears. Table 18-27 describes the fields in this window.

Table 18-27 SNMP Community Settings 

GUI Parameter
Function

Community*1

Community string used as a password for authentication when you access the SNMP agent of the Content Engine. The "Community Name" field of any SNMP message sent to the Content Engine must match the community string defined here in order to be authenticated. Entering a community string enables the SNMP agent. You can enter a maximum of 256 characters in this field.

Groupname/rw*

Group to which the community string belongs. The rw option allows a read or write group to be associated with this community string. The rw option permits access to only a portion of the MIB subtree. Choose one of the following three options from the drop-down list:

None—Choose this option if you do not want to specify a group name to be associated with the community string. If you enter a group name after selecting this option, an error message is displayed. The Group Name field remains disabled if you select this option.

Rw—Choose this option if you want to allow read-write access to the group associated with a community string. The Group Name field remains disabled if you select this option.

Group—Choose this option if you want to specify a group name.

Group Name*

Name of the group to which the community string belongs. You can enter a maximum of 256 characters in this field. This field is available only if you have chosen the group option in the previous field.

1 * = Required field.


Step 5 Enter the community string, whether read-write access to the group is allowed, and group name in the appropriate fields.

Step 6 Click Submit to save the settings.


To enable the SNMP agent and configure a community string from the CLI, use the following global configuration command:

snmp-server community string [group groupname | rw]

Configuring SNMP Group Settings


Note Groups are listed in the order in which they have been created. The maximum number of SNMP groups that can be created is ten.


To define a user security model group, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine for which you want to create an SNMP group. The Device Home window appears with the Contents pane on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > Group. The SNMP Group Strings for Content Engine window appears.

Step 4 Click the Create New SNMP Group String icon in the taskbar. The Creating New SNMP Group String for Content Engine window appears. Table 18-28 describes the fields in this window.

Table 18-28 SNMP Group Settings 

GUI Parameter
Function

Name

Name of the SNMP group. You can enter a maximum of 256 characters.

Sec Model

Security model for the group. Choose one of the following options from the drop-down list:

v1—Version 1 security model (SNMP Version 1 [noAuthNoPriv])

v2c—Version 2c security model (SNMP Version 2 [noAuthNoPriv])

v3-auth—User security level SNMP Version 3 AuthNoPriv

v3-noauth—User security level SNMP Version 3 noAuthNoPriv

v3-priv— User security level SNMP Version 3 AuthPriv

Read View

Name of the view (a maximum of 64 characters) that enables you only to view the contents of the agent. By default, no view is defined. In order to provide read access to users of the group, a view must be specified.

Write View

Name of the view (a maximum of 64 characters) that enables you to enter data and configure the contents of the agent. By default, no view is defined.

Notify View

Name of the view (a maximum of 64 characters) that enables you to specify a notify, inform, or trap. By default, no view is defined.


Step 5 Enter the SNMP group configuration name, security model, and names of the read, write, and notify views in the appropriate fields.

Step 6 Click Submit to save the settings.


To define a user security model group from the CLI, use the following global configuration command:

snmp-server group name {v1 [notify name] [read name] [write name] | v2c [notify name] [read name] [write name] | v3 {auth [notify name] [read name] [write name] | noauth [notify name] [read name] [write name] | priv [notify name] [read name] [write name]}}

Configuring SNMP User Settings


Note Users are listed in the order in which they have been created. The maximum number of users that can be created is ten.


To define a user who can access the SNMP engine, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine for which you want to create an SNMP user. The Contents pane appears on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > User. The SNMP Users for Content Engine window appears.

Step 4 Click the Create New SNMP User icon in the taskbar. The Creating New SNMP User window appears. Table 18-29 describes the fields in this window.

Table 18-29 SNMP User Settings 

GUI Parameter
Function

Name

String representing the name of the user (256 characters maximum) who can access the Content Engine.

Group

Name of the group (256 characters maximum) to which the user belongs.

Remote SNMP ID

Globally unique identifier for a remote SNMP entity. In order to send an SNMPv3 message to the Content Engine, at least one user with a remote SnmpID must be configured on the Content Engine. The SnmpID must be entered in octet string format.

Authentication Algorithm

Authentication algorithm that ensures the integrity of SNMP packets during transmission. Choose one of the following three options from the drop-down list:

No-auth—Requires no security mechanism to be turned on for SNMP packets.

MD5—Provides authentication based on the hash-based Message Authentication Code Message Digest 5 (HMAC-MD5) algorithm.

SHA—Provides authentication based on the hash-based Message Authentication Code Secure Hash (HMAC-SHA) algorithm.

Authentication Password

String (256 characters maximum) that configures the user authentication (HMAC-MD5 or HMAC-SHA) password. The number of characters is adjusted to fit the display area if it exceeds the limit for display.

This field is optional if the no-auth option is chosen for the authentication algorithm. Otherwise, this field must contain a value.

Confirmation Password

Authentication password for confirmation. The reentered password must be the same as the one entered in the previous field.

Private Password

String (256 characters maximum) that configures the authentication (HMAC-MD5 or HMAC-SHA) parameters to enable the SNMP agent to receive packets from the SNMP host. The number of characters will be adjusted to fit the display area if it exceeds the limit for display.

Confirmation Password

Private password for confirmation. The reentered password must be the same as the one entered in the previous field.


Step 5 In the appropriate fields, enter the user name, group to which the user belongs, engine identity of the remote entity to which the user belongs, authentication algorithm used to protect SNMP traffic from tampering, user authentication parameters, and authentication parameters for the packet.

Step 6 Click Submit to save the settings.


To define a user who can access the SNMP engine from the CLI, use the following global configuration command:

snmp-server user name group [auth {md5 password [priv password] | sha password [priv password]} | remote octetstring [auth {md5 password [priv password] | sha password [priv password]}]]

Configuring SNMPv2 View Settings


Note Views are listed in the order in which they have been created. The maximum number of views that can be created is ten.


To define a Version 2 SNMP (SNMPv2) MIB view, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine for which you want to create an SNMPv2 view. The Contents pane appears on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > View. The SNMP Views for Content Engine window appears.

Step 4 Click the Create New View icon in the taskbar. The Creating New SNMP View window appears. Table 18-30 describes the fields in this window.

Table 18-30 SNMPv2 View Settings 

GUI Parameter
Function
CLI Command

Name

String representing the name of this family of view subtrees (256 characters maximum). The family name must be a valid MIB name such as ENTITY-MIB.

snmp-server view viewname

Family

Object identifier (256 characters maximum) that identifies a subtree of the MIB.

snmp-server view viewname MIBfamily

View Type

View option that determines the inclusion or exclusion of the MIB family from the view. Choose one of the following two options from the drop-down list:

Included—The MIB family is included in the view.

Excluded—The MIB family is excluded from the view.

snmp-server view viewname MIBfamily {excluded | included}


Step 5 Enter the view name, family name, and view type in the appropriate fields.

Step 6 Click Submit to save the settings.


Configuring SNMP Host Settings


Note Hosts are listed in the order in which they have been created. The maximum number of SNMP hosts that can be created is four.


To configure SNMP host settings, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine for which you want to define an SNMP host. The Device Home window appears with the Contents pane on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > Host. The SNMP Hosts for Content Engine window appears.

Step 4 Click the Create New SNMP Host icon in the taskbar. The Creating New SNMP Host window appears. Table 18-31 describes the fields in this table.

Table 18-31 SNMP Host Settings

GUI Parameter
Function
CLI Command

Trap Host

Host name or IP address of the SNMP trap host that is sent in SNMP trap messages from the Content Engine.

snmp-server host {hostname | ipaddress}

Community/User

Name of the SNMP community or user (256 characters maximum) that is sent in SNMP trap messages from the Content Engine.

snmp-server host {hostname | ipaddress} communitystring

Authentication

Security model to use for sending notification to the recipient of an SNMP trap operation. Choose one of the following options from the drop-down list:

No-auth—Sends notification without any security mechanism.

v2c-noauth—Sends notification using Version 2c security.

Model v3-auth—Sends notification using SNMP Version 3 AuthNoPriv.

Security Level v3-noauth—Sends notification using SNMP Version 3 NoAuthNoPriv security.

Level v3-priv—Sends notification using SNMP Version 3 AuthPriv security.

snmp-server host {hostname | ipaddress} communitystring [v2c [retry num] [timeout seconds] | [v3 {auth [retry num] [timeout seconds] | noauth [retry num] [timeout seconds] | priv [retry num] [timeout seconds]}]

Retry

Number of retries (1-10) allowed for the inform request. The default is 2 tries.

Timeout

Timeout for the inform request in seconds (1-1000). The default is 15 seconds.


Step 5 Enter the host name or IP address of an SNMP trap host, SNMP community or user name, security model to send notification, and retry count and timeout for inform requests.

Step 6 Click Submit to save the settings.


Configuring SNMP Asset Tag Settings

To configure SNMP asset tag settings, follow these steps:


Step 1 Choose Devices > Devices. The Devices window appears.

Step 2 Click the Edit icon next to the Content Engine for which you want to define an SNMP asset tag. The Contents pane appears on the left.

Step 3 In the Contents pane, choose General Settings > Notification and Tracking > SNMP > Asset Tag. The SNMP Asset Tag Settings for Content Engine window appears.

Step 4 Enter a name in the Asset Tag Name field.

Step 5 Click Submit.


To configure SNMP asset tag settings from the CLI, use the asset tag global configuration command.

Supported MIBs

The SNMP agent supports the following MIBs:

CISCO-CDP-MIB

ENTITY-MIB

CISCO-ENTITY-ASSET-MIB

MIB-II

CISCO-CONFIG-MAN-MIB

CISCO-CONTENT-ENGINE-MIB (supports streaming media-related MIB objects)

HOST-RESOURCES-MIB

EVENT-MIB

The EVENT-MIB can set the threshold on any MIB variables supported by ACNS 5.x software and store the threshold permanently on disk. The HOST-RESOURCES-MIB provides statistics on system resources.

The CISCO-CONTENT-ENGINE-MIB is extended to incorporate MIB objects related to streaming. The WMT, Cisco Streaming Engine, and RealProxy MIB groups incorporate statistics about the WMT server or proxy, Cisco Streaming Engine, and Real Proxy. For each 64-bit counter MIB object, a 32-bit counter MIB object is implemented so that SNMP clients using the SNMPv1 protocol can retrieve data associated with 64-bit counter MIB objects. The MIB objects of each of these groups are read-only.

The WMT MIB group provides statistics about WMT proxy and server performance. Twenty-eight MIB objects are implemented in this group. Six of these MIB objects are implemented as 64-bit counters.

The Cisco Streaming Engine MIB group provides statistics about RTSP streaming engine performance. Seven MIB objects are implemented in this group. Two of these MIB objects are implemented as 64-bit counters.

The RealProxy MIB group provides statistics about RealProxy performance. Fourteen MIB objects are implemented in this group.

Use the following link to access these MIBs:

ftp://ftp.cisco.com/pub/mibs/v2/

Key SNMP CLI Commands

Use the snmp-server group global configuration command to select one of the three SNMP versions, SNMPv1, SNMPv2c, or SNMPv3. Use the no form of this command to remove the specified version. Refer to the Cisco ACNS Software Command Reference, Release 5.2 for more information on how to use this and other SNMP commands.

The snmp-server community string command provides view-based access control for SNMPv1, SNMPv2c, and SNMPv3 but also continues to provide backward compatibility between different versions. The previous version of this command did not have an option to create a community string that allows SNMP messages to execute a set operation on a MIB object. An rw option has been introduced for this purpose. Also, the previous version of the SNMP agent did not provide selective access control to MIB objects. Access to any MIB object was denied or granted based on authentication of the SNMP community string. With the introduction of view-based access control, it is now possible to configure a community string that grants access to only part of the MIB subtree. To provide backward compatibility with the previous version of this command, a default read group or default write group (if the rw option is specified on the command line) is associated with the community string if no group name is specified. Both of these default groups are hidden from users and not displayed in the configuration file or in the show snmp group command, but are created during initialization of the SNMP agent.


Note The SNMP agent is disabled by default, and a community string is not configured.


The following example enables the SNMP agent and assigns the community string comaccess to SNMP:

507-1(config)# snmp-server community comaccess

The preceding example defines a community string comaccess used as a password for authentication when you access the SNMP agent of the Content Engine. Any SNMP message sent to the Content Engine must have the "Community Name" field of the message match the community string defined here in order to be authenticated. Entering a community string enables the SNMP agent.

The following example disables the SNMP agent and removes the previously defined community string.

507-1(config)# no snmp-server community 

Configuring SNMP Traps Using the CLI

To enable the Content Engine to send SNMP traps, use the snmp-server enable traps global configuration command. If you do not enter the snmp-server enable traps command, no traps are sent. Use the no form of this command to disable all SNMP traps or only SNMP authentication traps.

The snmp-server enable traps command is used in conjunction with the snmp-server host command. Use the snmp-server host command to specify which hosts or hosts receive SNMP traps. To send traps, you must configure at least one host.

For a host to receive a trap, both the snmp-server enable traps command and the snmp-server host command for that host must be used.

In addition, SNMP must be enabled with the snmp-server community command.

To disable the sending of the MIB-II SNMP authentication trap, you must enter the command no snmp-server enable traps snmp authentication.

The following example enables the Content Engine to send all traps to the host 172.31.2.160 using the community string public:

ContentEngine(config)# snmp-server enable traps
ContentEngine(config)# snmp-server host 172.31.2.160 public

The following example disables all traps:

Content Engine (config)# no snmp-server enable traps