node-pattern-group
Queries pattern group data downloaded to the Data Node through the policy synchronization module.
Command properties
| Property | Description |
|---|---|
| Command type | Driver |
| Required permission | Administrator |
| License usage | Not counted |
| Parallel execution | Not supported |
| Distributed execution | Not supported |
Syntax
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:
| Field | Type | Description |
|---|---|---|
expr | string | Pattern expression |
expr2 | string | Secondary pattern expression |
rule | string | Rule name |
app_code | string | App code |
app_built_in | boolean | Whether this is a built-in app |
When the guid option is omitted:
| Field | Type | Description |
|---|---|---|
id | integer | Pattern group ID |
guid | string | Pattern group GUID |
name | string | Pattern group name |
description | string | Pattern group description |
pattern_count | integer | Number of pattern entries |
user_name | string | Creator name |
user_guid | string | Creator GUID |
Error codes
Parse errors
| Error code | Message | Description |
|---|---|---|
| 300320 | You do not have permission to run node-pattern-group. | Administrator privileges are required. |
| 300321 | The guid option for the node-pattern-group command is not in a valid format. | The guid option value is not a valid GUID format. |
| 300322 | The 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
-
List all pattern groups
node-pattern-groupQueries the summary information of all pattern groups synchronized to the Data Node.
-
Query pattern entries of a specific pattern group
node-pattern-group guid=550e8400-e29b-41d4-a716-446655440000Queries the pattern entries included in the pattern group with the specified GUID.