conf/actions
The conf/actions directory contains configuration files for event handlers. The name of a file is the name of the action it defines. Actions can be configured under the System > Alerting section of the Admin Server UI or by using functions under the Alerting.Action section of the the SOAP API and CLI.
Key | Description |
|---|---|
note | A description of the action. Value type: string Default value: <none> |
type | The action type. Value type: enumeration Default value: <none> Permitted values: email: E-Mail log: Log to File syslog: Log to Syslog program: Program trap: SNMP Notify or Trap soap: SOAP Callback |
Additional keys used when type is "email" | |
from | The e-mail address from which messages will appear to originate. Requires: type is set to "email" Value type: string Default value: "vTM@%hostname%" |
server | The SMTP server to which messages should be sent. This must be a valid IPv4 address or resolvable hostname (with optional port). Requires: type is set to "email" Value type: string Default value: <none> |
to | A list of e-mail addresses to which messages will be sent. Requires: type is set to "email" Value type: string Default value: <none> |
Additional keys used when type is "log" | |
file | The full path of the file to log to. The text %zeushome% will be replaced with the location where the software is installed. Requires: type is set to "log" Value type: string Default value: <none> |
Additional keys used when type is "program" | |
arg!* | An argument to pass to the program. For example, to specify that the argument --foo=bar should be passed to the program executed by this action you would set a key arg!foo to the value bar. Requires: type is set to "program" Value type: string Default value: <none> |
describe!* | A description for an argument provided to the program, this is used only for display purposes in the Admin Server UI. To give a description to the --foo example for arg!* above you would set the description text as the value for the key description!foo. Requires: type is set to "program" Value type: string Default value: <none> |
program | The program to run. Requires: type is set to "program" Value type: string Default value: <none> |
Additional keys used when type is "program", "email", or "soap" | |
timeout | How long the action can run for before it is stopped automatically (set to 0 to disable timeouts). Requires: type is set to "program", "email", or "soap" Value type: seconds Default value: "60" |
Additional keys used when type is "program", or "email" | |
verbose | Enable or disable verbose logging for this action. Requires: type is set to "program", or "email" Value type: Yes / No Default value: "No" |
Additional keys used when type is "soap" | |
additional | Additional information to send with the SOAP call. Requires: type is set to "soap" Value type: string Default value: <none> |
password | The password for HTTP basic authentication. Requires: type is set to "soap" Value type: password Default value: <none> |
proxy | The address of the server implementing the SOAP interface (For example, https://example.com). Requires: type is set to "soap" Value type: string Default value: <none> |
username | Username for HTTP basic authentication. Leave blank if you do not wish to use authentication. Requires: type is set to "soap" Value type: string Default value: <none> |
Additional keys used when type is "syslog" | |
syslog_msg_len_limit | Maximum length in bytes of a message sent to the remote syslog. Messages longer than this will be truncated before they are sent. Requires: type is set to "syslog" Value type: unsigned integer Default value: "2048" |
sysloghost | The host and optional port to send syslog messages to (if empty, messages will be sent to localhost). Requires: type is set to "syslog" Value type: string Default value: <none> |
Additional keys used when type is "trap" | |
community | The community string to use when sending a Trap over SNMPv1 or a Notify over SNMPv2c. Requires: type is set to "trap" Value type: string Default value: <none> |
snmp!auth_password | The authentication password for sending a Notify over SNMPv3. Blank to send unauthenticated traps. Requires: type is set to "trap" Value type: password Default value: <none> |
snmp!hash_alg | The hash algorithm for SNMPv3 authentication. Requires: type is set to "trap" Value type: enumeration Default value: "md5" Permitted values: md5: MD5 sha1: SHA-1 |
snmp!priv_password | The encryption password to encrypt a Notify message for SNMPv3. Requires that authentication also be configured. Blank to send unencrypted traps. Requires: type is set to "trap" Value type: password Default value: <none> |
snmp!username | The SNMP username to use to send the Notify over SNMPv3. Requires: type is set to "trap" Value type: string Default value: <none> |
snmp!version | The SNMP version to use to send the Trap/Notify. Requires: type is set to "trap" Value type: enumeration Default value: "snmpv1" Permitted values: snmpv1: SNMPv1 snmpv2c: SNMPv2c snmpv3: SNMPv3 |
traphost | The hostname or IPv4 address and optional port number that should receive traps. Requires: type is set to "trap" Value type: string Default value: <none> |