Queue Snoop

Start Snooping on a Queue

Starts snooping on events on a queue for a specific user.

Syntax

To start snooping on events on a queue for a specific user:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues startSnoop name=queueName user=userName

To start snooping on events on a queue for a specific user with filtering criteria:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues startSnoop name=queueName user=userName [fromeid=firstEventId]
[toeid=lastEventId] [filter=filterString]

Arguments and Options

nodeAlias: Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName: Required. The ID of the Universal Messaging server instance on which you want to start snooping.
name=queueName: Required. The name of the queue on which you want to snoop.
user=userName: Required. The username of the user for whom you want to start snooping.
[fromeid=firstEventId]: Optional. The ID of the first event in the event range on which you want to start snooping.
[toeid=lastEventId]: Optional. The ID of the last event in the event range on which you want to start snooping.
[filter=filterString]: Optional. Additional filtering criteria based on the properties of the event.

Usage Notes

When you want to start snooping on a range of events:

If you do not specify fromeid, the range of events starts with the first event on the queue and ends with the event specified for toeid.
If you do not specify toeid, the range of events starts with the event specified for fromeid and ends with the last event on the queue.

Examples

To start snooping on events on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
```
sagcc exec administration component sag01 Universal-Messaging-umserver
queues startSnoop name=queue1 user=Administrator
```
To start snooping on the events with IDs from "2" to "10" on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
```
sagcc exec administration component sag01 Universal-Messaging-umserver
queues startSnoop name=queue1 user=Administrator fromid=2 toid=10
```

List Snooped Events on a Queue

Edit online

Lists the snooped events on a queue for a specific user in TSV, XML, or JSON format.

Syntax

To list the snooped events on a queue for a specific user in TSV format:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues snoop name=queueName user=userName

To list the snooped events on a queue for a specific user in XML or JSON format:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues snoop name=queueName user=userName {--format|-f} {xml|json}

Arguments and Options

nodeAlias: Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName: Required. The ID of the Universal Messaging server instance for which you want to list snooped events.
name=queueName: Required. The name of the queue for which you want to list snooped events.
user=userName: Required. The username of the user for whom you want to list snooped events.
[{--format|-f} {xml|json}]: Optional. Whether to list the snooped events in XML or JSON format.

Usage Notes

If the Universal Messaging server becomes unavailable after the snoop on the queue started, Command Central stops snooping on all queues on that Universal Messaging server for all Command Central users. If you run the command that lists snooped events while the Universal Messaging server is unavailable, the system returns "snoopStarted=false" and an empty list of events.

Examples

To list the snooped events in TSV format on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
```
sagcc exec administration component sag01 Universal-Messaging-umserver
queues snoop name=queue1 user=Administrator
```
To list the snooped events in JSON format on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
```
sagcc exec administration component sag01 Universal-Messaging-umserver
queues snoop name=queue1 user=Administrator --format json
```

View Details of a Snooped Event on a Queue

Edit online

Retrieves the details of a snooped event on a queue for a specific user in TSV, XML, or JSON format.

Syntax

To retrieve the details of a snooped event on a queue for a specific user in TSV format:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues event name=queueName user=userName id=eventId

To retrieve the details of a snooped event on a queue for a specific user in XML or JSON format:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues event name=queueName user=userName id=eventId {--format|-f} {xml|json}

Arguments and Options

nodeAlias: Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName: Required. The ID of the Universal Messaging server instance for which you want to retrieve a snooped event.
name=queueName: Required. The name of the queue on which the snooped event is published.
user=userName: Required. The username of the user for whom you want to retrieve the snooped event.
id=eventId: Required. The ID of the event that you want to view.
[{--format|-f} {xml|json}]: Optional. Whether to view the snooped event in XML or JSON format.

Usage Notes

The TSV format is tabular and does not display the header and properties of an event. To see the header and properties of an event, use the XML or JSON format.

Examples

To view details of a snooped event with ID "2" in TSV format on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
```
sagcc exec administration component sag01 Universal-Messaging-umserver
queues event name=queue1 user=Administrator id=2
```
To view details of a snooped event with ID "2" in XML format on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
```
sagcc exec administration component sag01 Universal-Messaging-umserver
queues event name=queue1 user=Administrator id=2 --format xml
```

Purge Snooped Events from a Queue

Edit online

Purges all snooped events from a queue and the snooped events list for a specific user.

Syntax

sagcc exec administration component nodeAalias Universal-Messaging-instanceName
queues purgeEvents name=queueName user=userName

Arguments and Options

nodeAlias: Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName: Required. The ID of the Universal Messaging server instance on which you want to purge snooped events.
name=queueName: Required. The name of the queue from which you want to purge events.
user=userName: Required. The username of the user for whom you want to purge events.

Usage Notes

You cannot purge a single event or a range of events from a queue.

Examples

To purge all snooped events from queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":

sagcc exec administration component sag01 Universal-Messaging-umserver
queues purgeEvents name=queue1 user=Administrator

Stop Snooping on a Queue

Edit online

Stops snooping on events on a queue for a specific user.

Syntax

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
queues stopSnoop name=queueName user=userName

Arguments and Options

nodeAlias: Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName: Required. The ID of the Universal Messaging server instance on which you want to stop snooping.
name=queueName: Required. The name of the queue on which you want to stop snooping.
user=userName: Required. The username of the user for whom you want to stop snooping.

Examples

To stop snooping for events on queue "queue1", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":

sagcc exec administration component sag01 Universal-Messaging-umserver
queues stopSnoop name=queue1 user=Administrator