editPolicyIntrusionRuleGroup
The editPolicyIntrusionRuleGroup operation handles configuration related to IntrusionRuleGroup model.
Description
This API is only supported for Snort 3. This will allow only to update the security level of an intrusion rule group
Data Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
version | False | string | A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected. | |||
name | True | string | A string that is the name of the Intrusion Rule Group | |||
description | False | string | A string that is the description of the Intrusion Rule Group Field level constraints: must match pattern ^((?!;).)*$, length must be between 0 and 32 (inclusive). (Note: Additional constraints might exist) |
|||
isSystemDefined | False | boolean | Read-only field that declares whether this object is defined by Talos or the user | |||
childGroups | False | [object] | A list of all children IntrusionRuleGroups under a Intrusion Rule Group. Only Talos groups can have child groups. Must be null on create/update of intrusion rule group. Allowed types are: [IntrusionRuleGroup] |
|||
defaultSecurityLevel | False | string | Optional read-only field. When queried in the context of policy, this will show the configured security level. Must be null on create/update of intrusion rule group. | |||
overrideSecurityLevel | False | string | Optional read-only field. When queried in context of a policy, this will show the User configured security level override. Must be null on create/update of intrusion rule group. | |||
id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Path Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
parentId | True | string | ||||
objId | True | string |
Example
- name: Execute 'editPolicyIntrusionRuleGroup' operation
ftd_configuration:
operation: "editPolicyIntrusionRuleGroup"
data:
version: "{{ version }}"
name: "{{ name }}"
description: "{{ description }}"
isSystemDefined: "{{ is_system_defined }}"
childGroups: "{{ child_groups }}"
defaultSecurityLevel: "{{ default_security_level }}"
overrideSecurityLevel: "{{ override_security_level }}"
id: "{{ id }}"
type: "{{ type }}"
path_params:
parentId: "{{ parent_id }}"
objId: "{{ obj_id }}"