record:dhcid : DNS DHCID record object.

The DHCID DNS resource record (RR) is used to associate the DNS domain names with the DHCP clients using the domain names.

Object Reference

References to record:dhcid are object references. The name part of an DHCID record object reference has the following components:

  • Name of the record
  • Name of the view

Example: record:dhcid/ZG5zLmJpbm:h1.wtest.foo.bar/external

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Modify (update)

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, view.

creation_time

creation_time

The creation time of the record.

Type

Timestamp.

Search

The field is not available for search.

Notes

The creation_time cannot be updated.

creation_time cannot be written.

creator

creator

The record creator.

Type

String.

Valid values are:
  • DYNAMIC
  • STATIC
  • SYSTEM

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The creator cannot be updated.

creator cannot be written.

dhcid

dhcid

The Base64 encoded DHCP client information.

Type

String.

Search

The field is available for search via

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

Notes

The dhcid cannot be updated.

dhcid cannot be written.

dns_name

dns_name

The name for the DHCID 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.

name

name

The name of the DHCID record in FQDN format.

Type

String.

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.

ttl

ttl

The Time To Live (TTL) value for the 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.

Search

The field is not available for search.

Notes

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

The ttl cannot be updated.

ttl cannot be written.

use_ttl

use_ttl

Use flag for: ttl

Type

Bool.

Search

The field is not available for search.

Notes

The use_ttl cannot be updated.

use_ttl cannot be written.

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.

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 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
creation_time Timestamp N Y N N/A
creator String N Y N =
dhcid String N Y N : = ~
dns_name String N Y N N/A
name String N Y Y : = ~
ttl Unsigned int N Y N N/A
use_ttl Bool N Y N N/A
view String N Y Y =
zone String N Y N =