Channel Snoop

Start Snooping on a Channel

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

Syntax

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

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels startSnoop name=channelName user=userName

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

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels startSnoop name=channelName 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=channelName: Required. The name of the channel 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 channel 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 channel.

Examples

To start snooping on events on channel "channel2", 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
channels startSnoop name=channel2 user=Administrator
```
To start snooping on the events with IDs from "2" to "10" on channel "channel2", 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
channels startSnoop name=channel2 user=Administrator fromid=2 toid=10
```

List Snooped Events on a Channel

Edit online

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

Syntax

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

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels snoop name=channelName user=userName

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

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels snoop name=channelName 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=channelName: Required. The name of the channel 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 channel started, Command Central stops snooping all channels 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 channel "channel2", 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
channels snoop name=channel2 user=Administrator
```
To list the snooped events in JSON format on channel "channel2", 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
channels snoop name=channel2 user=Administrator --format json
```

View Details of a Snooped Event on a Channel

Edit online

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

Syntax

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

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels snoop name=channelName user=userName id=eventId

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

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels snoop name=channelName 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=channelName: Required. The name of the channel 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 channel "channel2", 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
channels event name=channel2 user=Administrator id=2
```
To view details of a snooped event with ID "2" in XML format on channel "channel2", 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
channels event name=channel2 user=Administrator id=2 --format xml
```

Purge Snooped Events from a Channel

Edit online

Purges a snooped event or a range of snooped events from a channel for a specific user.

Syntax

To purge a snooped event from a channel and the snooped events list for a specific user:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels purgeEvent name=channelName user=userName id=eventId

To purge a range of snooped events from a channel and the snooped events list for a specific user:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels purgeEvents name=channelName user=userName
[fromeid=firstEventId] [toeid=lastEventId]

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=channelName: Required. The name of the channel from which you want to purge events.
user=userName: Required. The username of the user for whom you want to purge events.
id=eventId: Required with the sagcc exec administration component purgeEvent command. The ID of the event to purge.
[fromeid=firstEventId]: Optional. The ID of the first event in the event range that you want to purge.
[toeid=lastEventId]: Optional. The ID of the last event in the event range that you want to purge.

Usage Notes

When you want to purge a range of snooped events:

If you do not specify fromeid, all events from the first one on the channel to the one with ID smaller than or equal to toeid are purged.
If you do not specify toeid, all events from the one with ID greater than or equal to fromeid to the last one on the channel are purged.
If you do not specify both fromeid and toeid, all events on the channel are purged.

Examples

To purge a snooped event with ID "2" from channel "channel2", 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
channels purgeEvent name=channel2 user=Administrator id=2
```
To purge the snooped events with IDs from "2" to "6" from channel "channel2", 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
channels purgeEvents name=channel2 user=Administrator fromid=2 toid=6
```

Stop Snooping on a Channel

Edit online

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

Syntax

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels stopSnoop name=channelName 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=channelName: Required. The name of the channel 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 on events on channel "channel2", 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
channels stopSnoop name=channel2 user=Administrator