Native
Synchronous
No Custom Parameters
The ExcludeOnResults action is used for querying (by exclusion) the device information returned from a previous query or exclude native action, in order to further isolate the query.
ExcludeOnResults performs a search by searching on the entire specified System.Data.DataTable for all rows that do not match the specified device attributes and returns the results in a new System.Data.DataTable variable. A common practice is to pass this resulting 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 specified DataTable 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.
Only Registered and FoundAndUnregistered devices can be returned for Cisco Unified Communications Manager 5.x and 6.x, so for best-case compatibility, you should assume this behavior in your application.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| PreviousResults * | System.Data.DataTable | Results originating from a previous query or exclude native action. | |
| Type | Metreos.Interfaces.ICiscoDeviceList+DeviceTypes | The Type action parameter can be used to restrict the query to devices not matching a particular type. Valid values are as follows:
| |
| Name | System.String | The Name action parameter can be used to restrict the query to devices not matching the specified name. | |
| Description | System.String | The Description action parameter can be used to restrict the query to devices not matching the specified description. | |
| SearchSpace | System.String | The SearchSpace action parameter can be used to restrict the query to devices with a configured CallingSearchSpace not matching the specified value. | |
| Pool | System.String | The Pool action parameter can be used to restrict the query to devices with a configured Device Pool not matching the specified value. | |
| IP | System.String | The IP action parameter can be used to restrict the query to devices not matching the specified IP address. | |
| Status | Metreos.Interfaces.ICiscoDeviceList+StatusCodes | The Status action parameter can used to restrict the query to devices not matching the specified status value. Note that in Cisco Unified Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered devices are returned so this field has less value for those versions since NotFound is not supported.
| |
| 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.