threatprotection:profile : The Threat Protection profile object.

The Threat Protection profile object facilitates configuring groups of Threat Protection members that have similar traffic properties. A member can be either associated with a Threat Protection profile or inherit the ruleset from the Grid or override the ruleset individually at the member level.

Object Reference

References to threatprotection:profile are object references.

The name part of the Threat Protection profile object reference has the following components:

  • The name of the Threat Protection profile.
Example:
threatprotection:profile/YXRwLmNsdXN0ZXJfYXRwX3Byb3BlcnRpZXMkMA:profile

Restrictions

The object does not support the following operations:

  • Scheduling

The object cannot be managed on Cloud Platform members.

Fields

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): comment, name.

The following fields are required to create this object:

Field Notes
name  

comment

comment

The comment for the Threat Protection profile.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The comment is part of the base object.

current_ruleset

current_ruleset

The current Threat Protection profile ruleset.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

current_ruleset is associated with the field use_current_ruleset (see use flag).

disable_multiple_dns_tcp_request

disable_multiple_dns_tcp_request

Determines if multiple BIND responses via TCP connection are disabled.

Type

Bool.

Create

The default value is True.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

disable_multiple_dns_tcp_request is associated with the field use_disable_multiple_dns_tcp_request (see use flag).

events_per_second_per_rule

events_per_second_per_rule

The number of events logged per second per rule.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

events_per_second_per_rule is associated with the field use_events_per_second_per_rule (see use flag).

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

members

members

The list of members that are associated with the profile.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

name

name

The name of the Threat Protection profile.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

source_member

source_member

The source member. It can be used only during the create operation for cloning a profile from an existing member.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The source_member cannot be updated.

source_member is not readable.

source_profile

source_profile

The source profile. It can be used only during the create operation for cloning a profile from an existing profile.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The source_profile cannot be updated.

source_profile is not readable.

use_current_ruleset

use_current_ruleset

Use flag for: current_ruleset

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_disable_multiple_dns_tcp_request

use_disable_multiple_dns_tcp_request

Use flag for: disable_multiple_dns_tcp_request

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_events_per_second_per_rule

use_events_per_second_per_rule

Use flag for: events_per_second_per_rule

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
current_ruleset String N N N =
disable_multiple_dns_tcp_request Bool N N N =
events_per_second_per_rule Unsigned int N N N < = >
extattrs Extattr N N N ext
members [String] N N N N/A
name String Y N Y : = ~
source_member String N N N N/A
source_profile String N N N N/A
use_current_ruleset Bool N N N N/A
use_disable_multiple_dns_tcp_request Bool N N N N/A
use_events_per_second_per_rule Bool N N N N/A