record:rpz:mx : Response Policy Zone Substitute MX Record Rule object.

An RPZ Substitute (MX Record) Rule maps a domain name to a mail exchanger. A mail exchanger is a server that either delivers or forwards mail.

This record represents the substitution rule for DNS MX records.

Object Reference

References to record:rpz:mx are object references. The name part of an Substitute (MX Record) Rule object reference has the following components:

  • Name of the record
  • Name of the view

Example: record:rpz:mx/ZG5zLmhvc3RjkuMC4xLg:some.name.com/default

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): mail_exchanger, name, preference, view.

The following fields are required to create this object:

Field Notes
mail_exchanger  
name  
preference  
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

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

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.

mail_exchanger

mail_exchanger

Mail exchanger name in FQDN format. 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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The mail_exchanger is part of the base object.

name

name

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

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

Notes

The name is part of the base object.

preference

preference

Preference value, 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

  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The preference 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

ttl is associated with the field use_ttl (see use flag).

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
mail_exchanger String Y N Y = ~
name String Y N Y : = ~
preference Unsigned int 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 =