node-pattern-group

Queries pattern group data downloaded to the Data Node through the policy synchronization module.

Command properties

PropertyDescription
Command typeDriver
Required permissionAdministrator
License usageNot counted
Parallel executionNot supported
Distributed executionNot supported

Syntax

node-pattern-group [guid=STR]

Options

guid=STR
Pattern group GUID. When specified, queries the pattern entries included in that pattern group. When omitted, lists a summary of all pattern groups.

Output fields

When the guid option is specified:

FieldTypeDescription
exprstringPattern expression
expr2stringSecondary pattern expression
rulestringRule name
app_codestringApp code
app_built_inbooleanWhether this is a built-in app

When the guid option is omitted:

FieldTypeDescription
idintegerPattern group ID
guidstringPattern group GUID
namestringPattern group name
descriptionstringPattern group description
pattern_countintegerNumber of pattern entries
user_namestringCreator name
user_guidstringCreator GUID

Error codes

Parse errors
Error codeMessageDescription
300320You do not have permission to run node-pattern-group.Administrator privileges are required.
300321The guid option for the node-pattern-group command is not in a valid format.The guid option value is not a valid GUID format.
300322The pattern group [guid] specified in node-pattern-group was not found.No pattern group exists for the specified GUID.
Runtime errors

None

Description

The node-pattern-group command queries pattern group data downloaded from the Control Node to the Data Node through the policy synchronization module.

When the guid option is specified, it returns the individual pattern entries (expression, secondary expression, rule) included in that pattern group. When the guid option is omitted, it returns a summary list of all synchronized pattern groups (name, GUID, pattern count, etc.).

Examples

  1. List all pattern groups

    node-pattern-group
    

    Queries the summary information of all pattern groups synchronized to the Data Node.

  2. Query pattern entries of a specific pattern group

    node-pattern-group guid=550e8400-e29b-41d4-a716-446655440000
    

    Queries the pattern entries included in the pattern group with the specified GUID.