ruleset : DNS Ruleset object.¶
Represents a Ruleset object, which is a collection of rules that is used to match domain names.
Object Reference¶
References to ruleset are object references.
The name part of the ruleset object reference has the following components:
Name of the Ruleset object
Type of the Ruleset object
Example: ruleset/ZG5zLm5ldHdvcmtfdmlldyQxMTk:default/NXDOMAIN
Restrictions¶
The object does not support the following operations:
Scheduling
CSV export
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, disabled, name, type.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
|
type |
comment¶
- comment¶
Descriptive comment about the Ruleset object.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The comment is part of the base object.
disabled¶
- disabled¶
The flag that indicates if the Ruleset object is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The disabled is part of the base object.
name¶
- name¶
The name of this Ruleset object.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
nxdomain_rules¶
- nxdomain_rules¶
The list of Rules assigned to this Ruleset object. Rules can be set only when the Ruleset type is set to “NXDOMAIN”.
Type
A/An Rule of Ruleset struct array.
Create
The default value is:
empty
Search
The field is not available for search.
type¶
- type¶
The type of this Ruleset object.
Type
String.
- Valid values are:
BLACKLIST
NXDOMAIN
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The type is part of the base object.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
comment |
String |
N |
N |
Y |
: = ~ |
disabled |
Bool |
N |
N |
Y |
= |
name |
String |
Y |
N |
Y |
: = ~ |
nxdomain_rules |
[struct] |
N |
N |
N |
N/A |
type |
String |
Y |
N |
Y |
= |
