B ESA Admin Guide 12 0 Chapter 0100010
B ESA Admin Guide 12 0 Chapter 0100010
B ESA Admin Guide 12 0 Chapter 0100010
Note Several of the features or commands described in this section will affect, or be affected by routing precedence.
Please see Appendix B "IP Addresses Interfaces and Routing" for more information.
System Administration
1
System Administration
Shutting Down or Rebooting the Appliance
Step 3 Suspend the delivery of all emails or emails to a particular domain or multiple domains. Depending on your requirements,
do one of the following:
a. To suspend the delivery of all emails, in Specify Domain(s)/Subdomain(s) field, enter ALL, and press Enter.
b. To suspend the delivery of emails to a specific domain or subdomain, in Specify Domain(s)/Subdomain(s) field,
enter the domain or subdomain name or IP address, and press Enter. Use comma-separated text to add multiple
entries.
Step 4 Enter number of seconds to wait to allow open connections to complete before forcing them to close.
If there are no open connections, the system goes offline immediately.
The default delay is 30 seconds.
System Administration
2
System Administration
Resuming Suspended Email Receiving and Delivery
What to do next
When you are ready to resume suspended services, see Resuming Suspended Email Receiving and Delivery
, on page 3.
Step 3 Resume the delivery of all emails or emails to a particular domain or multiple domains.
In Specify Domain(s)/Subdomain(s) field, click the close icon on the intended entry.
Caution Do not reset to factory defaults if you are not able to reconnect to the web interface or CLI using the Serial
interface or the default settings on the Management port through the default Admin user account.
When physically transferring the appliance, you may want to start with factory defaults. Resetting to factory
settings is extremely destructive, and it should only be used when you are transferring the unit or as a last
resort to solving configuration issues. Resetting to factory defaults disconnects you from the web interface
or CLI, disabling services that you used to connect to the appliance (FTP, SSH, HTTP, HTTPS), and even
removing additional user accounts you had created. You can reset to factory default:
• On web interface, click the Reset button in the System Administration > Configuration File page, or
click the Reset Configuration button in the System Administration> System Setup Wizard.
• On CLI, use the resetconfig command.
Note The resetconfig command only works when the appliance is in the offline state. The appliance returns
to the online state after resetting to factory settings.
Next Steps
• Run the System Setup wizard. For more information, refer to Using the System Setup Wizard
System Administration
3
System Administration
Displaying the Version Information for AsyncOS
Feature Keys
• Adding and Managing Feature Keys , on page 4
• Automating Feature Key Download and Activation , on page 5
• Expired Feature Keys, on page 5
To Do This
View the status of active feature keys Look at the Feature Keys for <serial number> section.
View feature keys that have been issued for your Look at the Pending Activation section.
appliance but are not yet activated
If you have enabled automatic download and activation, feature
keys will never appear in this list.
Check for recently-issued feature keys Click the Check for New Keys button in the Pending Activation
section.
This is useful if you have not enabled automatic download and
activation of feature keys, or if you need to download feature keys
before the next automatic check.
Activate an issued feature key Select the key in the Pending Activation list and click Activate
Selected Keys.
System Administration
4
System Administration
Automating Feature Key Download and Activation
To Do This
What to do next
Related Topics
• Automating Feature Key Download and Activation , on page 5
• Configuration File Page, on page 17
What to do next
Related Topics
• Adding and Managing Feature Keys , on page 4
System Administration
5
System Administration
Overview
Overview
Smart Software Licensing enables you to manage and monitor Cisco Email Security appliance licenses
seamlessly. To activate Smart Software licensing, you must register your appliance with Cisco Smart Software
Manager (CSSM) which is the centralized database that maintains the licensing details about all the Cisco
products that you purchase and use. With Smart Licensing, you can register with a single token rather than
registering them individually on the website using Product Authorization Keys (PAKs).
Once you register the appliance, you can track your appliance licenses and monitor license usage through the
CSSM portal. The Smart Agent installed on the appliance connects the appliance with CSSM and passes the
license usage information to the CSSM to track the consumption.
See https://www.cisco.com/c/en/us/td/docs/wireless/technology/mesh/8-2/b_Smart_Licensing_Deployment_
Guide.html to know about Cisco Smart Software Manager.
Note If you want to use Smart Software Manager Satellite, use Smart Software Manager
Satellite Enhanced Edition 6.1.0.
• The existing users of classical licenses (traditional) should migrate their classical licenses to smart licenses.
See https://video.cisco.com/detail/video/5841741892001/
convert-classic-licenses-to-smart-licenses?autoStart=true&q=classic.
System Administration
6
System Administration
Enabling Smart Software Licensing
• The system clock of the appliance must be in sync with that of the CSSM. Any deviation in the system
clock of the appliance with that of the CSSM, will result in failure of smart licensing operations.
Note If you have internet connectivity and want to connect to the CSSM through a proxy, you must use the same
proxy that is configured for the appliance using Security Services -> Service updates
Note For virtual users, every time you receive a new PAK file (new or renewal), generate the license file and load
the file on the appliance. After loading the file, you must convert the PAK to Smart Licensing. In Smart
Licensing mode, the feature keys section in the license file will be ignored while loading the file and only the
certificate information will be used.
You must perform the following procedures to activate Smart Software Licensing for your appliance:
Step 2 Register the appliance with Cisco Registering the Appliance with
Smart Software Manager Cisco Smart Software Manager, on
page 8
Step 3 Request for licenses (feature keys) Requesting for Licenses, on page
9
Step 3 Click OK after reading the information about Smart Software Licensing.
Step 4 Commit your changes.
What to do next
After you enable Smart Software Licensing, all the features in the Classic Licensing mode will be automatically
available in the Smart Licensing mode. If you are an existing user in Classic Licensing mode, you have 90-days
evaluation period to use the Smart Software Licensing feature without registering your appliance with the
CSSM.
You will get notifications on regular intervals (90th, 60th, 30th, 15th, 5th, and last day) prior to the expiry
and also upon expiry of the evaluation period. You can register your appliance with the CSSM during or after
the evaluation period.
System Administration
7
System Administration
Registering the Appliance with Cisco Smart Software Manager
Note New Virtual Appliance users with no active licenses in Classic Licensing mode will not have the evaluation
period even if they enable the Smart Software Licensing feature. Only the existing Virtual Appliance users
with active licenses in Classic Licensing mode will have evaluation period. If new Virtual Appliance users
want to evaluate the smart licensing feature, contact Cisco Sales team to add the evaluation license to the
smart account. The evaluation licenses are used for evaluation purpose after registration.
Note After you enable the Smart Licensing feature on your appliance, you will not be able to roll back from Smart
Licensing to Classic Licensing mode.
Step 3 Switch back to your appliance and paste the Product Instance Registration Token.
Step 4 Click Register.
Step 5 On the Smart Software Licensing page, you can check the Reregister this product instance if it is already registered check
box to reregister your appliance. See Reregistering the Appliance with Smart Cisco Software Manager , on page 9.
What to do next
The product registration process takes a few minutes and you can view the registration status on the Smart
Software Licensing page.
System Administration
8
System Administration
Requesting for Licenses
What to do next
When the licenses are overused or expired, they will go into out of compliance (OOC) mode and 30-days
grace period is provided to each license. You will get notifications on regular intervals (30th, 15th, 5th, and
last day) prior to the expiry and also upon the expiry of the OOC grace period.
After the expiry of the OOC grace period, you cannot use the licenses and the features will be unavailable.
To access the features again, you must update the licenses on the CSSM portal and renew the authorization.
What to do next
See Registering the Appliance with Cisco Smart Software Manager, on page 8 to know about registration
process.
You can reregister the appliance after you reset the appliance configurations during unavoidable scenarios.
System Administration
9
System Administration
Changing Transport Settings
Note You can change the transport settings only when the smart licensing feature is enabled.If you have already
registered your appliance, you must deregister the appliance to change the transport settings. After changing
the transport settings, you must register the appliance again.
See Registering the Appliance with Cisco Smart Software Manager to know how to change the transport
settings.
Note You can renew authorization only after the successful registration of the appliance.
Alerts
You will receive notifications on the following scenarios:
• Smart Software Licensing successfully enabled
• Smart Software Licensing enabling failed
• Beginning of the evaluation period
• Expiry of evaluation period (on regular intervals during evaluation period and upon expiry)
• Successfully registered
• Registration failed
• Successfully authorized
• Authorization failed
• Successfully deregistered
• Deregistration failed
System Administration
10
System Administration
Updating Smart Agent
Note The cluster management of smart licensing feature happens only in the machine mode. In smart licensing
cluster mode, you can log into any of the appliances and configure smart licensing feature. You can log into
an appliance and access other appliances one by one in the cluster and configure the smart licensing feature
without logging off from the first appliance.
Note You cannot open a Technical Support tunnel or run the System Setup Wizard before installing the virtual
appliance license.
System Administration
11
System Administration
Virtual Appliance License Expiration
Related Topics
• Reverting AsyncOS on Virtual Appliances May Impact the License , on page 33
System Administration
12
System Administration
Managing Configuration Files
Note The private keys and certificates are included in unencrypted PEM format along with the configuration file
with encrypted passphrase.
Related Topics
• Saving and Exporting the Current Configuration File, on page 13
• Loading a Configuration File, on page 14
• Mailing the Configuration File, on page 14
• Resetting the Current Configuration, on page 16
System Administration
13
System Administration
Mailing the Configuration File
Regardless of the method, you must include the following tags at the top of your configuration:
<?xml version="1.0" encoding="ISO-8859-1"?>
<config>
</config>
The closing </config> tag should follow your configuration information. The values in XML syntax are
parsed and validated against the DTD (document type definition) located in the configuration directory on
your appliance. The DTD file is named config.dtd . If validation errors are reported at the command line
when you use the loadconfig command, the changes are not loaded. You can download the DTD to validate
configuration files outside of the appliance before uploading them.
In either method, you can import an entire configuration file (the information defined between the highest
level tags: <config></config> ), or a complete and unique sub-section of the configuration file, as long as it
contains the declaration tags (above) and is contained within the <config></config> tags.
System Administration
14
System Administration
Loading a Configuration File
“Complete” means that the entire start and end tags for a given subsection as defined by the DTD are included.
For example, uploading or pasting this:
<?xml version="1.0" encoding="ISO-8859-1"?>
<config>
<autosupport_enabled>0</autosu
</config>
<config>
<autosupport_enabled>0</autosupport_enabled>
</config>
will not.
“Unique” means that the subsection of the configuration file being uploaded or pasted is not ambiguous for
the configuration. For example, a system can have only one hostname, so uploading this (including the
declarations and <config></config> tags):
<hostname>mail4.example.com</hostname>
is allowed. However, a system can have multiple listeners defined, each with different Recipient Access Tables
defined, so uploading only this:
<rat>
<rat_entry>
<rat_address>ALL</rat_address>
<access>RELAY</access>
</rat_entry>
</rat>
Caution When uploading or pasting a configuration file or subsections of a configuration file, you have the potential
to erase uncommitted changes that may be pending.
If disk space allocations in the configuration file are smaller than the amount of data currently stored on the
appliance, the oldest data will be deleted to meet the quota specified in the configuration file.
System Administration
15
System Administration
Empty vs. Omitted Tags
<listeners></listeners>
Caution When uploading or pasting subsections of a configuration file, you have the potential to disconnect yourself
from the web interface or CLI and to destroy large amounts of configuration data. Do not disable services
with this command if you are not able to reconnect to the appliance using another protocol, the Serial interface,
or the default settings on the Management port. Also, do not use this command if you are unsure of the exact
configuration syntax as defined by the DTD. Always back up your configuration data prior to loading a new
configuration file.
Related Topics
• Loading a Configuration in Clustered Appliances
System Administration
16
System Administration
Configuration File Page
mail3.example.com> showconfig
Note Disk space reduction is not supported. See the VMWare documentation for information.
System Administration
17
System Administration
Viewing and Allocating Disk Space Usage
See information about changing the virtual disk configuration in the VMWare documentation. At time of release, this
information for ESXi 5.5 was available here: http://pubs.vmware.com/vsphere-55/index.jsp?topic=
%2Fcom.vmware.vsphere.hostclient.doc%2FGUID-81629CAB-72FA-42F0-9F86-F8FD0DE39E57.html.
Step 3 Go to System Administration > Disk Management and verify that your change has taken effect.
To Do This
• View disk space quotas and Go to System Administration > Disk Management.
current usage for each service
• Reallocate disk space on your
appliance at any time
Manage data volume • For reporting and tracking services and the spam quarantine, the
oldest data will be deleted automatically.
• For Policy, Virus and Outbreak quarantines, the default action
configured in the quarantine will be taken. See Default Actions
for Automatically Processed Quarantined Messages.
• For the Miscellaneous quota, you must first manually delete data
to reduce usage below the new quota you will set. See Managing
Disk Space for the Miscellaneous Quota , on page 18.
To Manage Do this
Packet captures Go to Help and Support (near the upper right side of your screen) >
Packet Capture.
System Administration
18
System Administration
Ensuring That You Receive Alerts About Disk Space
To Manage Do this
You can perform the following tasks in the Services Overview page:
• Manually update the engines. For more information, see Manually Updating the Engines, on page 20
• Rollback to previous version of the engine. For more information, see Rollback to Previous Version of
Engine, on page 20
The Auto Update column shows the status of the automatic updates of a particular engine. If you want to
enable or disable Automatic Updates, go to the Global Settings page of particular engine.
When automatic updates are disabled for a specific service engine, you will receive alerts periodically. If you
want to change the alert interval, use the Alert Interval for Disabled Automatic Engine Updates option in
the Security Services > Service Updates page.
Note Auto Updates are disabled automatically for the engine on which the rollback is applied.
Related Topics
• Manually Updating the Engines, on page 20
• Rollback to Previous Version of Engine, on page 20
• Viewing Logs, on page 20
• System Alerts, on page 44
System Administration
19
System Administration
Manually Updating the Engines
Viewing Logs
The information about engine rollback and disabling automatic updates is posted to the following logs:
• Updater Logs: Contains information about the engine rollback and automatic updating of the engine.
Most information is at Info or Debug level.
For more information, see Updater Log Example.
Service Updates
The following services require updates for maximum effectiveness:
• Feature Keys
• McAfee Anti-Virus definitions
• PXE Engine
• Sophos Anti-Virus definitions
• IronPort Anti-Spam rules
• Outbreak Filters rules
• Time zone rules
• URL categories (Used for URL filtering features. For details, see Future URL Category Set Changes)
System Administration
20
System Administration
Setting Up to Obtain Upgrades and Updates
• Enrollment client (Used for updating certificates needed for communication with cloud-based services
used for URL filtering features. For information, see About the Connection to Cisco Web Security
Services.)
• Graymail rules
Note Settings for the DLP engine and content matching classifiers are handled on the Security Services > Data
Loss Prevention page. See About Updating the DLP Engine and Content Matching Classifiers for more
information.
Service update settings are used for all services that receive updates except DLP updates. You cannot specify
unique settings for any individual service except DLP updates.
To set up the network and the appliance to obtain these critical updates, see Setting Up to Obtain Upgrades
and Updates , on page 21.
Configuring Your Network to Download Upgrades and Updates from the Cisco
Servers
The appliance connect directly to the Cisco update servers to find and download upgrades and updates:
System Administration
21
System Administration
Configuring the Appliance for Upgrades and Updates in Strict Firewall Environments
Cisco update servers use dynamic IP addresses. If you have strict firewall policies, you may need to configure
a static location instead. For more information, see Configuring the Appliance for Upgrades and Updates in
Strict Firewall Environments, on page 22.
Create a firewall rule to allow downloading of upgrades from Cisco update servers on ports 80 and 443.
Step 1 Contact Cisco Customer support to obtain the static URL address.
Step 2 Create a firewall rule to allow downloading of upgrades and updates from the static IP address on port 80.
Step 3 Choose Security Services > Service Updates.
Step 4 Click Edit Update Settings.
Step 5 On the Edit Update Settings page, in the “Update Servers (images)” section, choose Local Update Servers and enter the
static URL received in step 1 in the Base URL field for AsyncOS upgrades and McAfee Anti-Virus definitions.
Step 6 Verify that IronPort Update Servers is selected for the “Update Servers (list)” section.
Step 7 Submit and commit your changes.
Note Cisco recommends using a local server only for AsyncOS upgrades. If you use a local update server for
security update images, the local server does not automatically receive security updates from Cisco IronPort,
so the appliances in your network may not always have the most current security services.
System Administration
22
System Administration
Hardware and Software Requirements for Upgrading and Updating from a Local Server
Step 1 Configure a local server to retrieve and serve the upgrade files.
Step 2 Download the upgrade files.
Step 3 Configure the appliance to use the local server using either the Security Services > Service Updates page in the GUI
or the updateconfig command in the CLI.
Step 4 Upgrade the appliance using either the System Administration > System Upgrade page or the upgrade command in
the CLI.
Note For this release, if you need to configure a firewall setting to allow HTTP access
to this address, you must configure it using the DNS name and not a specific IP
address.
For hosting AsyncOS update files, you must have a server in your internal network that has:
• A web server — for example, Microsoft IIS (Internet Information Services) or the Apache open source
server — which:
System Administration
23
System Administration
Hosting an Upgrade Image on a Local Server
Note If you define a proxy server, it will automatically be used for all service updates that are configured to use a
proxy server. There is no way to turn off the proxy server for updates to any individual service.
System Administration
24
System Administration
Configuring Server Settings for Downloading Upgrades and Updates
Setting Description
Update Servers (images) Choose whether to download Cisco IronPort AsyncOS upgrade images and service
updates from the Cisco IronPort update servers or a from a local server on your
network. The default is the Cisco IronPort update servers for both upgrades and
updates.
To use the same settings for upgrades and updates, enter information in the visible
fields.
If you choose a local update server, enter the base URL and port number for the
servers used to download the upgrades and updates. If the server requires
authentication, you can also enter a valid username and passphrase.
To enter separate settings solely for AsyncOS upgrades and McAfee Anti-Virus
definitions, click the Click to use different settings for AsyncOS link.
Note Cisco Intelligent Multi-Scan requires a second local server to download
updates for third-party anti-spam rules.
Update Servers (lists) To ensure that only upgrades and updates that are appropriate to your deployment
are available to each appliance, Cisco IronPort generates a manifest list of the
relevant files.
Choose whether to download the lists of available upgrades and service updates
(the manifest XML files) from the Cisco IronPort update servers or from a local
server on your network.
There are separate sections for specifying servers for updates and for AsyncOS
upgrades. The default for upgrades and updates is the Cisco IronPort update servers.
If you choose local update servers, enter the full path to the manifest XML file for
each list, including the file name and HTTP port number for the server. If you leave
the port field blank, AsyncOS uses port 80. If the server requires authentication,
enter a valid user name and passphrase.
Automatic Updates Enable automatic updates and the update interval (how often the appliance checks
for updates) for Sophos and McAfee Anti-Virus definitions, Cisco Anti-Spam rules,
Cisco Intelligent Multi-Scan rules, PXE Engine updates, Outbreak Filter rules, and
time zone rules.
Include a trailing s, m, or h to indicate seconds, minutes, or hours. Enter 0 (zero)
to disable automatic updates.
Note You can only turn on automatic updates for DLP using the Security
Services > Data Loss Prevention page. However, you must enable
automatic updates for all services first. See About Updating the DLP
Engine and Content Matching Classifiers for more information.
Alert Interval for Disabled Enter specific frequency of alerts to be sent when the ‘Automatic Updates’ feature
Automatic Engine Updates is disabled for a specific engine.
Include a trailing m, h, or d to indicate months, hours, or days. The default value
is 30 days.
System Administration
25
System Administration
Configuring Automatic Updates
Setting Description
Interface Choose which network interface to use when contacting the update servers for the
listed security component updates. The available proxy data interfaces are shown.
By default, the appliance selects an interface to use.
HTTP Proxy Server An optional proxy server used for the services listed in the GUI.
If you specify a proxy server, it will be used to update ALL services.
HTTPS Proxy Server An optional proxy server using HTTPS. If you define the HTTPS proxy server, it
will be used to update the services listed in the GUI.
Step 1 Navigate to the Security Services > Service Updates page, and click Edit Update Settings.
Step 2 Select the check box to enable automatic updates.
Step 3 Enter an update interval (time to wait between checks for updates). Add a trailing m for minutes and h for hours. The
maximum update interval is 1 hour.
mail.example.com> updateconfig
Service (images): Update URL:
------------------------------------------------------------------------------------------
Feature Key updates http://downloads.ironport.com/asyncos
Timezone rules Cisco IronPort Servers
Enrollment Client Updates Cisco IronPort Servers
Support Request updates Cisco IronPort Servers
Cisco IronPort AsyncOS upgrades Cisco IronPort Servers
Service (list): Update URL:
------------------------------------------------------------------------------------------
Timezone rules Cisco IronPort Servers
Enrollment Client Updates Cisco IronPort Servers
Support Request updates Cisco IronPort Servers
Service (list): Update URL:
------------------------------------------------------------------------------------------
Cisco IronPort AsyncOS upgrades Cisco IronPort Servers
Update interval: 5m
Proxy server: not enabled
HTTPS Proxy server: not enabled
System Administration
26
System Administration
Configuring the Appliance to Trust Proxy Server Communication
mail.example.com> updateconfig
...
...
...
Choose the operation you want to perform:
- SETUP - Edit update configuration.
- VALIDATE_CERTIFICATES - Validate update server certificates
- TRUSTED_CERTIFICATES - Manage trusted certificates for updates
[]> trusted_certificates
Choose the operation you want to perform:
- ADD - Upload a new trusted certificate for updates.
[]> add
Paste certificates to be trusted for secure updater connections, blank to quit
Trusted Certificate for Updater:
Paste cert in PEM format (end with '.'):
-----BEGIN CERTIFICATE-----
MMIICiDCCAfGgAwIBAgIBATANBgkqhkiG9w0BAQUFADCBgDELMAkGA1UEBhMCSU4x
DDAKBgNVBAgTA0tBUjENM............................................
-----END CERTIFICATE-----
.
Choose the operation you want to perform:
- ADD - Upload a new trusted certificate for updates.
- LIST - List trusted certificates for updates.
System Administration
27
System Administration
Upgrading AsyncOS
Upgrading AsyncOS
Procedure
Step 4 Perform the upgrade. Downloading and Installing the Upgrade , on page 29
To Do This
View more information about the latest upgrade Hover over the upgrade notification.
View a list of all available upgrades Click the down arrow in the notification.
Dismiss a current notification. Click the down arrow, then select Clear the
notification, then click Close.
The appliance will not display another notification until
a new upgrade becomes available.
Prevent future notifications (Users with Administrator Go to Management Appliance > System
privileges only.) Administration > System Upgrade.
System Administration
28
System Administration
Notifications of Available Upgrades
To Do This
View more information about the latest upgrade Hover over the upgrade notification.
View a list of all available upgrades Click the down arrow in the notification.
Dismiss a current notification. Click the down arrow, then select Clear the
notification, then click Close.
The appliance will not display another notification until
a new upgrade becomes available.
Prevent future notifications (Users with Administrator Go to Management Appliance > System
privileges only.) Administration > System Upgrade.
Step 1 Save the XML configuration file off-box. If you need to revert to the pre-upgrade release for any reason, you will need
this file.
Step 2 If you are using the Safelist/Blocklist feature, export the list off-box.
Step 3 Suspend all listeners. If you perform the upgrade from the CLI, use the suspendlistener command. If you perform the
upgrade from the GUI, listener suspension occurs automatically.
Step 4 Wait for the queue to empty. You can use the workqueue command to view the number of messages in the work queue
or the rate command in the CLI to monitor the message throughput on your appliance.
Note Re-enable the listeners post-upgrade.
System Administration
29
System Administration
Downloading and Installing the Upgrade
Note When downloading and upgrading AsyncOS in a single operation from a local server instead of from a Cisco
IronPort server, the upgrade installs immediately while downloading . A banner displays for 10 seconds at
the beginning of the upgrade process. While this banner is displayed, you have the option to type Control-C
to exit the upgrade process before downloading starts.
To Do This
System Administration
30
System Administration
Downloading and Installing the Upgrade
To Do This
Step 5 Unless you are installing a previously-downloaded installer, select an AsyncOS version from the list of available upgrades.
Step 6 If you are installing:
a) Choose whether or not to save the current configuration to the configuration directory on the appliance.
b) Choose whether or not to mask the passphrases in the configuration file.
Note You cannot load a configuration file with masked passphrases using the Configuration File page in the GUI
or the loadconfig command in the CLI.
c) If you want to email copies of the configuration file, enter the email addresses to which you want to email the file.
Use commas to separate multiple email addresses.
Step 7 Click Proceed.
Step 8 If you are installing:
a) Be prepared to respond to prompts during the process.
The process pauses until you respond.
A progress bar appears near the top of the page.
b) At the prompt, click Reboot Now.
c) After about 10 minutes, access the appliance again and log in.
If you feel you need to power-cycle the appliance to troubleshoot an upgrade issue, do not do so until at least 20
minutes have passed since you rebooted.
What to do next
• If the process was interrupted, you must start the process again.
• If you downloaded but did not install the upgrade:
When you are ready to install the upgrade, follow these instructions from the beginning, including the
prerequisites in the Before You Begin section, but choose the Install option.
• If you installed the upgrade:
• Re-enable (resume) the listeners.
• Save a configuration file for the new system. For information, see Managing the Configuration File,
on page 12.
• After upgrade is complete, re-enable listeners.
System Administration
31
System Administration
Viewing Status of, Canceling, or Deleting a Background Download
To Do This
Cancel a download Click the Cancel Download button in the middle of the page.
This option appears only while a download is in progress.
Delete a downloaded installer Click the Delete File button in the middle of the page.
This option appears only if an installer has been downloaded.
Step 1 Use SSH or the serial console port to access the command-line interface.
Step 2 Sign in using an account with Administrator access.
Step 3 Enter the following commands:
System Administration
32
System Administration
Reverting to a Previous Version of AsyncOS
remotepower
setup
What to do next
Related Topics
• Remotely Resetting Appliance Power
Reversion Impact
Using the revert command on a appliance is a very destructive action. This command destroys all configuration
logs and databases. Only the network information for the management interface is preserved--all other network
configuration is deleted. In addition, reversion disrupts mail handling until the appliance is reconfigured.
Because this command destroys network configuration, you may need physical local access to the appliance
when you want to issue the revert command.
Caution You must have a configuration file for the version you wish to revert to. Configuration files are not
backwards-compatible.
System Administration
33
System Administration
Reverting AsyncOS
Related Topics
• Virtual Appliance License Expiration , on page 12
Reverting AsyncOS
Step 1 Ensure that you have the configuration file for the version you wish to revert to. Configuration files are not
backwards-compatible. To do this, you can email the file to yourself or FTP the file. For information, see Mailing the
Configuration File, on page 14.
Step 2 Save a backup copy of the current configuration of your appliance (with passphrases unmasked) on another machine.
Note This is not the configuration file you will load after reverting.
Step 3 If you use the Safelist/Blocklist feature, export the Safelist/Blocklist database to another machine.
Step 4 Wait for the mail queue to empty.
Step 5 Log into the CLI of the appliance you want to revert.
When you run the revert command, several warning prompts are issued. After these warning prompts are accepted, the
revert action takes place immediately. Therefore, do not begin the reversion process until after you have completed the
pre-reversion steps.
System Administration
34
System Administration
Setting Thresholds for System Health Parameters
Note To configure the threshold for system health parameters using CLI, use the healthconfig command. For more
information, see the CLI inline help or CLI Reference Guide for AsyncOS for Cisco Email Security Appliances
.
System Administration
35
System Administration
Checking the Health of Email Security Appliance
• When the memory swap usage reaches 15.1% in 15 minutes, one more alert is sent.
• Specify the threshold level for maximum messages in workqueue (in number of messages).
Also, specify if you want to receive an alert if the number of messages in work queue has crossed the configured
threshold value. After the first alert is sent, if the maximum messages in work queue crosses the value that triggered
the first alert by 150 percent within 15 minutes, an additional alert is sent. For example, if the threshold is set to
1000,
• When the maximum messages in work queue reached 1002, the first alert was sent.
• When the maximum messages in work queue reached 1510 with 15 minutes, one more alert is sent.
Note All the alerts for this feature belong to the System Alert category.
What to do next
If you have configured alerts for this feature, make sure that you subscribe to the System Alerts. For instructions,
see Adding Alert Recipients, on page 38.
Note For the system to perform this analysis, the Status Logs must contain a minimum of one month of logging
data.
System Administration
36
System Administration
Alerts
Alerts
Alert messages are automatically-generated standard email messages that contain information about events
occurring on the appliance. These events can be of varying levels of importance (or severity) from minor to
major and pertain generally to a specific component or feature on your appliance. Alerts are generated by the
appliance. You can specify, at a much more granular level, which alert messages are sent to which users and
for which severity of event they are sent. Manage alerts via the System Administration > Alerts page in the
GUI (or via the alertconfig command in the CLI).
Alert Severities
Alerts can be sent for the following severities:
• Critical: Requires immediate attention.
• Warning: Problem or error requiring further monitoring and potentially immediate attention.
• Information: Information generated in the routine functioning of this device.
AutoSupport
To allow Cisco to better support and design future system changes, the appliance can be configured to send
Cisco Systems a copy of all alert messages generated by the system. This feature, called AutoSupport, is a
useful way to allow our team to be proactive in supporting your needs. AutoSupport also sends weekly reports
noting the uptime of the system, the output of the status command, and the AsyncOS version used.
By default, alert recipients set to receive Information severity level alerts for System alert types will receive
a copy of every message sent to Cisco. This can be disabled if you do not want to send the weekly alert
messages internally. To enable or disable this feature, see Configuring Alert Settings, on page 38.
Alert Delivery
Alerts sent from the appliance to addresses specified in the Alert Recipient follow SMTP routes defined for
those destinations
Since alert messages can be used to inform you of problems within your appliance, they are not sent using
AsyncOS’s normal mail delivery system. Instead, alert messages pass through a separate and parallel email
system designed to operate even in the face of significant system failure in AsyncOS.
The alert mail system does not share the same configuration as AsyncOS, which means that alert messages
may behave slightly differently from other mail delivery:
• Alert messages are delivered using standard DNS MX and A record lookups.
• They do cache the DNS entries for 30 minutes and the cache is refreshed every 30 minutes, so in
case of DNS failure the alerts still go out.
• Alert messages do not pass through the work queue, so they are not scanned for viruses or spam. They
are also not subjected to message filters or content filters.
• Alert messages do not pass through the delivery queue, so they are not affected by bounce profiles or
destination control limits.
System Administration
37
System Administration
Example Alert Message
To: joe@example.com
Version: 4.5.0-419
Note If you enabled AutoSupport during System Setup, the email address specified will receive alerts for all severities
and classes by default. You can change this configuration at any time.
System Administration
38
System Administration
Alert Settings
Note Use the alertconfig CLI command to define the number of alerts to save on the appliance to view later.
Step 4 You can enable AutoSupport by checking the IronPort AutoSupport option. For more information about AutoSupport,
see AutoSupport, on page 37.
• If AutoSupport is enabled, the weekly AutoSupport report is sent to alert recipients set to receive System alerts at
the Information level. You can disable this via the checkbox.
Alert Settings
Alert settings control the general behavior and configuration of alerts, including:
• The RFC 2822 Header From: when sending alerts (enter an address or use the default
“alert@<hostname>”). You can also set this via the CLI, using the alertconfig -> from command.
• The initial number of seconds to wait before sending a duplicate alert.
• The maximum number of seconds to wait before sending a duplicate alert.
• The status of AutoSupport (enabled or disabled).
• The sending of AutoSupport’s weekly status reports to alert recipients set to receive System alerts at the
Information level.
System Administration
39
System Administration
Viewing Recent Alerts
Alert Descriptions
The following tables list alerts by classification, including the alert name (internal descriptor used by Cisco),
actual text of the alert, description, severity (critical, information, or warning) and the parameters (if any)
included in the text of the message. The value of the parameter is replaced in the actual text of the alert. For
example, an alert message below may mention “$ip” in the message text. “$ip” is replaced by the actual IP
address when the alert is generated.
• Anti-Spam Alerts, on page 40
• Anti-Virus Alerts, on page 41
• Directory Harvest Attack Prevention (DHAP) Alerts, on page 42
• Hardware Alerts, on page 42
• Spam Quarantine Alerts, on page 43
• Safelist/Blocklist Alerts, on page 44
• System Alerts, on page 44
• Updater Alerts, on page 54
• Outbreak Filter Alerts, on page 54
• Clustering Alerts, on page 55
Anti-Spam Alerts
The following table contains a list of the various anti-spam alerts that can be generated by AsyncOS, including
a description of the alert and the alert severity.
AS.SERVER.ALERT $engine anti-spam - $message $tb ‘engine’ - The type of anti-spam engine.
Critical. Sent when the anti-spam engine fails. ’message’ - The log message.
’tb’ - Traceback of the event.
System Administration
40
System Administration
Anti-Virus Alerts
Information. Sent when there is a problem with the ’message’ - The message
anti-spam engine.
Anti-Virus Alerts
The following table contains a list of the various Anti-Virus alerts that can be generated by AsyncOS, including
a description of the alert and the alert severity.
AV.SERVER.ALERT $engine antivirus - $message $tb ‘engine’ - The type of anti-virus engine.
/AV.SERVER.CRITICAL
Critical. Sent when there is a critical problem ’message’ - The log message.
with the anti-virus scanning engine. ’tb’ - Traceback of the event.
AV.SERVER.ALERT.INFO $engine antivirus - $message $tb ‘engine’ - The type of anti-virus engine.
AV.SERVER.ALERT.WARN $engine antivirus - $message $tb ‘engine’ - The type of anti-virus engine.
Warning. Sent when there is a problem with ’message’ - The log message.
the anti-virus scanning engine. ’tb’ - Traceback of the event.
Critical. Sent when anti-virus scanning ’what’ - The error that happened.
produces an error while scanning a message. ’tag’ - Virus outbreak name if set.
System Administration
41
System Administration
Directory Harvest Attack Prevention (DHAP) Alerts
Hardware Alerts
The following table contains a list of the various Hardware alerts that can be generated by AsyncOS, including
a description of the alert and the alert severity.
INTERFACE.ERRORS Port $port: has detected $in_err input errors, $out_err ‘port’ - Interface name.
output errors, $col collisions please check your media
’in_err’ - The number of input
settings.
errors since the last message.
Warning. Sent when interface errors are detected. ’out_err’ - The number of output
errors since the last message.
’col’ - The number of packet
collisions since the last message.
MAIL.MEASUREMENTS_FILESYSTEM The $file_system partition is at $capacity% capacity ‘file_system’ - The name of the
filesystem
Warning. Sent when a disk partition is nearing
capacity (75%). ’capacity’ - How full the
filesystem is in percent.
MAIL.MEASUREMENTS_FILESYSTEM. The $file_system partition is at $capacity% capacity ‘file_system’ - The name of the
CRITICAL filesystem
Critical. Sent when a disk partition reaches 90%
capacity (and at 95%, 96%, 97%, etc.). ’capacity’ - How full the
filesystem is in percent.
SYSTEM.RAID_EVENT_ALERT A RAID-event has occurred: $error ‘error’ - The text of the RAID
error.
Warning. Sent when a critical RAID-event occurs.
SYSTEM.RAID_EVENT_ALERT_INFO A RAID-event has occurred: $error ‘error’ - The text of the RAID
error.
Information. Sent when a RAID-event occurs.
System Administration
42
System Administration
Spam Quarantine Alerts
ISQ.CANNOT_CONNECT_OFF_BOX ISQ: Could not connect to off-box quarantine at $host:$port ‘host’ - address of off-box
quarantine
Information. Sent when AsyncOS was unable to connect to
the (off-box) IP address. ’port’ - port to connect to
on off-box quarantine
ISQ.MSG_DEL_FAILED ISQ: Failed to delete MID $mid for $rcpt: $reason ’mid’ - MID
Warning. Sent when an email is not successfully deleted from ’rcpt’ - Recipient or “all”
the spam quarantine. ’reason’ - Why the
message was not deleted
ISQ.MSG_NOTIFICATION_FAILED ISQ: Failed to send notification message: $reason ’reason’ - Why the
notification was not sent
Warning. Sent when a notification message is not successfully
sent.
ISQ.MSG_RLS_FAILED ISQ: Failed to release MID $mid to $rcpt: $reason ‘mid’ - MID
Warning. Sent when a message is not successfully released. ’rcpt’ - Recipient or “all”
’reason’ - Why the
message was not released
Warning. Sent when a message is not successfully released ’reason’ - Why the
because the recipient is unknown. message was not released
System Administration
43
System Administration
Safelist/Blocklist Alerts
ISQ.NO_EU_PROPS ISQ: Could not retrieve $user’s properties. Setting defaults ’user’ - end user name
Safelist/Blocklist Alerts
The following table contains a list of the various Safelist/Blocklist alerts that can be generated by AsyncOS,
including a description of the alert and the alert severity
SLBL.DB.RECOVERY_FAILED SLBL: Failed to recover End-User Safelist/Blocklist database: ’error’ - error reason
’$error’.
SLBL.DB.SPACE_LIMIT SLBL: End-User Safelist/Blocklist database exceeded allowed disk ’current’ - how much it has
space: $current of $limit. used, in MB
Critical. The safelist/blocklist database exceeded the allowed disk ’limit’ - the configured limit,
space. in MB
System Alerts
The following table contains a list of the various System alerts that can be generated by AsyncOS, including
a description of the alert and the alert severity.
AsyncOS API Alerts See “Alerts” section in the AsyncOS API for Cisco -
Email Security Appliances - Getting Started Guide
.
System Administration
44
System Administration
System Alerts
COMMON.APP_FAILURE An application fault occurred: $error ’error’ - The text of the error, typically a
traceback.
Warning. Sent when there is an unknown
application failure.
COMMON.KEY_EXPIRED_ Your "$feature" key has expired. Please contact ’feature’ - The name of the feature that is
ALERT your authorized Cisco sales representative. about to expire.
COMMON.KEY_EXPIRING_ Your "$feature" key will expire in under $days ’feature’ - The name of the feature that is
ALERT day(s). Please contact your authorized Cisco sales about to expire.
representative.
’days’ - The number of days it will expire.
Warning. Sent when a feature key is about to
expire.
COMMON.KEY_FINAL_EXPIRING_ This is a final notice. Your "$feature" key will ’feature’ - The name of the feature that is
ALERT expire in under $days day(s). Please contact your about to expire.
authorized Cisco sales representative.
’days’ - The number of days it will expire.
Warning. Sent as a final notice that a feature key
is about to expire.
KEYS.GRACE_EXPIRING_ All security services licenses for this Cisco Email ’days’ - The number of days remaining in
ALERT Security Appliance have expired. The appliance the grace period at the time the alert was
will continue to deliver mail without security sent.
services for $days days.
For more information about the grace
To renew security services licenses, Please contact period, see Virtual Appliance License
your authorized Cisco sales representative. Expiration , on page 12.
System Administration
45
System Administration
System Alerts
KEYS.GRACE_FINAL_EXPIRING_ This is the final notice. All security services For more information about the grace
ALERT licenses for this Cisco Email Security period, see Virtual Appliance License
Appliancehave expired. The appliance will Expiration , on page 12.
continue to deliver mail without security services
for 1 day.
To renew security services licenses, Please contact
your authorized Cisco sales representative.
KEYS.GRACE_EXPIRED_ALERT Your grace period has expired. All security sevice For more information about the grace
have expired, and your appliance is non-functional. period, see Virtual Appliance License
The appliance will no longer deliver mail until a Expiration , on page 12.
new license is applied.
To renew security services licenses, Please contact
your authorized Cisco sales representative.
System Administration
46
System Administration
System Alerts
IPBLOCKD.HOST_ADDED_TO_ The host at $ip has been added to the blacklist ’ip’ - IP address from which a login attempt
WHITELIST because of an SSH DOS attack. occurred.
IPBLOCKD.HOST_ADDED_TO_ The host at $ip has been permanently added to the
BLACKLIST ssh whitelist.
IPBLOCKD.HOST_REMOVED_ The host at $ip has been removed from the
FROM_BLACKLIST blacklist
Warning.
IP addresses that try to connect to the appliance
over SSH but do not provide valid credentials are
added to the SSH blacklist if more than 10 failed
attempts occur within two minutes.
When a user logs in successfully from the same
IP address, that IP address is added to the whitelist.
Addresses on the whitelist are allowed access even
if they are also on the blacklist.
Entries are automatically removed from the
blacklist after about a day.
LDAP.GROUP_QUERY_FAILED_ LDAP: Failed group query $name, comparison in ’name’ - The name of the query.
ALERT filter will evaluate as false
LDAP.HARD_ERROR LDAP: work queue processing error in $name ’name’ - The name of the query.
reason $why
’why’ - Why the error happened.
Critical. Sent when an LDAP query fails
completely (after trying all servers).
MAIL.FILTER.RULE_MATCH_ MID $mid matched the $rule_name rule. \n ‘mid’ - Unique identification number of
ALERT Details: $details the message.
Information. Sent every time when a Header ‘rule_name’ - The name of the rule that
Repeats rule evaluates to true . matched.
‘details’ - More information about the
message or the rule.
System Administration
47
System Administration
System Alerts
MAIL.OMH.DELIVERY_RETRY Subject - 'Alert: Message Delivery failed for ‘host’ - The host for which the DANE
$hostname. DANE verification failed for one or verification has failed.
more Domain(s).'
Message - The message delivery failed due to
DANE verification failure for all mail exchange
(MX) hosts in $hostname. The appliance will
attempt message delivery again or bounce the
message.
MAIL.RES_CON_START_ This system (hostname: $hostname) has entered a ’hostname’ - The name of the host.
ALERT. MEMORY ‘resource conservation’ mode in order to prevent
’memory_threshold_start’ - The percent
the rapid depletion of critical system resources.
threshold where memory tarpitting starts.
RAM utilization for this system has exceeded the
resource conservation threshold of ’memory_threshold_halt’ - The percent
$memory_threshold_start%. The allowed receiving threshold where the system will halt due to
rate for this system will be gradually decreased as memory being too full.
RAM utilization approaches
$memory_threshold_halt%.
MAIL.RES_CON_START_ This system (hostname: $hostname) has entered a ’hostname’ - The name of the host.
ALERT. QUEUE_SLOW ‘resource conservation’ mode in order to prevent
the rapid depletion of critical system resources.
The queue is overloaded and is unable to maintain
the current throughput.
MAIL.RES_CON_START_ This system (hostname: $hostname) has entered a ‘hostname’ - The name of the host.
ALERT. QUEUE ‘resource conservation’ mode in order to prevent
‘queue_threshold_start’ - The percent
the rapid depletion of critical system resources.
threshold where queue tarpitting starts.
Queue utilization for this system has exceeded the
resource conservation threshold of ‘queue_threshold_halt’ - The percent
$queue_threshold_start%. The allowed receiving threshold where the system will halt due to
rate for this system will be gradually decreased as the queue being too full.
queue utilization approaches
$queue_threshold_halt%.
System Administration
48
System Administration
System Alerts
MAIL.RES_CON_START_ This system (hostname: $hostname) has entered a ‘hostname’ - The name of the host.
ALERT. WORKQ ‘resource conservation’ mode in order to prevent
‘suspend_threshold’ - Work queue size
the rapid depletion of critical system resources.
above which listeners are suspended.
Listeners have been suspended because the current
work queue size has exceeded the threshold of ‘resume_threshold’ - Work queue size
$suspend_threshold. Listeners will be resumed below which listeners are resumed.
once the work queue size has dropped to
$resume_threshold. These thresholds may be
altered via use of the ‘tarpit’ command on the
system CLI.
MAIL.RES_CON_START_ This system (hostname: $hostname) has entered a ‘hostname’ - The name of the host.
ALERT ‘resource conservation’ mode in order to prevent
the rapid depletion of critical system resources.
MAIL.RES_CON_STOP_ALERT This system (hostname: $hostname) has exited ‘hostname’ - The name of the host.
‘resource conservation’ mode as resource
utilization has dropped below the conservation
threshold.
MAIL.SDS.ERROR_FETCHING_
CERTIFICATE
MAIL.WORK_QUEUE_PAUSED_ work queue paused, $num msgs, $reason ‘num’ - The number of messages in the
NATURAL work queue.
Critical. Sent when the work queue is paused.
‘reason’ - The reason the work queue is
paused.
MAIL.WORK_QUEUE_UNPAUSED_ work queue resumed, $num msgs ‘num’ - The number of messages in the
NATURAL work queue.
Critical. Sent when the work queue is resumed.
System Administration
49
System Administration
System Alerts
QUARANTINE.DB_UPDATE_ Unable to update quarantine database (current ’version’ - The schema version detected.
FAILED version: $version; target $target_version)
’target_version’ - The target schema
Critical. Sent when a quarantine database cannot version.
be updated.
QUARANTINE.DISK_SPACE_ The quarantine system is unavailable due to a lack ’file_system’ - The name of the filesystem.
LOW of space on the $file_system partition.
QUARANTINE.THRESHOLD_ Quarantine "$quarantine" is $full% full ’quarantine’ - The name of the quarantine.
ALERT
Warning. Sent when a quarantine reaches 5%, ’full’ - The percentage of how full the
50%, or 75% of capacity. quarantine is.
QUARANTINE.THRESHOLD_ Quarantine "$quarantine" is $full% full ’quarantine’ - The name of the quarantine.
ALERT.SERIOUS
Critical. Sent when a quarantine reaches 95% of ’full’ - The percentage of how full the
capacity. quarantine is.
REPORTD.DATABASE_OPEN_ The reporting system has encountered a critical ’err_msg’ - The error message raised
FAILED_ALERT error while opening the database. In order to
prevent disruption of other services, reporting has
been disabled on this machine. Please contact
customer support to have reporting enabled. The
error message is: $err_msg
REPORTD.AGGREGATION_ Processing of collected reporting data has been ’threshold’ - The threshold value
DISABLED_ALERT disabled due to lack of logging disk space. Disk
usage is above $threshold percent. Recording of
reporting events will soon become limited and
reporting data may be lost if disk space is not freed
up (by removing old logs, etc.). Once disk usage
drops below $threshold percent, full processing of
reporting data will be restarted automatically.
System Administration
50
System Administration
System Alerts
REPORTING.CLIENT.UPDATE_ Reporting Client: The reporting system has not ’duration’ - Length of time the client has
FAILED_ALERT responded for an extended period of time been trying to contact the reporting daemon.
($duration). This is a string in a human readable format
(’1h 3m 27s’).
Warning. Sent if the reporting engine was unable
to save reporting data.
PERIODIC_REPORTS.REPORT_ A failure occurred while building periodic report ‘report_title’ - the report title
TASK.BUILD_FAILURE ‘$report_title’. This subscription has been removed
from the scheduler.
PERIODIC_REPORTS.REPORT_ A failure occurred while emailing periodic report ’report_title’ - the report title
TASK.EMAIL_FAILURE ‘$report_title’. This subscription has been removed
from the scheduler.
PERIODIC_REPORTS.REPORT_ A failure occurred while archiving periodic report ’report_title’ - the report title
TASK.ARCHIVE_FAILURE ’$report_title’. This subscription has been removed
from the scheduler.
SENDERBASE.ERROR Error processing response to query $query: ’query’ - The query address.
response was $response
’response’ - Raw data of response received.
Information. Sent when an error occurred while
processing a response from SenderBase.
SMTPAUTH.FWD_SERVER_ SMTP Auth: could not reach forwarding server ’ip’ - The IP of the remote server.
FAILED_ ALERT $ip with reason: $why
’why’ - Why the error happened.
Warning. Sent when the SMTP Authentication
forwarding server is unreachable.
System Administration
51
System Administration
System Alerts
SYSTEM.HERMES_SHUTDOWN_ While preparing to ${what}, failed to stop mail ’error’ - The error that happened.
FAILURE. server gracefully: ${error}$what:=reboot
REBOOT Warning. Sent when there was a problem shutting
down the system on reboot.
SYSTEM.HERMES_SHUTDOWN_ While preparing to ${what}, failed to stop mail ’error’ - The error that happened.
FAILURE. server gracefully: ${error}$what:=shut down
SHUTDOWN Warning. Sent when there was a problem shutting
down the system.
SYSTEM.LOGIN_FAILURES_LOCK_ALERT User "$user" is locked after $numlogins 'user' - The name of the user
consecutive login failures. Last login attempt was
'numlogins' - The configured alert threshold
from $rhost
'rhost' - The address of the remote host
Information: Sent when the user account is locked
because of maximum number of failed login
attempts
SYSTEM.RCPTVALIDATION.UPDATE_ Error updating recipient validation data: $why ’why’ - The error message.
FAILED
Critical. Sent when a recipient validation update
failed.
SYSTEM.SERVICE_TUNNEL. Tech support: Service tunnel has been enabled, ’port’ - The port used for the service
ENABLED port $port tunnel.
System Administration
52
System Administration
System Alerts
IPBLOCKD.HOST_ADDED_TO_ The host at $ip has been added to the blacklist ’ip’ - IP address from which a login attempt
WHITELIST because of an SSH DOS attack. occurred.
IPBLOCKD.HOST_ADDED_TO_ The host at $ip has been permanently added to the
BLACKLIST ssh whitelist.
IPBLOCKD.HOST_REMOVED_FROM_ The host at $ip has been removed from the
BLACKLIST blacklist
Warning.
IP addresses that try to connect to the appliance
over SSH but do not provide valid credentials are
added to the SSH blacklist if more than 10 failed
attempts occur within two minutes.
When a user logs in successfully from the same
IP address, that IP address is added to the whitelist.
Addresses on the whitelist are allowed access even
if they are also on the blacklist.
Entries are automatically removed from the
blacklist after about a day.
WATCHDOG_RESTART_ALERT_ <$level>: <$class>, <$hostname>: $subject $text 'subject'- Watchdog alert subject specific
MSG to the engine
Warning.
'text' - Watchdog alert text specific to the
Cisco Email Security appliance uses the watchdog
engine
service to monitor the health condition of the
following engines:
• Anti-Spam
• Anti-Virus
• Anti Malware Protection
• Graymail
MAIL.IMH.GEODB_UPDATE_ Warning. Geolocation Update - the list of ’added’ - The following countries are
COUNTRIES' supported countries has changed. added: <iso_code1>:<country_nam
e1>,<iso_code2>:<country_name2>,
Added Countries - <$added>
’deleted’ - The following countries are
Deleted Countries - <$deleted>
deleted: <iso_code1>:<country_nam
Review your HAT sender groups, Message Filters, e1>:<iso_code2>:<country_name2>,
and Content Filters settings accordingly.
System Administration
53
System Administration
Updater Alerts
MAIL.UPDATED_SHORT_URL_DOMAIN_LIST Info. The list of shortened URL domains has been ’added_domains’: The following domains
updated.. are added: <domains_1>, <domain_2>
Added Domains: <$added_domains> ’deleted_domains’ : The following domains
are deleted: <domain_3>, <domain_4>
Deleted Domains - <$deleted_domains>
MAIL.DOMAINS_NOT_REACHABLE Warning. The following domains are not reachable <$domains>: comma separated list of
by the appliance for shortened URL support: domains
<$domains>
Check your firewall rules to allow your appliance
to connect to these domains.
Updater Alerts
The following table contains a list of the varius Updater alerts that can be generated by AsyncOS.
UPDATER.APP.UPDATE_ $app abandoning updates until a new version ‘app’ - The application name.
ABANDONED is published. The $app application tried and
‘attempts’ - The number of attempts tried.
failed $attempts times to successfully complete
an update. This may be due to a network
configuration issue or temporary outage
UPDATER.UPDATERD. The updater has been unable to communicate ‘threshold’ - Human readable threshold string.
ANIFEST_FAILED_ALERT with the update server for at least $threshold.
System Administration
54
System Administration
Clustering Alerts
VOF.GTL_THRESHOLD_ALERT Outbreak Filters Rule Update Alert:$text All rules last updated at: ’text’ - Update alert text.
$time on $date.
’time’ - Time of last update.
Information. Sent when the Outbreak Filters threshold has changed. ’date’ - Date of last update.
AS.UPDATE_FAILURE $engine update unsuccessful. This may be due to transient network ’engine’ - The engine that
or DNS issues, HTTP proxy configuration causing update failed to update.
transmission errors or unavailability of downloads.ironport.com.
’error’ - The error that
The specific error on the appliance for this failure is: $error
happened.
Warning. Sent when the anti-spam engine or CASE rules fail to
update.
Clustering Alerts
The following table contains a list of the various clustering alerts that can be generated by AsyncOS, including
a description of the alert and the alert severity.
CLUSTER.CC_ERROR. Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
AUTH_ERROR $ip - $error - $why$error:=Machine does not number of the machine.
appear to be in the cluster
’ip’ - The IP of the remote host.
Critical. Sent when there was an authentication ’why’ - Detailed text about the error.
error. This can occur if a machine is not a
member of the cluster.
CLUSTER.CC_ERROR.DROPPED Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
$ip - $error - $why$error:=Existing connection number of the machine.
dropped
’ip’ - The IP of the remote host.
Warning. Sent when the connection to the cluster ’why’ - Detailed text about the error.
was dropped.
CLUSTER.CC_ERROR.FAILED Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
$ip - $error - $why$error:=Connection failure number of the machine.
Warning. Sent when the connection to the cluster ’ip’ - The IP of the remote host.
failed. ’why’ - Detailed text about the error.
CLUSTER.CC_ERROR. Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
FORWARD_FAILED $ip - $error - $why$error:=Message forward number of the machine.
failed, no upstream connection
’ip’ - The IP of the remote host.
Critical. Sent when the appliance was unable to ’why’ - Detailed text about the error.
forward data to a machine in the cluster.
System Administration
55
System Administration
Clustering Alerts
CLUSTER.CC_ERROR.NOROUTE Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
$ip - $error - $why$error:=No route found number of the machine.
Critical. Sent when the machine was unable to ’ip’ - The IP of the remote host.
obtain a route to another machine in the cluster. ’why’ - Detailed text about the error.
CLUSTER.CC_ERROR.SSH_KEY Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
$ip - $error - $why$error:=Invalid host key number of the machine.
Critical. Sent when there was an invalid SSH ’ip’ - The IP of the remote host.
host key. ’why’ - Detailed text about the error.
CLUSTER.CC_ERROR.TIMEOUT Error connecting to cluster machine $name at IP ’name’ - The hostname and/or serial
$ip - $error - $why$error:=Operation timed out number of the machine.
Warning. Sent when the specified operation ’ip’ - The IP of the remote host.
timed out. ’why’ - Detailed text about the error.
CLUSTER.CC_ERROR_NOIP Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
$error - $why number of the machine.
Critical. Sent when the appliance could not ’why’ - Detailed text about the error.
obtain a valid IP address for another machine in
the cluster.
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
AUTH_ERROR $error - $why$error:=Machine does not appear number of the machine.
to be in the cluster
’why’ - Detailed text about the error.
Critical. Sent when there was an authentication
error connecting to a machine in a cluster. This
can occur if a machine is not a member of the
cluster.
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
DROPPED $error - $why$error:=Existing connection number of the machine.
dropped
’why’ - Detailed text about the error.
Warning. Sent when the machine was unable to
obtain a valid IP address for another machine in
the cluster and the connection to the cluster was
dropped.
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
FAILED $error - $why$error:=Connection failure number of the machine.
Warning. Sent when there was an unknown ’why’ - Detailed text about the error.
connection failure and the machine was unable
to obtain a valid IP address for another machine
in the cluster.
System Administration
56
System Administration
Changing Network Settings
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
FORWARD_FAILED $error - $why$error:=Message forward failed, number of the machine.
no upstream connection
’why’ - Detailed text about the error.
Critical. Sent when the machine was unable to
obtain a valid IP address for another machine in
the cluster and the appliance was unable to
forward data to the machine.
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
NOROUTE $error - $why$error:=No route found number of the machine.
Critical. Sent when the machine was unable to ’why’ - Detailed text about the error.
obtain a valid IP address for another machine in
the cluster and it was unable to obtain a route to
the machine.
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
SSH_KEY $error - $why$error:=Invalid host key number of the machine.
Critical. Sent when the machine was unable to ’why’ - Detailed text about the error.
obtain a valid IP address for another machine in
the cluster and was unable to obtain a valid SSH
host key.
CLUSTER.CC_ERROR_NOIP. Error connecting to cluster machine $name - ’name’ - The hostname and/or serial
TIMEOUT $error - $why$error:=Operation timed out number of the machine.
Warning. Sent when the machine was unable to ’why’ - Detailed text about the error.
obtain a valid IP address for another machine in
the cluster and the specified operation timed out.
CLUSTER.SYNC.PUSH_ALERT Overwriting $sections on machine $name ’name’ - The hostname and/or serial
number of the machine.
Critical. Sent when configuration data has gotten
out of sync and has been sent to a remote host. ’sections’ - List of cluster sections being
sent.
System Administration
57
System Administration
Changing the System Hostname
• Passphrase
• Network Access
• Login Banner
Note The new hostname does not take effect until you commit changes.
System Administration
58
System Administration
Using the Internet Root Servers
gets the shortest timeout, each subsequent priority gets a longer timeout. Further, the timeout period is roughly
60 seconds. If you have one priority, the timeout for each server at that priority will be 60 seconds. If you
have two priorities, the timeout for each server at the first priority will be 15 seconds, and each server at the
second priority will be 45 seconds. For three priorities, the timeouts are 5, 10, 45.
For example, suppose you configure four DNS servers, with two of them at priority 0, one at priority 1, and
one at priority 2:
0 1.2.3.4, 5, 5
1.2.3.5
1 1.2.3.6 10
2 1.2.3.7 45
AsyncOS will randomly choose between the two servers at priority 0. If one of the priority 0 servers is down,
the other will be used. If both of the priority 0 servers are down, the priority 1 server (1.2.3.6) is used, and
then, finally, the priority 2 (1.2.3.7) server.
The timeout period is the same for both priority 0 servers, longer for the priority 1 server, and longer still for
the priority 2 server.
Note If you choose to set the default DNS server to something other than the Internet root servers, that server must
be able to recursively resolve queries for domains for which it is not an authoritative server.
System Administration
59
System Administration
DNS Alert
You can disable the reverse DNS lookup timeout globally across all listeners by entering ‘0’ as the number
of seconds. If the value is set to 0 seconds, the reverse DNS lookup is not attempted, and instead the standard
timeout response is returned immediately. This also prevents the appliance from delivering mail to domains
that require TLS-verified connections if the receiving host’s certificate has a common name (CN) that maps
to the host’s IP lookup.
DNS Alert
Occasionally, an alert may be generated with the message “Failed to bootstrap the DNS cache” when an
appliance is rebooted. The messages means that the system was unable to contact its primary DNS servers,
which can happen at boot time if the DNS subsystem comes online before network connectivity is established.
If this message appears at other times, it could indicate network issues or that the DNS configuration is not
pointing to a valid server.
System Administration
60
System Administration
Configuring the Default Gateway
You can manage static routes via the CLI, using the routeconfig command, or use the following procedure.
System Administration
61
System Administration
Disabling SSLv3 for Enhanced Security
mail.example.com> sslv3config
Current SSLv3 Settings:
--------------------------------------------------
UPDATER : Enabled
WEBSECURITY : Enabled
EUQ : Enabled
LDAP : Enabled
--------------------------------------------------
Choose the operation you want to perform:
- SETUP - Toggle SSLv3 settings.
[]> setup
Choose the service to toggle SSLv3 settings:
1. EUQ Service
2. LDAP Service
3. Updater Service
4. Web Security Service
[1]>
Do you want to enable SSLv3 for EUQ Service ? [Y]>n
Choose the operation you want to perform:
- SETUP - Toggle SSLv3 settings.
[]>
System Time
To set the System Time on your appliance, set the Time Zone used, or select an NTP server and query interface,
use the Time Zone or Time Settings page from the System Administration menu in the GUI or use the following
commands in the CLI: ntpconfig , settime , and settz .
You can also verify the time zone files used by AsyncOS on the System Administration > Time Settings
page or using the tzupdate CLI command.
System Administration
62
System Administration
Selecting a GMT Offset
Step 1 Click Edit Settings on the System Administration > Time Zone page.
Step 2 Select a Region, country, and time zone from the pull-down menus.
Step 3 Submit and commit your changes.
Step 1 Click Edit Settings on the System Administration > Time Zone page.
Step 2 Select GMT Offset from the list of regions.
Step 3 Select an offset in the Time Zone list. The offset refers to the amount of hours that must be added/subtracted in order to
reach GMT (the Prime Meridian). Hours preceded by a minus sign (“-”) are east of the Prime Meridian. A plus sign (“+”)
indicates west of the Prime Meridian.
Step 4 Submit and commit your changes.
(Recommended) Setting Appliance System Time Using the Network Time Protocol (NTP)
This is the recommended time keeping method, especially if your appliance is integrated with other devices.
All integrated devices should use the same NTP server.
System Administration
63
System Administration
Customizing Your View
Step 3 In the Time Keeping Method section, select Set Time Manually.
Step 4 Enter the month, day, year, hour, minutes, and seconds.
Step 5 Select A.M or P.M.
Step 6 Submit and commit your changes.
To Do This
Add pages to your favorites list Navigate to the page to add, then choose Add This Page To My
Favorites from the My Favorites menu near the top right corner
of the window.
No commit is necessary for changes to My Favorites.
Reorder favorites Choose My Favorites > View All My Favorites and drag favorites
into the desired order.
Delete favorites Choose My Favorites > View All My Favorites and delete
favorites.
Go to a favorite page Choose a page from the My Favorites menu near the top right
corner of the window.
Note This feature is not available to externally-authenticated users. These users can choose a language directly
from the Options menu.
System Administration
64
System Administration
General Settings
Step 1 Log into the appliance with the user account for which you want to define preference settings.
Step 2 Choose Options > Preferences. The options menu is at the top right side of the window.
Step 3 Click Edit Preferences.
Step 4 Configure settings:
Language Display The language AsyncOS for Web uses in the web interface and CLI.
Landing Page The page that displays when the user logs into the appliance.
Reporting Time Range Displayed (default) The default time range that displays for reports on the Reporting tab.
Number of Reporting Rows Displayed The number of rows of data shown for each report by default.
General Settings
You can edit the following general settings for the appliance:
• Overriding Internet Explorer Compatibility Mode, on page 65
•
Note If enabling this feature is against your organizational policy, you may disable this feature.
System Administration
65
System Administration
Restarting and Viewing Status of Service Engines
The default value for the HTTP header field size is 4096 (4 KB) and the maximum value is 33554432 (32
MB).
mail.example.com> diagnostic
mail.example.com> diagnostic
System Administration
66
System Administration
Restarting and Viewing Status of Service Engines
System Administration
67
System Administration
Restarting and Viewing Status of Service Engines
System Administration
68