DTC Header Items
This topic lists all the DTC objects whose names start with "dtc". These objects are displayed as DtcLbdn, DtcServer, and so on in the CSV export or import file. The object DtcCertificate supports only CSV export, whereas other objects support CSV import and export. For details, see the following sections:
DtcLbdn Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcLbdn | String | Yes | DtcLbdn | ||
name* | String | Yes | load_bal | ||
_new_name | String | No | name | ||
lb_method* | String | Yes | GLOBAL_AVAILABILITY | lb_method | Valid values are 'GLOBAL_AVAILABILITY', 'RATIO', 'ROUND_ROBIN', 'TOPOLOGY' and 'SOURCE_IP_HASH' |
patterns | List of strings | No | .domain.com, .test.com' | patterns | Valid value is an array of FQDN patterns in string format |
disabled | Boolean | No | false | disabled | |
comment | String | No | A DTC LBDN comment | comment | |
persistence | Unsigned integer | No | 5 | persistence | Zero specifies no caching |
topology | String | No | topology-1 | topology | |
ttl | Unsigned integer | No | 10 | ttl | |
pools | LBDN linked list of pools | No | pool/ratio eg: "pool1/1,pool2/10... | pools | |
auth_zones | LBDN linked list of auth zones | No | Must be in the zone_name/view_name format. For example: authzone1.com/view1, authzone2.com/view2... | auth_zones | List of DTC LBDN linked authoritative zones |
types | String | No | NAPTR | types | Valid values are 'A', 'AAA', 'NAPTR', 'CNAME' |
priority | Unsigned integer | No | 3 | priority | Valid values between 1 and 3. The default is 3. |
EA-Site | String | No | San Jose |
DtcServer Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcServer | String | Yes | DtcServer | ||
name* | String | Yes | server1 | name | |
_new_name | String | No | name | ||
host* | String | Yes | 192.168.1.2 | host | Address or FQDN of a DTC server |
disabled | Boolean | No | false | disabled | |
comment | String | No | A DTC server comment | comment | |
auto_create_host_record | Boolean | No | false | comment | |
sni_hostname | String | No | sni-host.infoblox.localdomain | sni_hostname | Host name for Server Network Indication to be used with the HTTPS monitor |
monitors | List of DTC health monitors | No | Monitor name/Monitor type/Host For example: TCP-1/tcp/10.10.10.10,SIP-1/sip/20.20.20.20, | monitors | List of names of DTC server monitors |
EA-Site | String | No | San Jose |
DtcPool Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcPool | String | Yes | DtcPool | ||
name* | String | Yes | pool1 | name | |
_new_name | String | No | name | ||
lb_preferred_method | String | No | RATIO | lb_preferred_method | Valid values are 'ALL_AVAILABLE', 'DYNAMIC_RATIO', 'GLOBAL_AVAILABILITY', 'RATIO', 'ROUND_ROBIN', 'TOPOLOGY', and 'SOURCE_IP_HASH' |
disabled | Boolean | No | false | disabled | |
comment | String | No | A DTC pool comment | comment | |
lb_preferred_topology | Topology rules for preferred 'TOPOLOGY' load balancing method | No | custom-2 | preferred_topology | |
lb_alternate_method | String | No | RATIO | alternate_method | Alternate load balancing method. Valid values are 'ALL_AVAILABLE', 'DYNAMIC_RATIO', 'NONE', 'GLOBAL_AVAILABILITY', 'RATIO', 'ROUND_ROBIN', 'TOPOLOGY' , and 'SOURCE_IP_HASH'. |
lb_alternate_topology | Topology rules for alternate 'TOPOLOGY' load balancing method | No | custom-3 | alternate_topology | |
availability | String | No | any | availability | DTC pool resources availability status. Valid values are 'ALL', 'ANY', and 'QUORUM'. |
quorum | Unsigned integer | No | 20 | quorum | The number of monitors that must report the resource as 'up' for 'QUORUM' availability mode to be available. |
ttl | Unsigned integer | No | 10 | ttl | |
servers | List of DTC servers | No | server/ratio For example: dtc-server1/1,dtc-server2/10... | servers | |
monitors | List of health monitors | No | Monitor name/Monitor type For example: ICMP-1/icmp,HTTP-1/http,... | monitors | List of names and monitor types of DTC pool monitors |
dynamic_ratio_preferred | Preferred dynamic ratio load balancing settings | No | method/monitor/monitor_metric/monitor_weighing/ | dynamic_ratio_preferred | When preferred_method="DYNAMIC_RATIO" |
dynamic_ratio_alternate | Alternate dynamic ratio load balancing settings | No | method/monitor/monitor_metric/monitor_weighing/ For example: MONITOR/snmp/.1.3/PRIORITY/false | dynamic_ratio_alternate | When preferred_method="TOPOLOGY" and alternate_method="DYNAMIC_RATIO" |
EA-Site | String | No | San Jose |
DtcMonitorHttp Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcMonitorHttp | String | Yes | DtcMonitorHttp | ||
name* | String | Yes | http_monitor1 | name | |
_new_name | String | No | name | ||
comment | String | No | A DTC HTTP monitor comment | comment | |
interval | Unsigned integer | No | 10 | interval | |
timeout | Unsigned integer | No | 7 | timeout | Valid values between 1 and 15 |
port | Unsigned integer | No | 8080 | port | Valid values between 1 and 65535 |
request | String | No | GET / | request | Maximum of 1024 characters |
content_check | String | No | EXTRACT | content_check | Valid values are 'NONE'(default), 'MATCH', and 'EXTRACT'. If 'MATCH', then 'content_check_op' and 'content_check_regex' params are required; if 'EXTRACT' then ‘content_check_op’,’content_extract_type’, ‘content_extract_value’, and ’content_check_regex’ values are required. |
content_check_input | String | No | BODY | content_check_input | Valid values are 'HEADERS', 'ALL'(default) and 'BODY' |
content_check_regex | String | No | SQL Error | content_check_regex | |
content_check_op | String | No | EQ | content_check_op | Valid values are 'EQ' and 'NEQ' for 'MATCH' content check, and 'EQ', 'NEQ', 'LEQ', and 'GEQ' for 'EXTRACT' content check type |
content_extract_group | Unsigned integer | No | 3 | content_extract_group | Valid values between 0 and 8. The default is 0. |
content_extract_type | String | No | INTEGER | content_extract_type | Valid values are 'INTEGER' and 'STRING'. The default is 'STRING'. |
content_extract_value | String | No | 1 | content_extract_value | A desired extraction value in string format |
result | String | No | CODE_IS | result | Valid values are 'ANY', 'CODE_IS', and 'CODE_IS_NOT' |
result_code | Unsigned integer | No | 300 | result_code | Valid values between 0 and 999 |
secure | Boolean | No | true | secure | Default is 'false' |
client_cert | Client certificate | No | 626596e ... 4362f80c (128 characters) | client_cert | Valid value is a DTC certificate object. |
ciphers | String | No | DHE-RSA-AES256-SHA | ciphers | Valid value is array of ciphers in a string format |
retry_up | Unsigned integer | No | 3 | retry_up | Valid values between 1 and 10 |
retry_down | Unsigned integer | No | 3 | retry_down | Valid values between 1 and 10 |
validate_cert | Boolean | No | false | validate_cert | Default is 'true' |
enable_sni | Boolean | No | true | enable_sni | Default is 'false' |
EA-Site | String | No | San Jose |
DtcMonitorSip Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcMonitorSip | String | Yes | DtcMonitorSip | ||
name* | String | Yes | sip_monitor1 | name | |
_new_name | String | No | name | ||
comment | String | No | A DTC SIP monitor comment | comment | |
interval | Unsigned integer | No | 10 | interval | |
timeout | Unsigned integer | No | 7 | timeout | Valid values between 1 and 15 |
port | Unsigned integer | No | 8080 | port | Valid values between 1 and 65535 |
request | String | No | GET / | request | Maximum of 1024 characters |
result | String | No | CODE_IS | result | Valid values are 'ANY', 'CODE_IS', and 'CODE_IS_NOT' |
result_code | Unsigned integer | No | 300 | result_code | Valid values between 0 and 999 |
transport | String | No | UDP | transport | Valid values are 'TCP', 'UDP', 'SIPS', and 'TLS' |
client_cert | Client certificate | No | 626596e ... 4362f80c (128 characters) | client_cert | Valid value is a DTC certificate object |
ciphers | String | No | DHE-RSA-AES256-SHA | ciphers | Valid value is array of ciphers in a string format |
retry_up | Unsigned integer | No | 3 | retry_up | Valid values between 1 and 10 |
retry_down | Unsigned integer | No | 3 | retry_down | Valid values between 1 and 10 |
validate_cert | Boolean | No | false | validate_cert | Default is 'true' |
EA-Site | String | No | San Jose |
DtcMonitorIcmp Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcMonitorIcmp | String | Yes | DtcMonitorlcmp | ||
name* | String | Yes | lcmp_monitor1 | name | |
_new_name | String | No | name | ||
comment | String | No | A DTC ICMP monitor comment | comment | |
interval | Unsigned integer | No | 10 | interval | |
timeout | Unsigned integer | No | 7 | timeout | Valid values between 1 and 15 |
retry_up | Unsigned integer | No | 3 | retry_up | Valid values between 1 and 10 |
retry_down | Unsigned integer | No | 3 | retry_down | Valid values between 1 and 10 |
EA-Site | String | No | San Jose |
DtcMonitorPdp Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcMonitorPdp | String | Yes | DtcMonitorPdp | ||
name* | String | Yes | pdp_monitor1 | name | |
_new_name | String | No | name | ||
comment | String | No | A DTC PDP monitor comment | comment | |
interval | Unsigned integer | No | 10 | interval | |
timeout | Unsigned integer | No | 7 | timeout | Valid values between 1 and 15 |
retry_up | Unsigned integer | No | 5 | retry_up | Valid values between 1 and 10 |
retry_down | Unsigned integer | No | 5 | retry_down | Valid values between 1 and 10 |
port | Unsigned integer | No | 6030 | port | Valid values between 1 and 65535 |
EA-Site | String | No | San Jose |
DtcMonitorTcp Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcMonitorTcp | String | Yes | DtcMonitorTcp | ||
name* | String | Yes | tcp_monitor1 | name | |
port* | Unsigned integer | 6030 | port | Valid values between 1 and 65535 | |
_new_name | String | No | name | ||
comment | String | No | A DTC PDP monitor comment | comment | |
interval | Unsigned integer | No | 10 | interval | |
timeout | Unsigned integer | No | 7 | timeout | Valid values between 1 and 15 |
retry_up | Unsigned integer | No | 3 | retry_up | Valid values between 1 and 10 |
retry_down | Unsigned integer | No | 3 | retry_down | Valid values between 1 and 10 |
EA-Site | String | No | San Jose |
DtcMonitorSnmp Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcMonitorSnmp | String | Yes | DtcMonitorSnmp | ||
name* | String | Yes | snmp_monitor1 | name | |
port | Unsigned integer | 6030 | port | Valid values between 1 and 65535 | |
_new_name | String | No | name | ||
comment | String | No | A DTC SNMP monitor comment | comment | |
interval | Unsigned integer | No | 10 | interval | |
timeout | Unsigned integer | No | 7 | timeout | Valid values between 1 and 15 |
retry_up | Unsigned integer | No | 3 | retry_up | Valid values between 1 and 10 |
retry_down | Unsigned integer | No | 3 | retry_down | Valid values between 1 and 10 |
version | String | No | V1 | version | Valid values are 'V1', 'V2C', and 'V3' |
community | String | No | desired_community | community | SNMP community string for an SNMP authentication |
oids | List of OIDs for SNMP monitoring | No | .1.3/Comment-1/INTEGER/RANGE/10/1000,.1.2/Comment-2/STRING/EXACT/abc/,... | oids | |
user | String | No | user1 | user | SNMPv3 user setting |
context | String | desired_context | context | SNMPv3 context. Maximum of 1023 characters. | |
engine_id | String | No | desired_engine_id | engine_id | SNMPv3 engine identifier. Max of 1023 characters. |
EA-Site | String | No | San Jose |
DtcARecord Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcARecord | String | Yes | DtcARecord | ||
ipv4addr* | IPv4 address | Yes | 10.0.0.1 | address | |
_new_ipv4addr | IPv4 address | No | address | ||
dtc_server* | DTC server | Yes | server1 | lbdns_server | DTC server the DTC A record is associated with |
ttl | Unsigned integer | No | 1024 | ttl | |
disabled | Boolean | No | false | disabled | |
comment | String | No | Sample DTC A record | comment |
DtcAaaaRecord Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcAaaaRecord | String | Yes | DtcAaaaRecord | ||
ipv6addr* | IPv6 address | Yes | 2001:db8::1 | address | |
_new_ipv6addr | IPv6 address | No | address | ||
dtc_server | DTC server | Yes | server1 | dtc_server | DTC Server the DTC AAAA record is associated with |
ttl | Unsigned integer | No | 1024 | ttl | |
disabled | Boolean | No | false | disabled | |
comment | String | No | Sample DTC AAAA record | comment |
DtcCnameRecord Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcCnameRecord | String | Yes | DtcCnameRecord | ||
canonical* | String | Yes | dtc.localdomain | canonical_name | Canonical name of the resource |
_new_canonical | String | No | canonical_name | ||
dtc_server* | DTC server | Yes | server1 | dtc_server | DTC Server the DTC CNAME record is associated with |
ttl | Unsigned integer | No | 1024 | ttl | |
disabled | Boolean | No | false | disabled | |
comment | String | No | Sample DTC CNAME record | comment |
DtcNaptrRecord Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-DtcNaptrRecord | String | Yes | DtcNaptrRecord | ||
dtc_server* | DTC server | Yes | server1 | dtc_server | DTC server the DTC NAPTR record is associated with |
order* | Unsigned integer | Yes | 100 | order | |
_new_order | Unsigned integer | No | order | ||
preference* | Unsigned integer | Yes | 10 | preference | |
_new_preference | Unsigned integer | No | preference | ||
replacement* | String | Yes | domain2.com | replacement | The desired replacement value in a Fully-Qualified Domain Name (FQDN) format. |
_new_replacement | String | No | replacement | ||
flags* | String | No | U | flags | Empty value is allowed. Supported values for the flags field are 'U', 'S', 'P', and 'A'. |
_new_flags | String | No | flags | ||
services* | String | No | SIP+D2U | services | Empty value is allowed |
_new_services | String | No | services | ||
regexp* | String | No | !http://my[.](.*)!1!i | regexp | Empty value is allowed |
_new_regexp | String | No | services | ||
ttl | Unsigned integer | No | 28800 | ttl | |
disabled | Boolean | No | false | disabled | |
comment | String | No | Sample DTC NAPTR record | comment |
DtcCertificate Header Items
Name | Type | Required | Example | lbap Name | Comment |
---|---|---|---|---|---|
Header-Dtccertificate | String | Yes | DtcCertificate | ||
certificate | DTC certificate | No | Object Hash/Issuer/Valid from/Valid to/Subject For example: "702971b9b6bb34468f6006389f53849dff43c78 | cert | Object hash is the SHA512 fingerprint of the certificate, that is to be used during the CSV import/export of dtcMonitorHttp and dtcMonitorSip objects in the client_cert field |