Search Response Policies - BlueCat Address Manager - 8.3.1

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.1

Searches Response Policy items configured in local Response Policies or predefined BlueCat Security feed data. The search will return a list of all matching items in Address Manager across all configurations.

Use this method to fetch response policy items and their associated properties or objects such as Response Policy, RP Zone, Threat Protection category for feed data, policy type and the parent configuration.

Output / Response

Returns an array of ResponsePolicySearchResult objects. Each object contains information of one Response Policy item found either in local Response Policies or BlueCat Security feed data.

API Call:

ResponsePolicySearchResult[] searchResponsePolicyItems( String keyword, String scope, int start, int count, String properties )
Parameter Description
keyword The search string for which you wish to search.
  • ^—matches the beginning of a string. For example: ^ex matches example but not text.
  • $—matches the end of string. For example: ple$ matches example but not please.
  • *—matches zero or more characters within a string. For example: ex*t matches exit and excellent.
scope The scope in which the search is to be performed. The possible values are:
  • RPItemSearchScope.LOCAL—to search policy items configured in local Response Policies.
  • RPItemSearchScope.FEED—to search policy items configured in predefined BlueCat Security Feed data.
  • RPItemSearchScope.ALL—to search policy items configured in both local Response Policies and predefined BlueCat Security Feed data.
start A starting number from where the search result will be returned. The possible value is a positive integer ranging from 0 to 999. For example, specifying 99 will return the search result from the 100th result to the maximum number that you specify with the count option.
count The total number of results to be returned. The possible value is a positive integer ranging from 1 to 1000.
properties Reserved for future use. Use an empty string ("") for now.