Alerting.Action

URI: http://soap.zeus.com/zxtm/1.0/Alerting/Action/

Alerting.Action is an interface that allows you to add actions that are run by event types.

Methods

addAction( names, types ) throws InvalidInput, ObjectAlreadyExists, InvalidObjectName, DeploymentError

Add a action that can be run by an event.

void addAction(
String[] names
Alerting.Action.Type[] types
)

addScriptArguments( names, arguments ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Adds a set of arguments to the specified actions. The actions specified must be of type 'program'.

void addScriptArguments(
String[] names
Alerting.Action.Argument[][] arguments
)

copyAction( names, new_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError

Copy each of the named actions.

void copyAction(
String[] names
String[] new_names
)

deleteAction( names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError

Deletes each of the named actions.

void deleteAction(
String[] names
)

deleteActionProgram( names ) throws ObjectDoesNotExist, DeploymentError, ObjectInUse

Delete the named action programs.

void deleteActionProgram(
String[] names
)

downloadActionProgram( name ) throws ObjectDoesNotExist

Download the named action program.

Binary Data downloadActionProgram(
String name
)

getActionNames()

Get the names of all available actions.

String[] getActionNames()

getActionNamesOfType( type )

Get the names of all actions of the specified type.

String[] getActionNamesOfType(
Alerting.Action.Type type
)

getActionProgramNames()

Get the names of all the uploaded action programs. These are the programs that can be executed by custom program actions.

String[] getActionProgramNames()

getActionType( names ) throws InvalidOperation, ObjectDoesNotExist

Returns the type of each of the named actions.

Alerting.Action.Type[] getActionType(
String[] names
)

getEmailRecipients( names ) throws InvalidOperation, ObjectDoesNotExist

Get the address the alert emails are sent from.

String[] getEmailRecipients(
String[] names
)

getEmailRecipientsByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the address the alert emails are sent from. This is a location specific function, any action will operate on the specified location.

String[] getEmailRecipientsByLocation(
String location
String[] names
)

getEmailSMTPServer( names ) throws InvalidOperation, ObjectDoesNotExist

Get the SMTP server used to send alert emails for the specified actions.

String[] getEmailSMTPServer(
String[] names
)

getEmailSMTPServerByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the SMTP server used to send alert emails for the specified actions. This is a location specific function, any action will operate on the specified location.

String[] getEmailSMTPServerByLocation(
String location
String[] names
)

getEmailSender( names ) throws InvalidOperation, ObjectDoesNotExist

Get the specified email addresses to the recipient list for the specified actions.

String[] getEmailSender(
String[] names
)

getEmailSenderByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the specified email addresses to the recipient list for the specified actions. This is a location specific function, any action will operate on the specified location.

String[] getEmailSenderByLocation(
String location
String[] names
)

getLogFilePath( names ) throws InvalidOperation, ObjectDoesNotExist

Get the file this action logs to.

String[] getLogFilePath(
String[] names
)

getLogFilePathByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the file this action logs to. This is a location specific function, any action will operate on the specified location.

String[] getLogFilePathByLocation(
String location
String[] names
)

getSNMPHashAlg( names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP hash algorithm for sending the Notify over SNMPv3. Valid values are "md5" and "sha1". The actions specified must be of type 'trap'.

Alerting.Action.SNMPHashAlg[] getSNMPHashAlg(
String[] names
)

getSNMPHashAlgByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP hash algorithm for sending the Notify over SNMPv3. Valid values are "md5" and "sha1". The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

Alerting.Action.SNMPHashAlg[] getSNMPHashAlgByLocation(
String location
String[] names
)

getSNMPUsername( names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP username for sending the Notify over SNMPv3. The actions specified must be of type 'trap'.

String[] getSNMPUsername(
String[] names
)

getSNMPUsernameByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP username for sending the Notify over SNMPv3. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

String[] getSNMPUsernameByLocation(
String location
String[] names
)

getSNMPVersion( names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP version used to send the trap/notify. The actions specified must be of type 'trap'.

Alerting.Action.SNMPVersion[] getSNMPVersion(
String[] names
)

getSNMPVersionByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP version used to send the trap/notify. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

Alerting.Action.SNMPVersion[] getSNMPVersionByLocation(
String location
String[] names
)

getSOAPAdditional( names ) throws InvalidOperation, ObjectDoesNotExist

Get the additional information to send with the SOAP alert call.

String[] getSOAPAdditional(
String[] names
)

getSOAPAdditionalByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the additional information to send with the SOAP alert call. This is a location specific function, any action will operate on the specified location.

String[] getSOAPAdditionalByLocation(
String location
String[] names
)

getSOAPAuthentication( names ) throws InvalidOperation, ObjectDoesNotExist

Gets the username used to log in with HTTP basic authentication. The actions specified must be of type 'soap'. Note that the password field is always returned as an empty string.

Alerting.Action.Login[] getSOAPAuthentication(
String[] names
)

getSOAPAuthenticationByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Gets the username used to log in with HTTP basic authentication. The actions specified must be of type 'soap'. Note that the password field is always returned as an empty string. This is a location specific function, any action will operate on the specified location.

Alerting.Action.Login[] getSOAPAuthenticationByLocation(
String location
String[] names
)

getSOAPProxy( names ) throws InvalidOperation, ObjectDoesNotExist

Get the server the SOAP event call will be made to for each of the specified SOAP events.

String[] getSOAPProxy(
String[] names
)

getSOAPProxyByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the server the SOAP event call will be made to for each of the specified SOAP events. This is a location specific function, any action will operate on the specified location.

String[] getSOAPProxyByLocation(
String location
String[] names
)

getScriptArguments( names ) throws InvalidOperation, ObjectDoesNotExist

Gets all arguments for the specified script actions. The actions specified must be of type 'program'.

Alerting.Action.Argument[][] getScriptArguments(
String[] names
)

getScriptProgram( names ) throws InvalidOperation, ObjectDoesNotExist

Get the program to run including its command line arguments. The actions specified must be of type 'program'.

String[] getScriptProgram(
String[] names
)

getSyslogHost( names ) throws InvalidOperation, ObjectDoesNotExist

Get the host to send syslog messages to (if empty, messages will be sent to localhost). The actions specified must be of type 'syslog'.

String[] getSyslogHost(
String[] names
)

getSyslogHostByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the host to send syslog messages to (if empty, messages will be sent to localhost). The actions specified must be of type 'syslog'. This is a location specific function, any action will operate on the specified location.

String[] getSyslogHostByLocation(
String location
String[] names
)

getSyslogMessageLenLimit( names ) throws InvalidOperation, ObjectDoesNotExist

Get syslog message length limit.

Unsigned Integer[] getSyslogMessageLenLimit(
String[] names
)

getSyslogMessageLenLimitByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get syslog message length limit. This is a location specific function, any action will operate on the specified location.

Unsigned Integer[] getSyslogMessageLenLimitByLocation(
String location
String[] names
)

getTimeout( names ) throws InvalidOperation, ObjectDoesNotExist

Get how long an action has to run, in seconds (set to 0 disable timing out).

Unsigned Integer[] getTimeout(
String[] names
)

getTimeoutByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get how long an action has to run, in seconds (set to 0 disable timing out). This is a location specific function, any action will operate on the specified location.

Unsigned Integer[] getTimeoutByLocation(
String location
String[] names
)

getTrapCommunity( names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP community string for the SNMP trap. The actions specified must be of type 'trap'.

String[] getTrapCommunity(
String[] names
)

getTrapCommunityByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the SNMP community string for the SNMP trap. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

String[] getTrapCommunityByLocation(
String location
String[] names
)

getTrapHost( names ) throws InvalidOperation, ObjectDoesNotExist

Get the hostname or IPv4 address and optional port number that should receive the SNMP trap. The actions specified must be of type 'trap'.

String[] getTrapHost(
String[] names
)

getTrapHostByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get the hostname or IPv4 address and optional port number that should receive the SNMP trap. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

String[] getTrapHostByLocation(
String location
String[] names
)

getVerbose( names ) throws InvalidOperation, ObjectDoesNotExist

Get if verbose logging is enabled for this action.

Boolean[] getVerbose(
String[] names
)

getVerboseByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist

Get if verbose logging is enabled for this action. This is a location specific function, any action will operate on the specified location.

Boolean[] getVerboseByLocation(
String location
String[] names
)

removeSOAPAuthentication( names ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Disables using HTTP basic authentication with the SOAP Call. The actions specified must be of type 'soap'.

void removeSOAPAuthentication(
String[] names
)

removeSOAPAuthenticationByLocation( location, names ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Disables using HTTP basic authentication with the SOAP Call. The actions specified must be of type 'soap'. This is a location specific function, any action will operate on the specified location.

void removeSOAPAuthenticationByLocation(
String location
String[] names
)

removeScriptArguments( names, arguments ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Removes a set of arguments from the specified script actions. The actions specified must be of type 'program'.

void removeScriptArguments(
String[] names
String[][] arguments
)

renameAction( names, new_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation

Rename each of the named actions.

void renameAction(
String[] names
String[] new_names
)

setEmailRecipients( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the address the alert emails are sent from.

void setEmailRecipients(
String[] names
String[] values
)

setEmailRecipientsByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the address the alert emails are sent from. This is a location specific function, any action will operate on the specified location.

void setEmailRecipientsByLocation(
String location
String[] names
String[] values
)

setEmailSMTPServer( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SMTP server used to send alert emails for the specified actions.

void setEmailSMTPServer(
String[] names
String[] values
)

setEmailSMTPServerByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SMTP server used to send alert emails for the specified actions. This is a location specific function, any action will operate on the specified location.

void setEmailSMTPServerByLocation(
String location
String[] names
String[] values
)

setEmailSender( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the specified email addresses to the recipient list for the specified actions.

void setEmailSender(
String[] names
String[] values
)

setEmailSenderByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the specified email addresses to the recipient list for the specified actions. This is a location specific function, any action will operate on the specified location.

void setEmailSenderByLocation(
String location
String[] names
String[] values
)

setLogFilePath( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the file this action logs to.

void setLogFilePath(
String[] names
String[] values
)

setLogFilePathByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the file this action logs to. This is a location specific function, any action will operate on the specified location.

void setLogFilePathByLocation(
String location
String[] names
String[] values
)

setSNMPAuthPassword( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP password for sending the Notify over SNMPv3. The actions specified must be of type 'trap'.

void setSNMPAuthPassword(
String[] names
String[] values
)

setSNMPAuthPasswordByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP password for sending the Notify over SNMPv3. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setSNMPAuthPasswordByLocation(
String location
String[] names
String[] values
)

setSNMPHashAlg( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP hash algorithm for sending the Notify over SNMPv3. Valid values are "md5" and "sha1". The actions specified must be of type 'trap'.

void setSNMPHashAlg(
String[] names
Alerting.Action.SNMPHashAlg[] values
)

setSNMPHashAlgByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP hash algorithm for sending the Notify over SNMPv3. Valid values are "md5" and "sha1". The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setSNMPHashAlgByLocation(
String location
String[] names
Alerting.Action.SNMPHashAlg[] values
)

setSNMPPrivPassword( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP encryption key to encrpt SNMPv3 Notify messages. The actions specified must be of type 'trap'.

void setSNMPPrivPassword(
String[] names
String[] values
)

setSNMPPrivPasswordByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP encryption key to encrpt SNMPv3 Notify messages. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setSNMPPrivPasswordByLocation(
String location
String[] names
String[] values
)

setSNMPUsername( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP username for sending the Notify over SNMPv3. The actions specified must be of type 'trap'.

void setSNMPUsername(
String[] names
String[] values
)

setSNMPUsernameByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP username for sending the Notify over SNMPv3. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setSNMPUsernameByLocation(
String location
String[] names
String[] values
)

setSNMPVersion( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP version used to send the trap/notify. The actions specified must be of type 'trap'.

void setSNMPVersion(
String[] names
Alerting.Action.SNMPVersion[] values
)

setSNMPVersionByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP version used to send the trap/notify. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setSNMPVersionByLocation(
String location
String[] names
Alerting.Action.SNMPVersion[] values
)

setSOAPAdditional( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the additional information to send with the SOAP alert call.

void setSOAPAdditional(
String[] names
String[] values
)

setSOAPAdditionalByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the additional information to send with the SOAP alert call. This is a location specific function, any action will operate on the specified location.

void setSOAPAdditionalByLocation(
String location
String[] names
String[] values
)

setSOAPAuthentication( names, credentials ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Sets the username and password to use to log in with HTTP basic authentication. The actions specified must be of type 'soap'.

void setSOAPAuthentication(
String[] names
Alerting.Action.Login[] credentials
)

setSOAPAuthenticationByLocation( location, names, credentials ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Sets the username and password to use to log in with HTTP basic authentication. The actions specified must be of type 'soap'. This is a location specific function, any action will operate on the specified location.

void setSOAPAuthenticationByLocation(
String location
String[] names
Alerting.Action.Login[] credentials
)

setSOAPProxy( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the server the SOAP event call will be made to for each of the specified SOAP events.

void setSOAPProxy(
String[] names
String[] values
)

setSOAPProxyByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the server the SOAP event call will be made to for each of the specified SOAP events. This is a location specific function, any action will operate on the specified location.

void setSOAPProxyByLocation(
String location
String[] names
String[] values
)

setScriptProgram( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the program to run including its command line arguments. The actions specified must be of type 'program'.

void setScriptProgram(
String[] names
String[] values
)

setSyslogHost( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the host to send syslog messages to (if empty, messages will be sent to localhost). The actions specified must be of type 'syslog'.

void setSyslogHost(
String[] names
String[] values
)

setSyslogHostByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the host to send syslog messages to (if empty, messages will be sent to localhost). The actions specified must be of type 'syslog'. This is a location specific function, any action will operate on the specified location.

void setSyslogHostByLocation(
String location
String[] names
String[] values
)

setSyslogMessageLenLimit( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set syslog message length limit.

void setSyslogMessageLenLimit(
String[] names
Unsigned Integer[] values
)

setSyslogMessageLenLimitByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set syslog message length limit. This is a location specific function, any action will operate on the specified location.

void setSyslogMessageLenLimitByLocation(
String location
String[] names
Unsigned Integer[] values
)

setTimeout( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set how long an action has to run, in seconds (set to 0 disable timing out).

void setTimeout(
String[] names
Unsigned Integer[] values
)

setTimeoutByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set how long an action has to run, in seconds (set to 0 disable timing out). This is a location specific function, any action will operate on the specified location.

void setTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)

setTrapCommunity( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP community string for the SNMP trap. The actions specified must be of type 'trap'.

void setTrapCommunity(
String[] names
String[] values
)

setTrapCommunityByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the SNMP community string for the SNMP trap. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setTrapCommunityByLocation(
String location
String[] names
String[] values
)

setTrapHost( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the hostname or IPv4 address and optional port number that should receive the SNMP trap. The actions specified must be of type 'trap'.

void setTrapHost(
String[] names
String[] values
)

setTrapHostByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set the hostname or IPv4 address and optional port number that should receive the SNMP trap. The actions specified must be of type 'trap'. This is a location specific function, any action will operate on the specified location.

void setTrapHostByLocation(
String location
String[] names
String[] values
)

setVerbose( names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set if verbose logging is enabled for this action.

void setVerbose(
String[] names
Boolean[] values
)

setVerboseByLocation( location, names, values ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Set if verbose logging is enabled for this action. This is a location specific function, any action will operate on the specified location.

void setVerboseByLocation(
String location
String[] names
Boolean[] values
)

testAction( names ) throws ObjectDoesNotExist

Sends a test event to the named actions to confirm that they are working as expected.

void testAction(
String[] names
)

updateScriptArguments( names, argument_names, new_arguments ) throws InvalidOperation, ObjectDoesNotExist, InvalidInput, DeploymentError

Allows arguments for the the specified script actions to be changed. The actions specified must be of type 'program'.

void updateScriptArguments(
String[] names
String[][] argument_names
Alerting.Action.Argument[][] new_arguments
)

uploadActionProgram( name, content ) throws InvalidObjectName, DeploymentError

Uploads an action program, overwriting the file if it already exists.

void uploadActionProgram(
String name
Binary Data content
)

Structures

Alerting.Action.Argument

An argument that is added to the command line when the script is run

struct Alerting.Action.Argument {
# The name of the argument.
String name;
# The value of the argument.
String value;
# A description of the argument.
String description;
}

Alerting.Action.Login

An argument that is added to the command line when the script is run

struct Alerting.Action.Login {
# The username for basic SOAP authentication
String username;
# The username for basic SOAP authentication
String password;
}

Enumerations

Alerting.Action.SNMPHashAlg

enum Alerting.Action.SNMPHashAlg {
# MD5
md5,
# SHA-1
sha1
}

Alerting.Action.SNMPVersion

enum Alerting.Action.SNMPVersion {
# SNMPv1
snmpv1,
# SNMPv2c
snmpv2c,
# SNMPv3
snmpv3
}

Alerting.Action.Type

enum Alerting.Action.Type {
# Sends e-mails to a set of e-mail addresses.
email,
# Reports event information to a remote server using the SOAP protocol.
soap,
# Sends an SNMP message to a remote server.
trap,
# Writes a log line in the syslog.
syslog,
# Writes a log line in a named file.
log,
# Executes an external program.
program
}