CLI Quick Reference Guide

This chapter contains the following sections:

Use the tables to locate the appropriate CLI command, a brief description and its availability on the C- and M- series platforms.

CLI Commands (No Commit Required)

CLI Command

Description

Platform Availability

ampstatus

Display the version of various file reputation and analysis components.

C- Series

antispamstatus

Display Anti-Spam status

C- Series

antispamupdate

Manually update spam definitions

C- Series

antivirusstatus

Display anti-virus status

C- Series

antivirusupdate

Manually update virus definitions

C- Series

archivemessage

Archives older messages in your queue.

C- Series

bouncerecipients

Bounce messages from the queue

C- and M-Series

talosupdate

Request for an update of all Talos engine

C- Series

talosstatus

Display the current version of Talos Intelligence Services module

C- Series

clearchanges or clear

Clear changes

C- and M-Series

commit

Commit changes

C- and M-Series

commitdetail

Display detailed information about the last commit

C- Series

contentscannerstatus

Display content scanner version information.

C- Series

contentscannerudpate

Request manual update of content scanner engine.

C- Series

date

Display the current date and time

C- and M- Series

daneverify

Checks whether DANE is supported for a specified domain.

C- Series

deleterecipients

Delete messages from the queue

C- and M-Series

delivernow

Reschedule messages for immediate delivery

C- and M-Series

diagnostic

Check RAID disks, network caches, and SMTP connections. Clear network caches.

C- and M-Series

dig

Look up a record on a DNS server

C- Series

displayalerts

Display the last n alerts sent by the email gateway

C- and M-Series

dlpstatus

Version information for DLP Engine

C- Series

dlpupdate

Update DLP Engine

C- Series

dnsflush

Clear all entries from the DNS cache

C-and M-Series

dnslisttest

Test a DNS lookup for a DNS-based list service

C- Series

dnsstatus

Display DNS statistics

C- and M-Series

domainrepconfig

Create a Domain Exception List

C-Series

ecstatus

Check the version of the enrollment client that is used to obtain certificates

C-Series

ecupdate

Update the enrollment client that is used to obtain certificates

C-Series

encryptionstatus

Shows the version of the PXE Engine and Domain Mappings file

C-Series

encryptionupdate

Requests an update to the PXE Engine

C-Series

enginestatus

Displays the status and CPU usage of all engines enabled on the email gateway.

C--Series

featurekey

Administer system feature keys

C- and M-Series

findevent

Find events in mail log files

C- and M-Series

fipsconfig

Configure FIPS settings

C- and M-Series

geolocationupdate

Manually update the geolocation list.

C- Series

geolocationstatus

Display the current version of the geolocation list.

C-Series

howtoupdate

Manually update the How-Tos component

C-Series

howtostatus

Display the current version of the How-Tos component

C-Series

graymailstatus

Display the details of existing graymail rules

C-Series

graymailupdate

Manually update graymail rules

C-Series

grep

Search for text in a log file

C- and M-Series

healthcheck

Checks the health of your email gateway.

C-Series

help or h or ?

Help

C- and M-Series

help vlninfo

Help support for vlninfo command

C- and M-Series

hostrate

Monitor activity for a particular host

C- and M-Series

hoststatus

Get the status of the given hostname

C-and M-Series

interclusterconfig

Perform various tasks associated with the synchronization of configuration changes between machines in different clusters simultaneously

C-Series

last

Display who has recently logged into the system

C- and M-Series

ldapflush

Flush any cached LDAP results

C- Series

ldaptest

Perform a single LDAP query test

C- Series

loadlicense

Load a virtual email gateway license

All virtual email gateways

mailconfig

Mail the current configuration to an email address

C- and M-Series

marstatus

Display the current version of the MAR component.

C- Series

marupdate

Manually update the MAR component.

C- Series

nslookup

Query a name server

C- and M-Series

netstat

Display network connections, routing tables, and network interface statistics.

C- and M-Series

outbreakflush

Clear the cached Outbreak Rules

C- Series

outbreakstatus

Display current Outbreak Rules

C- Series

outbreakupdate

Update Outbreak Filters rules

C- Series

oldmessage

displays a list of old messages in the queue.

C- Series

packetcapture

Intercept and display packets being transmitted or received over the network

C- M-Series

passphrase or passwd

Change your passphrase

C- and M-Series

ping

Ping a network host

C-and M-Series

ping6

Ping a network host using IPV6

C- and M-Series

quit or q or exit

Quit

C- and M-Series

rate

Monitor message throughput

C- and M-Series

reboot

Restart the system

C- and M-Series

redirectrecipients

Redirect all messages to another relay host

C- Series

removemessage

Removes old, undelivered messages from your queue.

C- Series

resetconfig

Restore the factory configuration defaults

C-and M-Series

resetcounters

Reset all of the counters in the system

C-and M-Series

