record:rpz:ptr : Response Policy Zone Substitute PTR Record Rule object.¶
An RPZ Substitute (PTR Record) Rule object represents a Pointer (PTR) resource record. To define a specific address-to-name mapping, add an RPZ Substitute (PTR Record) Rule to a previously defined Response Policy Zone.
This record represents the substitution rule for DNS PTR records.
Object Reference¶
References to record:rpz:ptr are object references. The name part of an Substitute (PTR Record) Rule object reference has the following components:
Name of the record
Name of the view
Example: record:rpz:ptr/ZG5zLmJpsaG9zdA:1.0.0.127.in-addr.arpa/external
Restrictions¶
The object does not support the following operations:
Permissions
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): ptrdname, view.
The following fields are required to create this object:
Field |
Notes |
|---|---|
ipv4addr |
The field is required only for an IPv4 PTR object. |
ipv6addr |
The field is required only for an IPv6 PTR object. |
name |
See the field description for more information |
ptrdname |
|
rp_zone |
comment¶
- comment¶
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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
disable¶
- disable¶
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.
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.
ipv4addr¶
- ipv4addr¶
The IPv4 Address of the substitute rule.
Type
String.
Create
The field is required only for an IPv4 PTR object.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
ipv6addr¶
- ipv6addr¶
The IPv6 Address of the substitute rule.
Type
String.
Create
The field is required only for an IPv6 PTR object.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
name¶
- name¶
The name of the RPZ Substitute (PTR Record) Rule object in FQDN format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only for an PTR object in Forward Mapping Zone.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
ptrdname¶
- ptrdname¶
The domain name of the RPZ Substitute (PTR Record) Rule object in FQDN 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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The ptrdname is part of the base object.
rp_zone¶
- rp_zone¶
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.
ttl¶
- ttl¶
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_ttl¶
- use_ttl¶
Use flag for: ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
view¶
- view¶
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
‘=’ (exact equality)
Notes
The view is part of the base object.
zone¶
- zone¶
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
‘=’ (exact equality)
Notes
The zone cannot be updated.
zone cannot be written.
Fields List¶
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 |
ipv4addr |
String |
Y* |
N |
N |
= ~ |
ipv6addr |
String |
Y* |
N |
N |
= ~ |
name |
String |
Y* |
N |
N |
: = ~ |
ptrdname |
String |
Y |
N |
Y |
: = ~ |
rp_zone |
String |
Y |
N |
N |
N/A |
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 |
= |
* Required in some cases, see detailed field description above.
