Catalog.Monitor

URI: http://soap.zeus.com/zxtm/1.0/Catalog/Monitor/

The Catalog.Monitor interface allows management of Custom Monitors. Using this interface, you can create, delete and rename custom monitors, and manage their configuration.

Methods

addMonitors( names ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError

Add new monitors (defaults to TCP transaction monitor, monitoring each node separately).

void addMonitors(
String[] names
)

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

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

void addProgramArguments(
String[] names
Catalog.Monitor.Argument[][] arguments
)

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

Copy the named monitors.

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

deleteMonitorProgram( names ) throws ObjectDoesNotExist, DeploymentError, ObjectInUse

Delete the named monitor programs.

void deleteMonitorProgram(
String[] names
)

deleteMonitors( names ) throws ObjectDoesNotExist, InvalidOperation, DeploymentError, ObjectInUse

Delete these monitors.

void deleteMonitors(
String[] names
)

downloadMonitorProgram( name ) throws ObjectDoesNotExist

Download the named monitor program.

Binary Data downloadMonitorProgram(
String name
)

getAllMonitorNames()

Get the names of all monitors.

String[] getAllMonitorNames()

getAuthentication( names ) throws ObjectDoesNotExist, InvalidOperation

Get the authentication (user:password) that each of the named monitors should use in the test HTTP request.

String[] getAuthentication(
String[] names
)

getAuthenticationByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the authentication (user:password) that each of the named monitors should use in the test HTTP request. This is a location specific function, any action will operate on the specified location.

String[] getAuthenticationByLocation(
String location
String[] names
)

getBackOff( names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors should back-off after it has failed.

Boolean[] getBackOff(
String[] names
)

getBackOffByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors should back-off after it has failed. This is a location specific function, any action will operate on the specified location.

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

getBodyRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the body regular expression that that each of the named monitors' HTTP response must match.

String[] getBodyRegex(
String[] names
)

getBodyRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the body regular expression that that each of the named monitors' HTTP response must match. This is a location specific function, any action will operate on the specified location.

String[] getBodyRegexByLocation(
String location
String[] names
)

getCloseString( names ) throws ObjectDoesNotExist, InvalidOperation

Get an optional string that each of the named monitors should write to the server before closing the connection.

String[] getCloseString(
String[] names
)

getCloseStringByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get an optional string that each of the named monitors should write to the server before closing the connection. This is a location specific function, any action will operate on the specified location.

String[] getCloseStringByLocation(
String location
String[] names
)

getCustomMonitorNames()

Get the names of all the custom monitors.

String[] getCustomMonitorNames()

getDelay( names ) throws ObjectDoesNotExist, InvalidOperation

Get the minimum time between calls to each of the named monitors (in seconds).

Unsigned Integer[] getDelay(
String[] names
)

getDelayByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the minimum time between calls to each of the named monitors (in seconds). This is a location specific function, any action will operate on the specified location.

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

getFailures( names ) throws ObjectDoesNotExist, InvalidOperation

Get the number of failures required, by each of the named monitors, before a node is classed as unavailable.

Unsigned Integer[] getFailures(
String[] names
)

getFailuresByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the number of failures required, by each of the named monitors, before a node is classed as unavailable. This is a location specific function, any action will operate on the specified location.

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

getHealthOnly( names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors should monitor health only (ignore load).

Boolean[] getHealthOnly(
String[] names
)

getHealthOnlyByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors should monitor health only (ignore load). This is a location specific function, any action will operate on the specified location.

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

getHostHeader( names ) throws ObjectDoesNotExist, InvalidOperation

Get the host header that each of the named monitors should use in the test HTTP request.

String[] getHostHeader(
String[] names
)

getHostHeaderByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the host header that each of the named monitors should use in the test HTTP request. This is a location specific function, any action will operate on the specified location.

String[] getHostHeaderByLocation(
String location
String[] names
)

getMachine( names ) throws ObjectDoesNotExist, InvalidOperation

Get the machine that each of the named monitors should monitor (must be a valid hostname:port or a hostname for Ping monitors).

String[] getMachine(
String[] names
)

getMachineByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the machine that each of the named monitors should monitor (must be a valid hostname:port or a hostname for Ping monitors). This is a location specific function, any action will operate on the specified location.

String[] getMachineByLocation(
String location
String[] names
)

getMaxResponseLen( names ) throws ObjectDoesNotExist, InvalidOperation

Get the maximum amount of data (in bytes) that each of the named monitors should read back from a server (0 = unlimited).

Unsigned Integer[] getMaxResponseLen(
String[] names
)

getMaxResponseLenByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the maximum amount of data (in bytes) that each of the named monitors should read back from a server (0 = unlimited). This is a location specific function, any action will operate on the specified location.

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

getMonitorProgramNames()

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

String[] getMonitorProgramNames()

getNote( names ) throws ObjectDoesNotExist, InvalidOperation

Get the note for each of the named Monitors.

String[] getNote(
String[] names
)

getPath( names ) throws ObjectDoesNotExist, InvalidOperation

Get the path that each of the named monitors should use in the test HTTP request.

String[] getPath(
String[] names
)

getPathByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the path that each of the named monitors should use in the test HTTP request. This is a location specific function, any action will operate on the specified location.

String[] getPathByLocation(
String location
String[] names
)

getProgram( names ) throws ObjectDoesNotExist, InvalidOperation

Get the name of the program that each named monitor runs.

String[] getProgram(
String[] names
)

getProgramArguments( names ) throws ObjectDoesNotExist, InvalidOperation

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

Catalog.Monitor.Argument[][] getProgramArguments(
String[] names
)

getResponseRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the regular expression that each of the named monitors should match against the server response.

String[] getResponseRegex(
String[] names
)

getResponseRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the regular expression that each of the named monitors should match against the server response. This is a location specific function, any action will operate on the specified location.

String[] getResponseRegexByLocation(
String location
String[] names
)

getRtspBodyRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the body regular expression that each of the named monitors' RTSP response must match.

String[] getRtspBodyRegex(
String[] names
)

getRtspBodyRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the body regular expression that each of the named monitors' RTSP response must match. This is a location specific function, any action will operate on the specified location.

String[] getRtspBodyRegexByLocation(
String location
String[] names
)

getRtspPath( names ) throws ObjectDoesNotExist, InvalidOperation

Get the path that each of the named monitors should use in the test RTSP request.

String[] getRtspPath(
String[] names
)

getRtspPathByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the path that each of the named monitors should use in the test RTSP request. This is a location specific function, any action will operate on the specified location.

String[] getRtspPathByLocation(
String location
String[] names
)

getRtspStatusRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the status code regular expression that each of the named monitors' RTSP response must match.

String[] getRtspStatusRegex(
String[] names
)

getRtspStatusRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the status code regular expression that each of the named monitors' RTSP response must match. This is a location specific function, any action will operate on the specified location.

String[] getRtspStatusRegexByLocation(
String location
String[] names
)

getScope( names ) throws ObjectDoesNotExist, InvalidOperation

Get the scope of each named monitor.

Catalog.Monitor.Scope[] getScope(
String[] names
)

getSipBodyRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the body regular expression that that each of the named monitors' SIP response must match.

String[] getSipBodyRegex(
String[] names
)

getSipBodyRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the body regular expression that that each of the named monitors' SIP response must match. This is a location specific function, any action will operate on the specified location.

String[] getSipBodyRegexByLocation(
String location
String[] names
)

getSipStatusRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the status code regular expression that that each of the named monitors' SIP response must match.

String[] getSipStatusRegex(
String[] names
)

getSipStatusRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the status code regular expression that that each of the named monitors' SIP response must match. This is a location specific function, any action will operate on the specified location.

String[] getSipStatusRegexByLocation(
String location
String[] names
)

getSipTransport( names ) throws ObjectDoesNotExist, InvalidOperation

Get the transport protocol that the monitor will use

Catalog.Monitor.SipTransport[] getSipTransport(
String[] names
)

getSipTransportByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the transport protocol that the monitor will use This is a location specific function, any action will operate on the specified location.

Catalog.Monitor.SipTransport[] getSipTransportByLocation(
String location
String[] names
)

getStatusRegex( names ) throws ObjectDoesNotExist, InvalidOperation

Get the status code regular expression that that each of the named monitors' HTTP response must match.

String[] getStatusRegex(
String[] names
)

getStatusRegexByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the status code regular expression that that each of the named monitors' HTTP response must match. This is a location specific function, any action will operate on the specified location.

String[] getStatusRegexByLocation(
String location
String[] names
)

getTimeout( names ) throws ObjectDoesNotExist, InvalidOperation

Get the maximum time that an individual instance, of each of the named monitors, is allowed to run for (in seconds).

Unsigned Integer[] getTimeout(
String[] names
)

getTimeoutByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the maximum time that an individual instance, of each of the named monitors, is allowed to run for (in seconds). This is a location specific function, any action will operate on the specified location.

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

getType( names ) throws ObjectDoesNotExist, InvalidOperation

Get the internal monitor type to use for each named monitor.

Catalog.Monitor.Type[] getType(
String[] names
)

getUDPAcceptAll( names ) throws ObjectDoesNotExist, InvalidOperation

Get if the monitor should accept responses from any IP and port. UDP monitors only.

Boolean[] getUDPAcceptAll(
String[] names
)

getUDPAcceptAllByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get if the monitor should accept responses from any IP and port. UDP monitors only. This is a location specific function, any action will operate on the specified location.

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

getUseSSL( names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors can connect using SSL.

Boolean[] getUseSSL(
String[] names
)

getUseSSLByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors can connect using SSL. This is a location specific function, any action will operate on the specified location.

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

getVerbose( names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors should emit verbose logging (useful for diagnostics).

Boolean[] getVerbose(
String[] names
)

getVerboseByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get whether each of the named monitors should emit verbose logging (useful for diagnostics). This is a location specific function, any action will operate on the specified location.

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

getWriteString( names ) throws ObjectDoesNotExist, InvalidOperation

Get the string that each of the named monitors should write down the TCP connection.

String[] getWriteString(
String[] names
)

getWriteStringByLocation( location, names ) throws ObjectDoesNotExist, InvalidOperation

Get the string that each of the named monitors should write down the TCP connection. This is a location specific function, any action will operate on the specified location.

String[] getWriteStringByLocation(
String location
String[] names
)

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

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

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

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

Rename these monitors.

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

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

Set the authentication (user:password) that each of the named monitors should use in the test HTTP request.

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

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

Set the authentication (user:password) that each of the named monitors should use in the test HTTP request. This is a location specific function, any action will operate on the specified location.

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

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

Set whether each of the named monitors should back-off after it has failed.

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

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

Set whether each of the named monitors should back-off after it has failed. This is a location specific function, any action will operate on the specified location.

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

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

Set the body regular expression that that each of the named monitors' HTTP response must match.

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

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

Set the body regular expression that that each of the named monitors' HTTP response must match. This is a location specific function, any action will operate on the specified location.

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

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

Set an optional string that each of the named monitors should write to the server before closing the connection.

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

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

Set an optional string that each of the named monitors should write to the server before closing the connection. This is a location specific function, any action will operate on the specified location.

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

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

Set the minimum time between calls to each of the named monitors (in seconds).

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

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

Set the minimum time between calls to each of the named monitors (in seconds). This is a location specific function, any action will operate on the specified location.

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

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

Set the number of failures required, by each of the named monitors, before a node is classed as unavailable.

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

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

Set the number of failures required, by each of the named monitors, before a node is classed as unavailable. This is a location specific function, any action will operate on the specified location.

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

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

Set whether each of the named monitors should monitor health only (ignore load).

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

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

Set whether each of the named monitors should monitor health only (ignore load). This is a location specific function, any action will operate on the specified location.

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

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

Set the host header that each of the named monitors should use in the test HTTP request.

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

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

Set the host header that each of the named monitors should use in the test HTTP request. This is a location specific function, any action will operate on the specified location.

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

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

Set the machine that each of the named monitors should monitor (must be a valid hostname:port or a hostname for Ping monitors).

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

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

Set the machine that each of the named monitors should monitor (must be a valid hostname:port or a hostname for Ping monitors). This is a location specific function, any action will operate on the specified location.

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

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

Set the maximum amount of data (in bytes) that each of the named monitors should read back from a server (0 = unlimited).

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

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

Set the maximum amount of data (in bytes) that each of the named monitors should read back from a server (0 = unlimited). This is a location specific function, any action will operate on the specified location.

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

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

Set the note for each of the named Monitors.

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

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

Set the path that each of the named monitors should use in the test HTTP request.

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

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

Set the path that each of the named monitors should use in the test HTTP request. This is a location specific function, any action will operate on the specified location.

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

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

Set the name of the program that each named monitor runs.

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

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

Set the regular expression that each of the named monitors should match against the server response.

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

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

Set the regular expression that each of the named monitors should match against the server response. This is a location specific function, any action will operate on the specified location.

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

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

Set the body regular expression that each of the named monitors' RTSP response must match.

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

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

Set the body regular expression that each of the named monitors' RTSP response must match. This is a location specific function, any action will operate on the specified location.

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

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

Set the path that each of the named monitors should use in the test RTSP request.

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

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

Set the path that each of the named monitors should use in the test RTSP request. This is a location specific function, any action will operate on the specified location.

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

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

Set the status code regular expression that each of the named monitors' RTSP response must match.

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

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

Set the status code regular expression that each of the named monitors' RTSP response must match. This is a location specific function, any action will operate on the specified location.

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

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

Set the scope of each named monitor.

void setScope(
String[] names
Catalog.Monitor.Scope[] values
)

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

Set the body regular expression that that each of the named monitors' SIP response must match.

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

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

Set the body regular expression that that each of the named monitors' SIP response must match. This is a location specific function, any action will operate on the specified location.

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

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

Set the status code regular expression that that each of the named monitors' SIP response must match.

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

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

Set the status code regular expression that that each of the named monitors' SIP response must match. This is a location specific function, any action will operate on the specified location.

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

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

Set the transport protocol that the monitor will use

void setSipTransport(
String[] names
Catalog.Monitor.SipTransport[] values
)

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

Set the transport protocol that the monitor will use This is a location specific function, any action will operate on the specified location.

void setSipTransportByLocation(
String location
String[] names
Catalog.Monitor.SipTransport[] values
)

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

Set the status code regular expression that that each of the named monitors' HTTP response must match.

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

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

Set the status code regular expression that that each of the named monitors' HTTP response must match. This is a location specific function, any action will operate on the specified location.

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

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

Set the maximum time that an individual instance, of each of the named monitors, is allowed to run for (in seconds).

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

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

Set the maximum time that an individual instance, of each of the named monitors, is allowed to run for (in seconds). This is a location specific function, any action will operate on the specified location.

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

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

Set the internal monitor type to use for each named monitor.

void setType(
String[] names
Catalog.Monitor.Type[] values
)

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

Set if the monitor should accept responses from any IP and port. UDP monitors only.

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

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

Set if the monitor should accept responses from any IP and port. UDP monitors only. This is a location specific function, any action will operate on the specified location.

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

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

Set whether each of the named monitors can connect using SSL.

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

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

Set whether each of the named monitors can connect using SSL. This is a location specific function, any action will operate on the specified location.

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

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

Set whether each of the named monitors should emit verbose logging (useful for diagnostics).

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

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

Set whether each of the named monitors should emit verbose logging (useful for diagnostics). This is a location specific function, any action will operate on the specified location.

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

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

Set the string that each of the named monitors should write down the TCP connection.

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

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

Set the string that each of the named monitors should write down the TCP connection. This is a location specific function, any action will operate on the specified location.

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

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

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

void updateProgramArguments(
String[] names
String[][] argument_names
Catalog.Monitor.Argument[][] new_arguments
)

uploadMonitorProgram( name, content ) throws InvalidObjectName, DeploymentError

Uploads a monitor program, overwriting the file if it already exists.

void uploadMonitorProgram(
String name
Binary Data content
)

Structures

Catalog.Monitor.Argument

An argument that is added to the command line when the monitor program is run

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

Enumerations

Catalog.Monitor.Scope

enum Catalog.Monitor.Scope {
# Node: Monitor each node in the pool separately
pernode,
# Pool/GLB: Monitor a specified machine
poolwide
}

Catalog.Monitor.SipTransport

enum Catalog.Monitor.SipTransport {
# UDP
udp,
# TCP
tcp
}

Catalog.Monitor.Type

enum Catalog.Monitor.Type {
# Ping monitor
ping,
# TCP Connect monitor
connect,
# HTTP monitor
http,
# TCP transaction monitor
tcp_transaction,
# External program monitor
program,
# SIP monitor
sip,
# RTSP monitor
rtsp
}