Console Commands

Besides the commands listed here, there are also module-specific console commands. Links to these commands are listed in “Module-Specific Console Commands”. You can also create custom commands as described at “Custom Console Commands”.

# Note

Preceding a command with xml will output the results in XML format.

# Online Configuration Administration

• config

• module

• write config

# Information Summary

• sp_async

• binding summary

• domain

• summary

• summary reset

• signing_stats

• signing_stats reset

• threads

• unlink stats

# Queue Size Reporting

• active

• binding active

• binding delayed

• delayed

# Queue Administration per Domain

• fail domain

• fail domain quiet

• flush domain

• rebind

• reroute queue

• showqueue

# Queue Administration per Binding per Domain

• binding flush domain

• binding fail domain

• binding fail domain quiet

• rebind

• showqueue

# Message Administration

• message details

• message fail

• message fail quiet

• message retry

• spool_in

# Connections Reporting

• count

• show inbound

• show outbound

# Memory Usage Reporting

• memory

# Log Information and Manipulation

• paniclog

• reopen logs

# Utilities

• dig

• dns_cache

• help

• \pager

• pid

• refresh domain

• spool import

• spool import_poll

• sysinfo

• tls

• trace smtp

• version

# Shutting Down

• shutdown

# Custom Console Commands

In addition to the built-in console commands it is possible to create your own commands using the Lua function msys.registerControl. If, for example, you have domains that are heavily throttled and discard messages that are over the limit, you can create a console command to push emails for these domains into the delayed queue:

require("msys.core");

local function delay_domain(cc)
  local domain = cc.argv[1];
  local dr = msys.core.dns_get_domain(domain);

  if dr ~= nil then
    print ("Domain delayed as requested");
    msys.core.mail_queue_delay_domain(dr, "451 4.4.1 [internal] manually delayed domain");
  end
end

msys.registerControl("delay_domain", delay_domain);

This code creates the ec_console command: delay_domain domain . For instructions on inplementing Lua scripts see “scriptlet – Module”.