Skip to content

ngsiem_parser

Create, update, clone, and delete custom NG-SIEM parsers in the CrowdStrike

Added in version 4.13.0

ParameterTypeRequiredDefaultDescription
clone_fromstrNoThe ID of a source parser to clone into a new parser named I(name). Mutually exclusive with I(parser_yaml) and I(extension_of). Only applies when the target parser (I(name)) does not already exist.
extension_ofstrNoThe unversioned base parser ID to create an extension of, named I(name). “B(Note:) The base parser ID must be B(unversioned) (no C(:x.y.z) suffix).” Mutually exclusive with I(parser_yaml) and I(clone_from). Only applies when the target parser (I(name)) does not already exist.
namestrNoThe name of the parser. Required when creating a new parser and when using I(clone_from) or I(extension_of). Used to look up an existing parser when I(parser_id) is not provided. The API stores custom parsers with a C(custom-) prefix, so a parser created as C(my-parser) is stored as C(custom-my-parser). Both names find the parser.
parser_idstrNoThe version-suffixed ID of an existing parser (e.g. C(abc123:1.0.0)). Each update gives the parser a new version and ID. An ID with an earlier version, or an ID without a version, also finds the parser. Preferred for identifying an existing parser during update or delete. When provided with I(state=absent), the parser is deleted by ID.
parser_yamlstrNoThe full LogScale parser YAML template. Required when creating or updating a parser via I(state=present) unless I(clone_from) or I(extension_of) is used. For idempotency, the module compares the C(script), C(tagFields), and C(testCases) of this template against the stored parser and only updates when they differ.
repositorystrNoparsers-repositoryThe name of the repository the parser belongs to.
statestrNopresentThe desired state of the parser. C(present) ensures the parser exists with the specified content. C(absent) ensures the parser does not exist.
- name: Create a custom parser from a YAML template
crowdstrike.falcon.ngsiem_parser:
name: my-custom-parser
parser_yaml: "{{ lookup('file', 'my-parser.yaml') }}"
- name: Update a parser (idempotent - only changes when content differs)
crowdstrike.falcon.ngsiem_parser:
name: my-custom-parser
parser_yaml: "{{ lookup('file', 'my-parser-v2.yaml') }}"
- name: Clone an existing parser into a new one
crowdstrike.falcon.ngsiem_parser:
name: my-cloned-parser
clone_from: "10f55deaa2893f60b87af305f44f80bf:1.0.0"
- name: Create an extension of a base parser (base ID must be unversioned)
crowdstrike.falcon.ngsiem_parser:
name: my-parser-extension
extension_of: "10f55deaa2893f60b87af305f44f80bf"
- name: Delete a parser by name
crowdstrike.falcon.ngsiem_parser:
name: my-custom-parser
state: absent
- name: Delete a parser by ID
crowdstrike.falcon.ngsiem_parser:
parser_id: "10f55deaa2893f60b87af305f44f80bf:1.1.0"
state: absent
KeyTypeDescription
parser-