threatanalytics:whitelist : Threat analytics whitelist object.

The threat analytics whitelist object contains trusted domains on which NIOS allows DNS traffic.

Object Reference

References to threatanalytics:whitelist are object references.

The name part of the threat analytics whitelist object reference has the following components:

  • The fully-qualified domain name (FQDN) of the threat analytics whitelist
Example:
threatanalytics:whitelist/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:whitelist.com

Restrictions

The object does not support the following operations:

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, disable, fqdn.

The following fields are required to create this object:

Field Notes
fqdn  

comment

comment

The descriptive comment for the threat analytics whitelist.

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.

disable

disable

Determines whether the threat analytics whitelist is disabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

The disable is part of the base object.

fqdn

fqdn

The FQDN of the threat analytics whitelist.

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 fqdn is part of the base object.

type

type

The type of the threat analytics whitelist.

Type

String.

Valid values are:
  • BOTH
  • CUSTOM
  • SYSTEM

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type cannot be updated.

type cannot be written.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
disable Bool N N Y N/A
fqdn String Y N Y : = ~
type String N Y N =