recordnamepolicy : Record name policy object.¶
You can enforce naming policy for the hostnames of A, AAAA, Host, MX, NS and bulk host records based on user-defined or default patterns. For MX and NS records, the hostname restrictions apply to the text in the RDATA field of the resource record name. Records that you created before you enabled the hostname checking policy need not to comply with the hostname restriction that you specify.
The record name policy object contains configuration of the regular expression hostnames should comply with.
Object Reference¶
References to recordnamepolicy are object references.
The name part of the record name policy object reference has following components:
The name of the record name policy object.
- Example:
recordnamepolicy/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:Default
Restrictions¶
The object does not support the following operations:
Global search (searches via the search object)
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): is_default, name, regex.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
|
regex |
is_default¶
- is_default¶
Determines whether the record name policy is Grid default.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The is_default is part of the base object.
name¶
- name¶
The name of the record name policy object.
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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
pre_defined¶
- pre_defined¶
Determines whether the record name policy is a predefined one.
Type
Bool.
Search
The field is not available for search.
Notes
The pre_defined cannot be updated.
pre_defined cannot be written.
regex¶
- regex¶
The POSIX regular expression the record names should match in order to comply with the record name policy.
Type
String.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The regex is part of the base object.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
is_default |
Bool |
N |
N |
Y |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
pre_defined |
Bool |
N |
Y |
N |
N/A |
regex |
String |
Y |
N |
Y |
N/A |
