This object provides information about the Threat protection profile rule settings.
References to threatprotection:profile:rule are object references.
The name part of the threat protection profile rule object reference has the following components:
- Name of the Atp Rule object
Example: threatprotection:profile:rule/ZG5zLm5ldHdvcmtfdmlldyQxMTk:rulename
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): profile, rule.
The threat protection rule configuration.
Type
A/An Threat protection rule configuration struct.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
config is associated with the field use_config (see use flag).
Determines if the rule is enabled or not for the profile.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Notes
disable is associated with the field use_disable (see use flag).
The name of the Threat protection profile.
Type
String.
Search
The field is available for search via
Notes
The profile is part of the base object.
The profile cannot be updated.
profile cannot be written.
The rule object name.
Type
String.
Search
The field is available for search via
Notes
The rule is part of the base object.
The rule cannot be updated.
rule cannot be written.
The snort rule ID.
Type
Unsigned integer.
Search
The field is available for search via
Notes
The sid cannot be updated.
sid cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| config | struct | N | N | N | N/A |
| disable | Bool | N | N | N | N/A |
| profile | String | N | Y | Y | = |
| rule | String | N | Y | Y | = |
| sid | Unsigned int | N | Y | N | = |
| use_config | Bool | N | N | N | N/A |
| use_disable | Bool | N | N | N | N/A |
