Cisco Cisco Prime Home 6.3 Developer's Guide

Cisco Prime Home – Integration Guide

OL-28558-01 v5.1



Note that aliases are available for most document types. For example, the

"subscriber" document type can also be referenced as "subscribers", and

the "device" document type can be referenced as "devices". A complete list

of document types and aliases can be viewed in the Prime Home

application. Click on the Utilities Menu and select Search from the left

sidebar.

The special document types "anything" and "everything" can also be used in

order to write CAQL that explicitly searches all document types. For example,

the following searches all documents for any field containing "juniper":

anything with juniper

Use of the "anything" and "everything" document types is equivalent to the

same CAQL without the "with" clause; they are provided as a means to express

more readable CAQL.

Wildcards

The following searches for devices with a serial number starting with "ABC":

devices

with sn:ABC*

Single-character wildcards are also supporting using "?". The following query

searches for devices with a serial number starting with "ABC" followed by

exactly four characters:

devices with sn:ABC????

Wildcards can also be used inside search terms. The following query searches

for devices with a serial number starting with "ABC" and ending with "XYZ":

devices with sn:ABC*XYZ

Leading wildcard usage is also supported. For instance, the following query finds

devices with serial numbers ending in "XYZ":

devices with sn:*XYZ

IP addresses also support wildcards. For example:

devices with wanip: 192.1.*.*



Note that inner and leading wildcard usage does not make optimal use of the

search engine and requires more system resources than trailing wildcard usage.

As a result these queries can fail if the wildcard matches too many terms. It is

recommended that inner and leading wildcards be used for manually entered

searches only (for instance, on the Find Devices page of the Portal web

application), and they not be used in automated and reoccurring processes (for

instance, bulk operations).