Native
Synchronous
No Custom Parameters
The ExcludeByDeviceType action is used to query (by exclusion) the device information cache located on the Cisco Unified Application Server using the device type as the exclusion criteria, in order to retrieve information on one or more devices.
ExcludeByDeviceType performs a search by searching the entire database for all Registered devices that do not match the specified device type and returns the results in a System.Data.DataTable variable. A common practice is to pass this variable into a CustomCode block for parsing the data within it.
Every action parameter specified in this action is used to further refine the actual query on the underlying Cisco Unified Application Server database using AND logic.
The resulting DataTable is an object comprised of rows and columns, with the number of resulting rows corresponding to the number of devices matched by the query. The name of the colums correspond to device attributes retrieved from the device cache database. The following list is the name of the columns comprising each row in the DataTable, which one would use when using C# to parse out the results from the table:
The name of the device, such as SEPXXXXXXXXXXXX. This should not ever be null.
The IP address of the device. This will be "" if undefined.
The description of the device. This will be "" if undefined.
The Calling Search Space of the device. This will be "" if undefined.
The Device Pool of the device. This will be "Unknown" if undefined.
The Status of the device. This will be "0" if undefined.
The type of the device. This will be "1" if undefined.
The IP address of the publisher node of the cluster that the device is registered to. This should not ever be null.
The DeviceListX provider polls every 2 hours (configurable). This means that the local Cisco Unified Application Environment device cache can be out of date with current phone information. If testing and developing with a phone that has just come online, manually invoke a refresh of the database by navigating to mceadmin > Providers > Cisco DeviceListX Provider > Invoke Extension to re-synchronous the cache.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| DeviceType * | Metreos.Interfaces.ICiscoDeviceList+DeviceTypes | The DeviceType action parameter can be used to restrict the query to devices not matching a particular type. Valid values are as follows:
| |
| CallManagerIP | System.String | The CallManagerIP action parameter can be used to restrict the query to devices not matching the specified Cisco Unified Communications Manager publisher IP address. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultData | System.Data.DataTable | A .NET System.Data.DataTable that contains rows and columns corresponding to the devices and attributes returned for the query. |
| ResultCount | System.Int32 | The number of devices returned by the exclusion. |
Branch Conditions
No description.
No description.