Console Commands Summary

March 26, 2020 Contributors

This table lists all console commands alphabetically giving a brief description. Click the command name to see detailed information. A module name appears in the Module column for commands that are module-specific. For module-specific commands to work, you must have the module loaded.

Command/Description Version Module Class
\pager – Page output of long console commands in the console 4.0 misc
active – Show domains with active queue size bigger than threshold 4.0 queue size
adaptive list – Display the value of shaping parameters 4.0 adaptive module
adaptive override – Override a suspension 4.0 adaptive module
adaptive reset – Clear the values of the shaping parameters 4.0 adaptive module
adaptive rules – Display the adaptive rules that are in effect for the specified domain/binding pair 4.0 adaptive module
adaptive suspensions – Summarize the suspensions that are currently in effect 4.0 adaptive module
adaptive warmup – Display the age of bindings from the perspective of the IP Warmup component 4.0 adaptive module
authz id – Display the id of the current user 4.0 misc
authz roles list – Display the currently defined roles 4.0 misc
beik reload – Reload the beik module 4.0 beik module
binding active – Show domains with active queue size bigger than threshold on a specified binding 4.0 queue size
binding delayed – Show domains with delayed queue size bigger than threshold on a specified binding 4.0 queue size
binding fail domain quiet – Fail messages for a domain on a binding without generating bounces 4.0 queue admin
binding fail domain – Fail messages for a domain on a binding with a bounce message 4.0 queue admin
binding flush domain – Perform delivery attempt on delayed queue of a domain on a binding 4.0 queue admin
binding summary – Show binding statistics 4.0 stats
bounce_classifier_override reload – Reload the bounce classification overrides 4.0 bounce_classifier_override module
bounce_classifier_override test – Test the classification of an SMTP reply 4.0 bounce_classifier_override module
bounce_logger:instance_name reopen logs – Reopen the log files 4.0 bounce_logger module
cache list – List all caches along with their associated attributes 4.0 stats
cache stat – Show detailed cache statistics for the specified cache 4.0 stats
cache stats – Show cache statistics 4.0 stats
cidrdb list – List configured CIDR databases 4.0 cidrdb module
cidrdb reload – Reload a cidrdb list 4.0 cidrdb module
cloudmark version – Output the Cloudmark version 4.0 cloudmark module
cluster abort – Abort the specified job 4.0 cluster module
cluster arp show – Resolve the MAC addresses of the cluster 4.0 cluster module
cluster duravip announce view – Announce a view update using the current local view 4.0 cluster module
cluster duravip debug – Turn DuraVIP™ debugging on or off 4.0 cluster module
cluster duravip move – Move a binding from one node to another 4.0 cluster module
cluster duravip show – Show the current state of DuraVIP™ bindings 4.0 cluster module
cluster duravip show tables – Display the DuraVIP™ state tables in XML format 4.0 cluster module
cluster help – Display the cluster console commands 4.0 cluster module
cluster info – Display the current operating status and parameters 4.0 cluster module
cluster membership – Display the current cluster nodes 4.0 cluster module
cluster nodeaddr – Show the cluster protocol service address 4.0 cluster module
cluster nodename – Show the name of the local node 4.0 cluster module
cluster reset – Reset the node cluster membership 4.0 cluster module
cluster shared list – This command displays the currently managed objects 4.0 cluster module
cluster shared show – Display shared objects 4.0 cluster module
cluster show logs – Show the size, name and location of the cluster logs 4.0 cluster module
commtouch_ctasd:instance_name pending – Output the number of pending jobs 4.0 commtouch_ctasd module
config begin from scratch – Begin a transaction from scratch 4.0 config
config begin – Begin a transaction 4.0 config
config commit – Commit a transaction 4.0 config
config eval – Determine configuration value 4.0 config
config get – Get configuration setting 4.0 config
config locate – Locate a specific scope 4.0 config
config reload – Reload configuration options from file 4.0 config
config replay – Show changes in a transaction 4.0 config
config rollback – Rollback a transaction 4.0 config
config set – Set configuration option 4.0 config
config show – Show a specific scope 4.0 config
config showrecurse – Show a specific scope and its child scopes 4.0 config
config unset – Unset configuration option 4.0 config
config writeback – Write configuration changes to ecelerity.conf 4.0 config
count – Count open connections 4.0 connections
counter add – Add the specified amount to a counter 4.0 policy
counter help – Display help for the counter command 4.0 policy
counter increment – Increment a counter 4.0 policy
counter list – List all counters counter 4.0 policy
counter reset – Reset a counter to zero 4.0 policy
counter unlink – Unlink a counter 4.0 policy
delay_dsn:instance_name show pending events – List all pending events 4.0 delay_dsn module
delayed – Show domains with delayed queue size bigger than threshold 4.0 queue admin
dig – Submit a domain for dns MX query 4.0 dns
dk_sign:instance_name flush keycache – Flush all entries from the keycache 4.0 domainkeys module
dk_sign:instance_name stats – Display statistics relating to domain key signing 4.0 domainkeys module
dns_cache lookup – Look up a query in the DNS cache 4.0 dns
dns_cache refcnts – Show the references in the DNS cache 4.0 dns
dns_cache stats – Show summary stats for the DNS cache 4.0 dns
dns_cache submit – Submit a DNS query 4.0 dns
dnsbuf interval – Change how often setsockopt() operations are performed 4.2 dnsbuf module
dnsbuf rcvbuf_size – Change the rcvbuf_size value on the fly 4.2 dnsbuf module
dnsbuf sndbuf_size – Change the sndbuf_size value on the fly 4.2 dnsbuf module
dnsbuf verify – Query active sockets for current buffer sizes and report the results 4.2 dnsbuf module
domain all – Show statistics for all domains 4.0 stats
domain – Show domain statistics 4.0 stats
ds_core flush cache_name – Flush a specific cache 4.0 ds_core module
ds_core stats – Print stats for each cache 4.0 ds_core module
ds_ldap flush connection cache – Remove all entries from the connection cache 4.0 ds_ldap module
ds_ldap show connection cache stats – Output statistics relating to the connection cache 4.0 ds_ldap module
ec_logger:instance_name help – Display the available commands 4.0 ec_logger module
ec_logger:instance_name reopen logs – Close and reopen the logs 4.0 ec_logger module
fail domain quiet – Fail messages for a domain without generating bounces 4.0 misc
fail domain – Fail messages for a domain with a bounce message 4.0 misc
fingerprint cache summary – Display the current cache size 4.0 fingerprint policy
fingerprint rejection summary – Display details related to the current inbound connection 4.0 fingerprint policy
flush domain – Perform delivery attempt on delayed queue of a domain 4.0 queue admin
help – Show help information for console commands 4.0 misc
inbound_audit add – Add a value to a CIDR in a named series 4.0 inbound_audit module
inbound_audit count_cidr – Count a CIDR in a named series 4.0 inbound_audit module
inbound_audit delete_ip – Delete an IP from a defined named series 4.0 inbound_audit module
inbound_audit help – Display the available commands 4.0 inbound_audit module
inbound_audit load – Load a series from a file 4.0 inbound_audit module
inbound_audit show all – Display verbose statistics for all domains as a CSV list 4.0 inbound_audit module
inbound_audit show ip –> – Dump all collected time-series data for the specified IP/netblock 4.0 inbound_audit module
inbound_audit subtract – Subtract a value from a CIDR in a named series 4.0 inbound_audit module
mailq – Show the status of the mail queues 4.0 stats
memory – Report detailed memory usage 4.0 stats
message details – Show detailed message information 4.0 message
message fail quiet – Fail a message and do not create a non-delivery receipt (NDR) 4.0 message
message fail – Fail a message 4.0 message
message retry – Perform an immediate delivery attempt on a message 4.0 message
module hooks – Manage loaded module hooks 4.0 module
module list – Show loaded modules 4.0 module
outbound_audit:instance_name clear all – Zero-out all statistics 4.0 outbound_audit module
outbound_audit:instance_name clear domain – Zero-out a domain’s statistics 4.0 outbound_audit module
outbound_audit:instance_name domain_list – Runtime addition/deletion of a domain in the monitoring list 4.0 outbound_audit module
outbound_audit:instance_name show all – Dump all collected time-series data for all collected domains 4.0 outbound_audit module
outbound_audit:instance_name show domain – Dump all collected time-series data for the specified domain 4.0 outbound_audit module
outbound_audit:instance_name show domains – List the names of all domains which have collected data 4.0 outbound_audit module
outbound_audit:instance_name show global – Show the global (aggregated) time-series data 4.0 outbound_audit module
paniclog – Show last several entries written to paniclog 4.0 logs
pid – Show process id of Momentum 4.0 misc
rebind – Rebind the messages in a binding or domain 4.0 queue admin
refresh domain – Refresh the DNS information for a domain 4.0 dns
reopen logs – Close and open log files 4.0 logs
reroute queue – Move messages from queues of one domain to queues of the other 4.0 queue admin
sched at – Create a recurrent command that repeats at the specified interval 4.0 sched module
sched delete – Delete a scheduled job 4.0 sched module
sched every – Create a recurrent command that repeats at the specified interval 4.0 sched module
sched in – Run a command at the specified number of seconds from the current time 4.0 sched module
sched list – List any scheduled tasks 4.0 sched module
show inbound – Show all inbound connections 4.0 connections
show outbound – Show all outbound connections 4.0 connections
showqueue – Show queue information 4.0 queue admin
shutdown – Shutdown Momentum 4.0 misc
signing_stats reset – Reset signing stats 4.0 domainkeys or opendkim stats
signing_stats – Show DK/DKIM signing stats 4.0 domainkeys or opendkim stats
sp_async – Access the asynchronous I/O subsystem 4.0 misc
spool import_poll – Check the status of a spool that is being imported 4.0 misc
spool import – Import an alternative spool 4.0 resource
spool_in – Read a message from the spool to the mail queue 4.0 message
summary reset – Reset summary statistics 4.0 stats
summary – Show global metrics 4.0 stats
sysinfo – Show system information 4.0 misc
threads cpu queue – Display summary statistics for the CPU thread pools 4.0 stats
threads io queue – Display summary statistics for the IO thread pools 4.0 stats
threads stats – Display summary statistics for thread pools 4.0 stats
tls flush cache – Flush the TLS cache 4.0 tls
tls rekey – Remove the temporary RSA key 4.0 tls
tls show cache – Show the TLS cache 4.0 tls
trace smtp add – Add an SMTP trace 4.0 misc
trace smtp list – List smtp traces 4.0 misc
trace smtp remove – Remove an SMTP trace 4.0 misc
unlink stats – Show statistics of removing messages from the disk 4.0 stats
version – Show version information of Momentum 4.0 misc
write config – Display current running configuration 4.0 config