resume

Resume receiving and deliveries

C- and M-Series

resumedel

Resume deliveries

C-and M-Series

resumelistener

Resume receiving

C-and M-Series

revert

Revert to a previous release

C- and M-Series

rollovernow

Roll over a log file

C- and M-Series

saveconfig

Saves the configuration to disk

C- and M-Series

sdrdiagnostics

Checks if your Cisco Email Security Gateway is connected to the SDR service

C- Series

settime

Manually set the system clock

C- and M-Series

showmessage

Displays old undelivered messages in your queue.

C- Series

showconfig

Display all configuration values

C- and M-Series

showlicense

Display virtual email gateway license information

All virtual email gateways

showlicense_smart

Shows Smart Licensing status and summary of status.

C-and M-Series

showrecipients

Show messages from the queue by recipient host, Envelope From address, or all messages

C- Series

shutdown

Shut down the system to power off

C-and M-Series

slblconfig

Configure Safelist/Blocklist settings

C-Series

status

System status

C- M-Series

supportrequest

Send a message to Cisco TAC

C- and M-Series

supportrequeststatus

Display Support Request Keywords version information

C- and M-Series

supportrequestupdate

Request manual update for Support Request Keywords

C-and M-Series

suspend

Suspend receiving and deliveries

C- and M-Series

suspenddel

Suspend deliveries

C- and M-Series

suspendlistener

Suspend receiving

C-and M-Series

systemsetup

First time system setup

C- Series

tail

Continuously display the end of a log file

C- and M-Series

techsupport

Allow Cisco TAC to access your system

C- and M-Series

telnet

Connect to a remote host

C- and M-Series

threatfeedstatus

Display the current version of the ETF engine

C- Series

threatfeedupdate

Manually update the ETF engine

C-Series

tophosts

Display the top hosts by queue size

C- and M-Series

topin

Display the top hosts by number of incoming connections

C- and M-Series

trace

Trace the flow of a message through the system

C- and M-Series

traceroute

Display the network route to a remote host

C- and M-Series

traceroute6

Display the network route to a remote host using IPV6.

C-and M- Series

trailblazerconfig

Routes your incoming and outgoing connections through HTTP and HTTPS ports on the new web interface of the email gateway.

C- and M- Series

tzupdate

Update timezone rules

C- and M-Series

updatenow

Update all components

C-and M-Series

upgrade

Install an upgrade

C-and M-Series

version

View system version information

C-and M-Series

vlninfo

Display the Virtual License Number (VLN), and Cisco Talos Certificate and Key details.

C-and M-Series

wipedata

Wipe the core files on the disk and check the status of the last coredump operation

C- and M-Series

websecuritydiagnostics

View diagnostic statistics for URL filtering

C- and M- Series

who

List who is logged in

C-and M-Series

whoami

Display your current user id

C-and M-Series

workqueue

Display and/or alter work queue pause status

C- Series

CLI Commands (Commit Required)

CLI Command

Description

Platform Availability

addressconfig

Configure From: addresses for system generated mail

C- and M- Series

addresslistconfig

Configure address lists

C- Series

adminaccessconfig

Configure network access list and banner login

C- Series

aggregatorconfig

Configure address of the Cisco Aggregator Server

C- Series

alertconfig

Configure email alerts

C- and M- Series

aliasconfig

Configure email aliases

C- Series

altsrchost

Configure Virtual Gatewayâ„¢ mappings

C- Series

ampconfig

Configure Advanced Malware Protection (File reputation and analysis)

C- and M- Series

antispamconfig

Configure Anti-Spam policy

C- Series

antivirusconfig

Configure anti-virus policy

C- Series

bounceconfig

Configure the behavior of bounces

C- and M- Series

bvconfig

Configure key settings for outgoing mail, and configure how to handle invalid bounces.

C- Series

callaheadconfig

Add, edit, and remove SMTP Call-Ahead profiles

C- and M- Series

certconfig

Configure security certificates and keys

C- and M- Series

cloudserviceconfig

Configure Cisco Cloud Service Portal settings and usage.

C- and M- Series

clusterconfig

Configure cluster related settings

C- Series

csaconfig

  • Enable the Cisco Secure Awareness cloud service on your email gateway.

  • View details of the Repeat Clickers list.

  • Update the Repeat Clickers list.

C- Series

csastatus

Display the current version of the Cisco Secure Awareness components.

C- Series

csaupdate

Manually update the Cisco Secure Awareness components.

C- Series

deliveryconfig

Configure mail delivery

C- Series

destconfig

Configure options for the Destination Controls Table.

C- Series

dictionaryconfig

Configure content dictionaries

C- and M- Series

diskquotaconfig

Configure disk space

C- and M- Series

dmarcconfig

Configure DMARC settings

C- Series

dnsconfig

Configure DNS setup

C- Series

