---
title: Catalog.Monitor
slug: ps/help/en_us/vtm/controlapi/catalogmonitor
docTags: 
createdAt: 2026-08-02T08:52:21.873Z
---

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).

```bash
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'.

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

### copyMonitors( names, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError

Copy the named monitors.

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

### deleteMonitorProgram( names ) throws ObjectDoesNotExist, DeploymentError, ObjectInUse

Delete the named monitor programs.

```bash
void deleteMonitorProgram(
String[] names
)
```

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

Delete these monitors.

```bash
void deleteMonitors(
String[] names
)
```

### downloadMonitorProgram( name ) throws ObjectDoesNotExist

Download the named monitor program.

```bash
Binary Data downloadMonitorProgram(
String name
)
```

### getAllMonitorNames()

Get the names of all monitors.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

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

### getCustomMonitorNames()

Get the names of all the custom monitors.

```bash
String[] getCustomMonitorNames()
```

### getDelay( names ) throws ObjectDoesNotExist, InvalidOperation

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

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
String[] getMonitorProgramNames()
```

### getNote( names ) throws ObjectDoesNotExist, InvalidOperation

Get the note for each of the named Monitors.

```bash
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.

```bash
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.

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

### getProgram( names ) throws ObjectDoesNotExist, InvalidOperation

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

```bash
String[] getProgram(
String[] names
)
```

### getProgramArguments( names ) throws ObjectDoesNotExist, InvalidOperation

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

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

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

### getScope( names ) throws ObjectDoesNotExist, InvalidOperation

Get the scope of each named monitor.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

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

### getSipTransport( names ) throws ObjectDoesNotExist, InvalidOperation

Get the transport protocol that the monitor will use

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

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

### getType( names ) throws ObjectDoesNotExist, InvalidOperation

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

```bash
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.

```bash
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.

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

### getUseSSL( names ) throws ObjectDoesNotExist, InvalidOperation

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

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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'.

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

### renameMonitors( names, new\_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation

Rename these monitors.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

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

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

Set the scope of each named monitor.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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).

```bash
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.

```bash
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.

```bash
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.

```bash
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'.

```bash
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.

```bash
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

```bash
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

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

### Catalog.Monitor.SipTransport

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

### Catalog.Monitor.Type

```bash
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
}
```