APIRef_tm_gtm_wideip_aaaa¶
mgmt/tm/gtm/wideip/aaaa
Wide IP type AAAA configuration
REST Endpoints
- Collection URI
/mgmt/tm/gtm/wideip/aaaa
- Collection Methods
OPTIONS, GET
- Resource URI
/mgmt/tm/gtm/wideip/aaaa/~resource id
- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
- Resource Natural Key
name, partition, subPath
Properties
Name | Type | Default Value | Required | Access | Description |
---|---|---|---|---|---|
appService |
string | optional | read/write | The application service that the object belongs to. | |
description |
string | optional | read/write | User defined description. | |
disabled |
boolean | true | optional | read/write | Specifies that the Wide IP and its resources are not available for load balancing. |
enabled |
boolean | true | optional | read/write | Specifies that the Wide IP and its resources are available for load balancing. |
failureRcode |
string | noerror | optional | read/write | Specifies the DNS RCODE used when failure-rcode-response is enabled. |
failureRcodeResponse |
string | disabled | optional | read/write | Specifies whether RCODE responses are enabled. |
failureRcodeTtl |
integer | 0 | optional | read/write | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0, meaning no SOA is included (i.e. no caching). |
lastResortPool |
string | optional | read/write | Specifies a last resort pool to use when load balancing requests for this wide IP. Any AAAA or CNAME pool type is allowed. | |
loadBalancingDecisionLogVerbosity |
string | 0 | optional | read/write | Specifies the amount of detail logged when making load balancing decisions. It is for debugging purpose only. Performance will be affected when the value is not none. Please reset it back to none after done debugging. Default is none. |
minimalResponse |
string | enabled | optional | read/write | Specifies the content of the DNS response. |
tmPartition |
string | Common | optional | read/write | Displays the partition within which this object resides. |
persistCidrIpv4 |
integer | 32 | optional | read/write | Specifies a mask used to group IPv4 LDNS addresses. This feature allows one persistence record to be shared by LDNS addresses that match within this mask. |
persistCidrIpv6 |
integer | 128 | optional | read/write | Specifies a mask used to group IPv6 LDNS addresses. This feature allows one persistence record to be shared by LDNS addresses that match within this mask. |
persistence |
string | disabled | optional | read/write | Specifies that when a local DNS server makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests. |
poolLbMode |
string | round-robin | optional | read/write | Specifies the load balancing method used to select a pool in this Wide IP. This option is relevant only when multiple pools are configured for this Wide IP. The load balancing methods are global availability (Specifies that the system selects a pool by following the order of the Pool List. The system repeatedly selects the first pool in the list for as long as its status is available. If the pool becomes unavailable for any reason, the system then repeatedly selects the next pool in the list, and so on.), random (Specifies that the system selects a pool in no pattern or order.), ratio (Specifies that the system selects a pool based on the ratio that you assign to the pool.), round robin (Specifies that the system selects pools sequentially.), and topology (Specifies that the system selects a pool based on topology information in the incoming LDNS request. Note that this load balancing method works only if you have configured a topology statement.). |
ttlPersistence |
integer | 3600 | optional | read/write | Specifies, in seconds, the length of time for which a persistence entry is valid. This value can range from 0 to 4294967295 seconds. |
type |
string | optional | read/write |
Lists
Name | Type | Default Value | Required | Access | Description |
---|---|---|---|---|---|
undefined |
array_structure | optional | read/write | Specifies alternate domain names for the web site content you are load balancing. You can use two different wildcard characters, * and ?, to represent one or more characters. | |
rules (gtm/rule) |
array_structure | optional | read/write | Specifies the iRules that this Wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed. |
Array Structures
Name | Type | Default Value | Required | Access | Description |
---|---|---|---|---|---|
/metadata |
array_structure | optional | read/write | User defined generic data for the Wide IP. It is a name and value pair. | |
/metadata/app-service |
string | optional | read/write | The application service that the object belongs to. | |
/metadata/persist |
string | true | optional | read/write | Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files. |
/metadata/value |
string | optional | read/write | Value of the Wide IP metadata | |
/pools |
array_structure | optional | read/write | Adds a pool to or deletes a pool from this Wide IP. | |
/pools/app-service |
string | optional | read/write | The application service that the object belongs to. | |
/pools/order |
integer | optional | read/write | Specifies the order of this pool in relation to other pools attached to this Wide IP. Pool order is significant when the Global Availability load balancing method is utilized. | |
/pools/ratio |
integer | 1 | optional | read/write | Specifies a ratio for this pool that the system uses when utilizing the Ratio load balancing method to route requests to pools in this Wide IP. |
/pools-cname |
array_structure | optional | read/write | Adds a pool to or deletes a pool from this wide IP. | |
/pools-cname/app-service |
string | optional | read/write | The application service that the object belongs to. | |
/pools-cname/order |
integer | optional | read/write | Specifies the order of this pool in relation to other pools attached to this Wide IP. Pool order is significant when the Global Availability load balancing method is utilized. | |
/pools-cname/ratio |
integer | 1 | optional | read/write | Specifies a ratio for this pool that the system uses when utilizing the Ratio load balancing method to route requests to pools in this wide IP. |
/pools-cname/type |
string | optional | read/write |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.