An RPZ Substitute (TXT Record) Rule object represents the substitution rule for DNS TXT records.
References to record:rpz:txt are object references. The name part of a Substitute (TXT Record) Rule object reference has the following components:
- Name of the record
- Name of the view
Example: record:rpz:txt/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, text, view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| rp_zone | |
| text |
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 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 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.
Text associated with the record. It can contain up to 255 bytes per substring, up to a total of 512 bytes. To enter leading, trailing, or embedded spaces in the text, add quotes around the text to preserve the spaces.
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 text 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 |
| name | String | Y | N | Y | : = ~ |
| rp_zone | String | Y | N | N | N/A |
| text | String | Y | 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 | = |
