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