Search Filter Service Operations

Search Filter Service Operations

The Search Filter Service operations enable you to manage search filters in your LogLogic Appliance.

Overview

The Search Filter Service operations let you create, read, update, and delete search filters as well as view all search filters in your LogLogic Appliance.

Search filters let you define search patterns to view specific data and to define alerts. In the LogLogic Appliance you can view the user interface implementation by navigating to Search > Search Filters.

Implementation Guidelines

The following are general implementation guidelines for the Search Filter Service operations:


  • A set of Common Request Parameters are required for each operation.
  • You must specify a value for all Required parameters.
  • You must specify the value of the Common Request Parameters only.
  • All parameters must be implemented in the order in which they appear in the Request Parameters section for each of the operations.
  • All values for Common Request Parameters must be enclosed by double quotation marks (“value”). If the name of a device or a parameter value includes a forward
    slash (/), such as HP/UX, or IBM i5/OS, you must replace the forward slash with %2F.
    (The F is case-sensitive.)
    Examples: HP%2FUX or IBM i5%2FOS

Search Filter Service Operation Descriptions

The Search Filter Service operations let you create, read, update, and delete devices in your system. In the LogLogic Appliance user interface, you can view all actions accessible through the Search Filter Service operations by navigating to the Search Filter screen from the navigation tree.

There are two kinds of operations:


  • local - operation is performed on the local Appliance itself
  • remote - operations (names ending with Remote) performed on a specified remote Appliance

The Search Filter Service operations are as follows:

Status Codes

The Status Codes are:

2000 Server success
4000 Unauthorized request
5000 Invalid parameter, getStatusMessage() contains detail information about the error

Common Request Parameters

A set of Common Request Parameters are required for each Search Filter operation. This table lists all of the Search Filter parameters. For more information on the parameters, view the LogLogic Appliance user interface for search filters as well as the online help.

Parameter Description Default Value Required Type
authToken Unique authentication token.   yes string
applianceIP The managed Appliance on which you perform the operation.
If the value is blank, it retrieves the Appliance IP address from the local Appliance.
This parameter is available only for Management Station Appliances using operations with Remote in the name.
IP address of a managed Appliance. To specify an IP address, use the standard IP address format. For example:
10.1.2.3
yes (for xxxxRemote operations only) string
searchFilterName Name of the search filter. Any text up to 64 characters in length. yes string
searchFilterType Type of search filter. Use Words, Use Exact Phrase, Regular Expression, or Boolean Search yes string
description Description of the search filter name (searchFilterName parameter) Any text up to 64 characters in length. yes string
sharedWithOtherUsers Identifies if this search filter is available to other users. If yes, it is shared with others. yes yes string
expression1 The actual search terms for the search filter. Any valid search criteria up to 276 characters in length. yes string
expression2 The actual search terms for the search filter.
expression1 is required for Use Words search only.
Any valid search criteria up to 270 characters in length. yes string
expressionOperator The actual search terms for the search filter. Possible values:
AND, OR. expressionOperator is required only for the Use Words searchFilterType.
yes string
changeNameTo New name of the search filter.
If empty, the object name is unchanged.
Any text up to 64 characters in length. yes (for updateSearchFilter and updateSearchFilterRemote only) string
0
Your rating: None

User login

Current Poll

What programming language are you using to communicate with the LogLogic API?:

Recent Comments