allrpzrecords : DNS All RPZ Records object.

A synthetic object used to return record object types that belong to a Response Policy Zone.

Object Reference

References to allrpzrecords are object references.

The name part of the allrpzrecords object reference has the following components:

  • The name of the record associated with the allrpzrecords object.

Example: allrpzrecords/ZG5zLm5ldHdvcmtfdmlldyQxMTk/default:

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Permissions
  • Read by object reference
  • Global search (searches via the search object)
  • Scheduling

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, name, type, view, zone.

alert_type

alert_type

The alert type of the record associated with the allrpzrecords object.

Type

String.

Valid values are:
  • DOMAIN_MATCH
  • INFECTION_MATCH
  • MALWARE_CALLBACK
  • MALWARE_OBJECT
  • WEB_INFECTION

Search

The field is not available for search.

Notes

The alert_type cannot be updated.

alert_type cannot be written.

comment

comment

The descriptive comment of the record associated with the allrpzrecords object.

Type

String.

Search

The field is not available for search.

Notes

The comment is part of the base object.

The comment cannot be updated.

comment cannot be written.

disable

disable

The disable flag of the record associated with the allrpzrecords object (if present).

Type

Bool.

Search

The field is not available for search.

Notes

The disable cannot be updated.

disable cannot be written.

expiration_time

expiration_time

The expiration time of the record associated with the allrpzrecords object.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The expiration_time cannot be updated.

expiration_time cannot be written.

last_updated

last_updated

The time when the record associated with the allrpzrecords object was last updated.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The last_updated cannot be updated.

last_updated cannot be written.

name

name

The name of the record associated with the allrpzrecords object. Note that this value might be different than the value of the name field for the associated record.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

record

record

The record object associated with the allrpzrecords object.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The record cannot be updated.

record cannot be written.

rpz_rule

rpz_rule

The RPZ rule type of the record associated with the allrpzrecrods object.

Type

String.

Valid values are:
  • BlockNoDataClientIpaddr
  • BlockNoDataDomain
  • BlockNoDataIpaddr
  • BlockNxdomainClientIpaddr
  • BlockNxdomainDomain
  • BlockNxdomainIpaddr
  • PassthruClientIpaddr
  • PassthruDomain
  • PassthruIpaddr
  • SubstituteAAAARecord
  • SubstituteARecord
  • SubstituteCName
  • SubstituteClientIPAddressCname
  • SubstituteIPAddressCname
  • SubstituteIPv4AddressRecord
  • SubstituteIPv6AddressRecord
  • SubstituteMXRecord
  • SubstituteNAPTRRecord
  • SubstitutePTRRecord
  • SubstituteSRVRecord
  • SubstituteTXTRecord

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The rpz_rule cannot be updated.

rpz_rule cannot be written.

ttl

ttl

The TTL value of the record associated with the allrpzrecords object (if present).

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The ttl cannot be updated.

ttl cannot be written.

type

type

The type of record associated with the allrpzrecords object. This is a descriptive string that identifies the record to which this allrpzrecords object refers. (Examples: ‘record:rpz:a’, ‘record:rpz:mx’, etc.)

Type

String.

Valid values are:
  • record:rpz:a
  • record:rpz:a:ipaddress
  • record:rpz:aaaa
  • record:rpz:aaaa:ipaddress
  • record:rpz:cname
  • record:rpz:cname:clientipaddress
  • record:rpz:cname:ipaddress
  • record:rpz:cname:ipaddressdn
  • record:rpz:mx
  • record:rpz:naptr
  • record:rpz:ptr
  • record:rpz:srv
  • record:rpz:txt

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type is part of the base object.

The type cannot be updated.

type cannot be written.

view

view

The DNS view name of the record associated with the allrpzrecords object.

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 view is part of the base object.

The view cannot be updated.

view cannot be written.

zone

zone

The Response Policy Zone name of the record associated with the allrpzrecords object.

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 is part of the base object.

The zone cannot be updated.

zone cannot be written.

Fields List

Field Type Req R/O Base Search
alert_type String N Y N N/A
comment String N Y Y N/A
disable Bool N Y N N/A
expiration_time Unsigned int N Y N N/A
last_updated Unsigned int N Y N N/A
name String N Y Y : = ~
record String N Y N N/A
rpz_rule String N Y N =
ttl Unsigned int N Y N N/A
type String N Y Y =
view String N Y Y =
zone String N Y Y =