getpolicypatsetResult Structure Definition

The getpolicypatsetResult structure defines the return type for getpolicypatset API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

policypatsetList

List of policypatsets


policypatset Structure Definition

The policypatset structure defines the actual return type values for getpolicypatset API.

Syntax



Members

name

Name of the pattern set for which to display the detailed information.

dynamiconly

Shows only dynamic patsets when set true.

string

String of characters that constitutes a pattern. For more information about the characters that can be used, refer to the character set parameter. Note: Minimum length for pattern sets used in rewrite actions of type REPLACE_ALL, DELETE_ALL, INSERT_AFTER_ALL, and INSERT_BEFORE_ALL, is three characters.

index

The index of the string associated with the patset.

charset

Character set associated with the characters in the string. Note: UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes '\xNN'. For example, the UTF-8 character 'ü' can be encoded as '\xC3\xBC'.

builtin

Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

feature

The feature to be checked while applying this config

comment

Any comments to preserve information about this patset or a pattern bound to this patset.

patsetfile

File which contains list of patterns that needs to be bound to the patset. A patsetfile cannot be associated with multiple patsets.

dynamic

This is used to populate internal patset information so that the patset can also be used dynamically in an expression. Here dynamically means the patset name can also be derived using an expression. For example for a given patset name "allow_test" it can be used dynamically as http.req.url.contains_any("allow_" + http.req.url.path.get(1)). This cannot be used with default patsets.

_nextgenapiresource


See Also