dnshostprefs

Configure IPv4/IPv6 DNS preferences

C- and M- Series

dnslistconfig

Configure DNS List services support

C- Series

domainkeysconfig

Configure DomainKeys support

C- Series

ecconfig

Configure the enrollment client that is used to obtain certificates

C- and M- Series

encryptionconfig

Configure email encryption

C- Series

etherconfig

Configure Ethernet settings

C- and M- Series

exceptionconfig

Configure domain exception table

C- Series

filters

Configure message processing options

C- Series

filehashlistconfig

  • Create a file hash list for any one of the following supported file hash types – MD5 or SHA-256.

  • Create a file hash list to configure a content filter to take action on messages that contain attachments that match a particular file hash.

  • Create a file hash list to use as an exception list for the External Threat Feeds (ETF) feature.

C- Series

generalconfig

Configure browser settings and other general settings

C- and M- Series

healthconfig

Configure the threshold of various health parameters of your email gateway

C- and M- Series

imageanalysisconfig

Configure the IronPort Image Analysis settings

C- and M- Series

imsandgraymailconfig

Configure Cisco Intelligent Multi-Scan (IMS) and graymail detection and safe unsubscribe settings.

C- and M- Series

incomingrelayconfig

Configure Incoming Relays

C- Series

interfaceconfig

Configure Ethernet IP addresses

C- and M- Series

ldapconfig

Configure LDAP servers

C- Series

license_smart

Configure smart software licensing feature.

C- and M- Series

listenerconfig

Configure mail listeners

C- Series

loadconfig

Load a configuration file

C- and M- Series

localeconfig

Configure multi-lingual settings

C- Series

logconfig

Configure access to log files

C- and M- Series

ntpconfig

Configure NTP time server

C- and M- Series

oidcconfig

Configure OpenID Connect on your email gateway for AsyncOS APIs.

Delete OpenID Connect configuration settings on your email gateway.

C- and M- Series

outbreakconfig

Configure Outbreak Filters

C- Series

policyconfig

Configure per recipient or sender based policies

C- Series

portalregistrationconfig

Set Cisco Talos Email Status Portal registration ID for your email gateway.

C- Series

protectedattachmentconfig

Enable scanning of password-protected attachments in incoming or outgoing messages.

Create user-defined passphrases to open password-protected attachments in incoming or outgoing messages.

Switch priority of user-defined passphrases.

Edit user-defined passphrases.

Delete user-defined passphrases.

View user-defined passphrases.

C- Series

quarantineconfig

Configure system quarantines

C- Series

reportingconfig

Configure reporting settings

C- and M- Series

rollbackconfig

Rollback to one of the previously committed configurations

C- and M- Series

routeconfig

Configure IP routing table

C- and M- Series

safeprint

Configure safe print settings on your email gateway.

C- and M- Series

samlconfig

Configure SAML profiles with the service and indentity provider settings

C- and M- Series

scanconfig

Configure attachment scanning policy

C- Series

sdrconfig

Enable and Configure SDR filtering on your email gateway.

C- Series

sdradvancedconfig

Configure advanced parameters when connecting your email gateway to the SDR service.

C- Series

servicelogsconfig

Enable or disable Service Logs on the email gateway.

C-Series

setgateway

Set the default gateway (router)

C and M- Series

sethostname

Set the name of the machine

C- and M- Series

settz

Set the local time zone

C- and M- Series

sievechar

Configure characters for Sieve Email Filtering, as described in RFC 3598

C- Series

smartaccountinfo

View details of the smart account created in the Cisco Smart Software Manager portal

C- and M- Series

smimeconfig

Configure S/MIME functionality

C- and M- Series

smtpauthconfig

Configure SMTP Auto profiles

C- Series

smtproutes

Set up permanent domain redirections

C- and M- Series

snmpconfig

Configure SNMP

C- and M- Series

sshconfig

Configure SSH keys

C- and M- Series

sslconfig

Configure SSL settings

C- and M- Series

stripheaders

Set message headers to remove

C- Series

tcpservices

Display information about files opened by processes

C- and M- Series

textconfig

Configure text resources

C- Series

threatdefenseconfig

Configure advacned message scanning using Threat Defense

C- Series

threatfeedconfig

Enable and Configure ETF engine on your email gateway

C- Series

trackingconfig

Configure the tracking system

C- and M- Series

unsubscribe

Update the global unsubscribe list

C- and M- Series

updateconfig

Configure system update parameters

C- Series

urllistconfig

Configure allowed lists of safe URLs.

C-and M- Series

urlretroservice

Configure URL Retrospective Service engine

C- Series

userconfig

Manage user accounts and connections to external authentication sources.

C- and M- Series

websecurityadvancedconfig

Configure advanced settings for URL filtering

C-and M- Series

websecurityconfig

Configure global settings for URL filtering

C- and M- Series