This is a DTC Server. Aka resource, virtual server or pool member.
References to dtc:server are object references. The name part of a DTC Server object reference has the following components:
- Name of DTC Server
Example: dtc:server/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCServer1
The object does not support the following operations:
The object cannot be 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): comment, host, name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| host | |
| name |
Enabling this option will auto-create a single read-only A/AAAA/CNAME record corresponding to the configured hostname and update it if the hostname changes.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Comment for the DTC Server; 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
Notes
The comment is part of the base object.
Determines whether the DTC Server is disabled or not. When this is set to False, the fixed address is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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.
The health status.
Type
A/An Health information struct.
Search
The field is not available for search.
Notes
The health cannot be updated.
health cannot be written.
The address or FQDN of the server.
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 host is part of the base object.
List of IP/FQDN and monitor pairs to be used for additional monitoring.
Type
A/An DTC Server Monitor struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The DTC Server display name.
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 hostname for Server Name Indication (SNI) in FQDN format.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Notes
sni_hostname is associated with the field use_sni_hostname (see use flag).
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.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| auto_create_host_record | Bool | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| disable | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| health | struct | N | Y | N | N/A |
| host | String | Y | N | Y | : = ~ |
| monitors | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| sni_hostname | String | N | N | N | : = ~ |
| use_sni_hostname | Bool | N | N | N | N/A |
| Field | Type | Search |
|---|---|---|
| status_member | String | : = ~ |
dtc:record:srv : DTC SRV Record object.