A host record defines attributes for a node, such as the name-to-address and address-to-name mapping. This alleviates having to specify an A record and a PTR record separately for the same node. A host can also define aliases and DHCP fixed address nodes. The zone must be created first before adding a host record for the zone.
References to record:host are object references. The name part of a Host Record object reference has the following components:
- Name of the host record
- Name of the view
Example: record:host/ZG5zLmhvc3QkLl9kZWZhd3QuaDE:some.name.com/default
The object does not support the following operations when 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): ipv4addrs, ipv6addrs, name, view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| ipv4addrs | The field is required only for an IPv4 object. |
| ipv6addrs | The field is required only for an IPv6 object. |
| name |
This is a list of aliases for the host. The aliases must be in FQDN format. This value can be in unicode format.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
This field controls whether the credential is used for both the Telnet and SSH credentials. If set to False, the credential is used only for SSH.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The CLI credentials for the host record.
Type
A/An CLI credential struct array.
Create
The default value is empty.
Search
The field is not available for search.
Structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
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
When configure_for_dns is false, the host does not have parent zone information.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The time of the record creation in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The creation_time cannot be updated.
creation_time cannot be written.
Determines if the DDNS updates for this record are allowed or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The description of the device.
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
The location of the device.
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
The type of the device.
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
The vendor of the device.
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.
Determines if the discovery for the record is disabled or not. False means that the discovery is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The list of aliases for the host in punycode format.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The name for a host 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.
Determines if the discovery for the record should be immediately enabled.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
enable_immediate_discovery is not readable.
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.
This is a list of IPv4 Addresses for the host.
Type
A/An record:host_ipv4addr object array.
This field supports nested return fields as described here.
This field allows +/- to be specified as part of the field name when updating the object that adds or removes the specified value(s) to the list. An error will be returned if you add already existing value(s) or if you remove non-existent values(s). Note that this is supported only if you use JSON to access the WAPI.
Create
The field is required only for an IPv4 object.
Search
The field is not available for search.
Notes
The ipv4addrs is part of the base object.
This is a list of IPv6 Addresses for the host.
Type
A/An record:host_ipv6addr object array.
This field supports nested return fields as described here.
This field allows +/- to be specified as part of the field name when updating the object that adds or removes the specified value(s) to the list. An error will be returned if you add already existing value(s) or if you remove non-existent values(s). Note that this is supported only if you use JSON to access the WAPI.
Create
The field is required only for an IPv6 object.
Search
The field is not available for search.
Notes
The ipv6addrs is part of the base object.
The time of the last DNS query in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_queried cannot be updated.
last_queried cannot be written.
The Microsoft Active Directory user related information.
Type
A/An Active Directory User Data struct.
Search
The field is not available for search.
Notes
The ms_ad_user_data cannot be updated.
ms_ad_user_data cannot be written.
The host name in FQDN format This value can be in unicode format. Regular expression search is not supported for unicode values.
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 the network view in which the host record resides.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default network view.
Search
The field is available for search via
Notes
The network_view cannot be updated.
Restarts the member service.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
restart_if_needed is not readable.
The value of this field specifies the order in which resource record sets are returned.
The possible values are “cyclic”, “random” and “fixed”.
Type
String.
Create
The default value is cyclic.
Search
The field is not available for search.
The SNMPv3 credential for a host record.
Type
A/An SNMP v3 Credential struct.
Create
The default value is empty.
Search
The field is not available for search.
The SNMPv1 or SNMPv2 credential for a host record.
Type
A/An SNMP Credential struct.
Create
The default value is empty.
Search
The field is not available for search.
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
If set to true, the CLI credential will override member-level settings.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
When use_dns_ea_inheritance is True, the EA is inherited from associated zone.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the SNMPv3 credential should be used for the record.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
If set to true, the SNMP credential will override member-level settings.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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.
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
The alias to search for.
Type
String.
Search
The field is available for search via
Notes
alias is a search-only field.
The IPv4 Address to search for.
Type
String.
Search
The field is available for search via
Notes
ipv4addr is a search-only field.
The IPv6 Address to search for.
Type
String.
Search
The field is available for search via
Notes
ipv6addr is a search-only field.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| aliases | [String] | N | N | N | N/A |
| allow_telnet | Bool | N | N | N | N/A |
| cli_credentials | [struct] | N | N | N | N/A |
| cloud_info | struct | N | Y | N | N/A |
| comment | String | N | N | N | : = ~ |
| configure_for_dns | Bool | N | N | N | N/A |
| creation_time | Timestamp | N | Y | N | N/A |
| ddns_protected | Bool | N | N | N | N/A |
| device_description | String | N | N | N | : = ~ |
| device_location | String | N | N | N | : = ~ |
| device_type | String | N | N | N | : = ~ |
| device_vendor | String | N | N | N | : = ~ |
| disable | Bool | N | N | N | N/A |
| disable_discovery | Bool | N | N | N | N/A |
| dns_aliases | [String] | N | N | N | N/A |
| dns_name | String | N | Y | N | N/A |
| enable_immediate_discovery | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| ipv4addrs | [obj] | Y* | N | Y | N/A |
| ipv6addrs | [obj] | Y* | N | Y | N/A |
| last_queried | Timestamp | N | Y | N | N/A |
| ms_ad_user_data | struct | N | Y | N | N/A |
| name | String | Y | N | Y | : = ~ |
| network_view | String | N | N | N | = |
| restart_if_needed | Bool | N | N | N | N/A |
| rrset_order | String | N | N | N | N/A |
| snmp3_credential | struct | N | N | N | N/A |
| snmp_credential | struct | N | N | N | N/A |
| ttl | Unsigned int | N | N | N | N/A |
| use_cli_credentials | Bool | N | N | N | N/A |
| use_dns_ea_inheritance | Bool | N | N | N | N/A |
| use_snmp3_credential | Bool | N | N | N | N/A |
| use_snmp_credential | Bool | N | N | N | N/A |
| use_ttl | Bool | N | N | N | N/A |
| view | String | N | N | Y | = |
| zone | String | N | Y | N | = |
* Required in some cases, see detailed field description above.
| Field | Type | Search |
|---|---|---|
| alias | String | ! : ~ |
| ipv4addr | String | ! : < > ~ |
| ipv6addr | String | ! : < > ~ |
| mac | String | ! : ~ |
| network | String | = |
record:dtclbdn : DTC LBDN object.
