sharedrecord:srv : DNS Shared SRV record object.

A shared SRV (service) record is similar to a regular SRV record. It provides information about available services. The difference is that a shared SRV record should be added to a shared record group. If the shared record group is associated with other zones, the shared SRV record is shared among these zones.

Object Reference

References to sharedrecord:srv are object references. The name part of a shared SRV record object reference has the following components:

  • Name of the shared record
  • Name of the shared record group

Example: sharedrecord:srv/ZG5zLmJpbmRfdHh0U2Ig:some.name/sharedgroup

Restrictions

The object does not support the following operations:

  • CSV export

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): name, port, priority, shared_record_group, target, weight.

The following fields are required to create this object:

Field Notes
name  
port  
priority  
shared_record_group  
target  
weight  

comment

comment

Comment for this shared 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 this shared 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.

dns_name

dns_name

The name for this shared record in punycode format.

Type

String.

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

Search

The field is not available for search.

Notes

The dns_name cannot be updated.

dns_name cannot be written.

dns_target

dns_target

The name for a shared SRV record in punycode format.

Type

String.

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

Search

The field is not available for search.

Notes

The dns_target cannot be updated.

dns_target cannot be written.

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.

name

name

Name for this shared record. 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

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

Notes

The name is part of the base object.

port

port

The port of the shared SRV record. 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

  • ‘=’ (exact equality)

Notes

The port is part of the base object.

priority

priority

The priority of the shared SRV record. 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

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

Notes

The priority is part of the base object.

shared_record_group

shared_record_group

The name of the shared record group in which the record resides.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The shared_record_group is part of the base object.

target

target

The target of the shared SRV record 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 target is part of the base object.

ttl

ttl

The Time To Live (TTL) value for this shared record. A 32-bit unsigned integer that represents the duration, in seconds, for which the shared record is valid (cached). Zero indicates that the shared 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.

weight

weight

The weight of the shared SRV record. 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

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

Notes

The weight is part of the base object.

Fields List

Field Type Req R/O Base Search
comment String N N N : = ~
disable Bool N N N N/A
dns_name String N Y N N/A
dns_target String N Y N N/A
extattrs Extattr N N N ext
name String Y N Y : = ~
port Unsigned int Y N Y =
priority Unsigned int Y N Y < = >
shared_record_group String Y N Y N/A
target String Y N Y = ~
ttl Unsigned int N N N N/A
use_ttl Bool N N N N/A
weight Unsigned int Y N Y < = >