An RPZ Substitute (NAPTR Record) Rule object represents the substitution rule for DNS Naming Authority Pointer (NAPTR) records. This rule specifies a regular expression-based rewrite rule that, when applied to an existing string, produces a new domain name or URI.
References to record:rpz:naptr are object references. The name part of a Substitute (PTR Record) Rule object reference has the following components:
- Name of the record
- Name of the view
Example: record:rpz:naptr/ZG5zLmhvc3RjkuMC4xLg:some.name.com/default
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): name, order, preference, regexp, replacement, services, view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| order | |
| preference | |
| replacement | |
| rp_zone |
The comment for the record; maximum 256 characters.
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
Determines if the record is disabled or not. False means that the record is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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.
The flags used to control the interpretation of the fields for a Substitute (NAPTR Record) Rule object. Supported values for the flags field are “U”, “S”, “P” and “A”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is An empty string.
Search
The field is available for search via
The time of the last DNS query in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_queried cannot be updated.
last_queried cannot be written.
The name for a record in FQDN format. This value cannot be in unicode format.
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
Notes
The name is part of the base object.
The order parameter of the Substitute (NAPTR Record) Rule records. This parameter specifies the order in which the NAPTR rules are applied when multiple rules are present. Valid values are from 0 to 65535 (inclusive), in 32-bit unsigned integer format.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The order is part of the base object.
The preference of the Substitute (NAPTR Record) Rule record. The preference field determines the order NAPTR records are processed when multiple records with the same order parameter are present. Valid values are from 0 to 65535 (inclusive), in 32-bit unsigned integer format.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The preference is part of the base object.
The regular expression-based rewriting rule of the Substitute (NAPTR Record) Rule record. This should be a POSIX compliant regular expression, including the substitution rule and flags. Refer to RFC 2915 for the field syntax details.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is An empty string.
Search
The field is not available for search.
Notes
The regexp is part of the base object.
The replacement field of the Substitute (NAPTR Record) Rule object. For nonterminal NAPTR records, this field specifies the next domain name to look up. This value can be in unicode format.
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
Notes
The replacement is part of the base object.
The name of a response policy zone in which the record resides.
Type
String.
Create
The field is required on creation.
Search
The field is not available for search.
The services field of the Substitute (NAPTR Record) Rule object; maximum 128 characters. The services field contains protocol and service identifiers, such as “http+E2U” or “SIPS+D2T”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is An empty string.
Search
The field is available for search via
Notes
The services is part of the base object.
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
Use flag for: ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the DNS View in which the record resides. Example: “external”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default DNS view.
Search
The field is available for search via
Notes
The view is part of the base object.
The name of the zone in which the record resides. Example: “zone.com”. If a view is not specified when searching by zone, the default view is used.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The zone cannot be updated.
zone cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| comment | String | N | N | N | : = ~ |
| disable | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| flags | String | N | N | N | : = ~ |
| last_queried | Timestamp | N | Y | N | N/A |
| name | String | Y | N | Y | : = ~ |
| order | Unsigned int | Y | N | Y | < = > |
| preference | Unsigned int | Y | N | Y | < = > |
| regexp | String | N | N | Y | N/A |
| replacement | String | Y | N | Y | = ~ |
| rp_zone | String | Y | N | N | N/A |
| services | String | N | N | Y | : = ~ |
| ttl | Unsigned int | N | N | N | N/A |
| use_ttl | Bool | N | N | N | N/A |
| view | String | N | N | Y | = |
| zone | String | N | Y | N | = |
