DNS Wide IP A¶
Overview¶
This document describes the API to configure DNS A wide IPs and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/wideip/a¶
Requests¶
GET /mgmt/cm/dns/working-config/wideip/a/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can use this wide IP and its resources for load balancing. The default setting is Enabled |
failureRcode | string | Specifies the DNS RCODE used when Return Code On Failure is enabled. The default is NOERROR (No Error). If SOA Negative Caching TTL is non-zero, only the Authority section of the NOERROR or NXDOMAIN response will include a SOA record. noerror: Indicates that no type exists at this name. formerr: Indicates that a format error exists in the query. servfail: Indicates that the system is unable to process the query. nxdomain: Indicates that the name does not exist. notimpl: Indicates that there is no support for this kind of query. refused: Indicates that the system refuses to process based on policy |
failureRcodeResponse | string | When enabled, specifies that the system returns a RCODE response to Wide IP requests after exhausting all load-balancing methods. This response is an authoritative empty answer from the system to NAPTR record requests. The default is Disabled |
failureRcodeTtl | number | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0 (zero), meaning no SOA is included, which results in no caching |
lastResortPool | string | Specifies which pool, for the system to use as the last resort pool for the wide IP |
loadBalancingDecisionLogVerbosity | array_of_strings | Specifies which load balancing decisions the system displays in the logs. pool-selection: When checked (enabled), the system logs the pool selected to handle a request. pool-traversal: When checked (enabled), the system logs each pool that was considered in a load balancing decision. pool-member-selection: When checked (enabled), the system logs the pool member selected to handle a request. pool-member-traversal: When checked (enabled), the system logs each pool member that was considered in a load balancing decision |
minimalResponse | string | Specifies that the system forms the smallest allowable DNS response to a query. Typically, this is a single resource record in the answer section. When set to disabled, the system attempts to chase CNAME chains, if required, to obtain the ultimate answer, and it attempts to add address resource records to the additional section of the response for each answer when needed. The default is Enabled |
persistCidrIpv4 | number | Specifies the number of bits the system uses to identify IPv4 addresses when Persistence is enabled. The default is 32 |
persistCidrIpv6 | number | Specifies the number of bits the system uses to identify IPv6 addresses when Persistence is enabled. The default is 128 |
persistence | string | Specifies, when checked, that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests |
poolLbMode | string | Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. global-availability: 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. ratio: The system selects a pool based on the ratio that you assign to the pool. round-robin: The system selects the pools sequentially. topology: 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 defined a topology statement |
ttlPersistence | number | Specifies, in seconds, the length of time for which the persistence entry is valid. The default is 3600 |
type | string | Specifies the type of this wide IP. DNS wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply |
poolReferences | array_of_objects | |
poolReference | reference | A pool reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
poolCnameReferences | array_of_objects | |
poolReference | reference | A pool CNAME reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
aliases | array_of_strings | Specifies alternate domain names for the web site content you are load balancing |
rulesReference | reference | Specifies references for iRules that this wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed, until it finds a matching iRule |
name | string | Name of the resource |
link | string | URI link of the reference. |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the wide IP |
description | string | A description of the wide IP |
deviceGroupReference | reference | DNS Sync Group on which this object is deployed |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
DNS_Viewer | Yes |
DNS_Deployer | Yes |
Service_Catalog_Viewer | Yes |
DNS_Editor | Yes |
Service_Catalog_Editor | Yes |
Application_Manager | Yes |
Application_Viewer | Yes |
Trust_Discovery_Import | Yes |
DNS_Manager | Yes |
POST /mgmt/cm/dns/working-config/wideip/a¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
enabled | boolean | False | Specifies whether the system can use this wide IP and its resources for load balancing. The default setting is Enabled |
failureRcode | string | False | Specifies the DNS RCODE used when Return Code On Failure is enabled. The default is NOERROR (No Error). If SOA Negative Caching TTL is non-zero, only the Authority section of the NOERROR or NXDOMAIN response will include a SOA record. noerror: Indicates that no type exists at this name. formerr: Indicates that a format error exists in the query. servfail: Indicates that the system is unable to process the query. nxdomain: Indicates that the name does not exist. notimpl: Indicates that there is no support for this kind of query. refused: Indicates that the system refuses to process based on policy |
failureRcodeResponse | string | False | When enabled, specifies that the system returns a RCODE response to Wide IP requests after exhausting all load-balancing methods. This response is an authoritative empty answer from the system to NAPTR record requests. The default is Disabled |
failureRcodeTtl | number | False | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0 (zero), meaning no SOA is included, which results in no caching |
lastResortPool | string | False | Specifies which pool, for the system to use as the last resort pool for the wide IP |
loadBalancingDecisionLogVerbosity | array_of_strings | False | Specifies which load balancing decisions the system displays in the logs. pool-selection: When checked (enabled), the system logs the pool selected to handle a request. pool-traversal: When checked (enabled), the system logs each pool that was considered in a load balancing decision. pool-member-selection: When checked (enabled), the system logs the pool member selected to handle a request. pool-member-traversal: When checked (enabled), the system logs each pool member that was considered in a load balancing decision |
minimalResponse | string | False | Specifies that the system forms the smallest allowable DNS response to a query. Typically, this is a single resource record in the answer section. When set to disabled, the system attempts to chase CNAME chains, if required, to obtain the ultimate answer, and it attempts to add address resource records to the additional section of the response for each answer when needed. The default is Enabled |
persistCidrIpv4 | number | False | Specifies the number of bits the system uses to identify IPv4 addresses when Persistence is enabled. The default is 32 |
persistCidrIpv6 | number | False | Specifies the number of bits the system uses to identify IPv6 addresses when Persistence is enabled. The default is 128 |
persistence | string | False | Specifies, when checked, that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests |
poolLbMode | string | False | Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. global-availability: 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. ratio: The system selects a pool based on the ratio that you assign to the pool. round-robin: The system selects the pools sequentially. topology: 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 defined a topology statement |
ttlPersistence | number | False | Specifies, in seconds, the length of time for which the persistence entry is valid. The default is 3600 |
type | string | False | Specifies the type of this wide IP. DNS wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply |
poolReferences | array_of_objects | False | |
poolReference | reference | False | A pool reference for this wide IP to use for load balancing |
link | string | True | URI link of the reference. |
order | number | False | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | False | The system uses this number with the Ratio load balancing method. The default is 1 |
poolCnameReferences | array_of_objects | False | |
poolReference | reference | False | A pool CNAME reference for this wide IP to use for load balancing |
link | string | True | URI link of the reference. |
order | number | False | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | False | The system uses this number with the Ratio load balancing method. The default is 1 |
aliases | array_of_strings | False | Specifies alternate domain names for the web site content you are load balancing |
rulesReference | reference | False | Specifies references for iRules that this wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed, until it finds a matching iRule |
link | string | True | URI link of the reference. |
partition | string | False | The BIG-IP partition in which the configuration for this object is placed |
name | string | False | Displays the name of the wide IP |
description | string | False | A description of the wide IP |
deviceGroupReference | reference | False | DNS Sync Group on which this object is deployed |
link | string | True | URI link of the reference. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can use this wide IP and its resources for load balancing. The default setting is Enabled |
failureRcode | string | Specifies the DNS RCODE used when Return Code On Failure is enabled. The default is NOERROR (No Error). If SOA Negative Caching TTL is non-zero, only the Authority section of the NOERROR or NXDOMAIN response will include a SOA record. noerror: Indicates that no type exists at this name. formerr: Indicates that a format error exists in the query. servfail: Indicates that the system is unable to process the query. nxdomain: Indicates that the name does not exist. notimpl: Indicates that there is no support for this kind of query. refused: Indicates that the system refuses to process based on policy |
failureRcodeResponse | string | When enabled, specifies that the system returns a RCODE response to Wide IP requests after exhausting all load-balancing methods. This response is an authoritative empty answer from the system to NAPTR record requests. The default is Disabled |
failureRcodeTtl | number | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0 (zero), meaning no SOA is included, which results in no caching |
lastResortPool | string | Specifies which pool, for the system to use as the last resort pool for the wide IP |
loadBalancingDecisionLogVerbosity | array_of_strings | Specifies which load balancing decisions the system displays in the logs. pool-selection: When checked (enabled), the system logs the pool selected to handle a request. pool-traversal: When checked (enabled), the system logs each pool that was considered in a load balancing decision. pool-member-selection: When checked (enabled), the system logs the pool member selected to handle a request. pool-member-traversal: When checked (enabled), the system logs each pool member that was considered in a load balancing decision |
minimalResponse | string | Specifies that the system forms the smallest allowable DNS response to a query. Typically, this is a single resource record in the answer section. When set to disabled, the system attempts to chase CNAME chains, if required, to obtain the ultimate answer, and it attempts to add address resource records to the additional section of the response for each answer when needed. The default is Enabled |
persistCidrIpv4 | number | Specifies the number of bits the system uses to identify IPv4 addresses when Persistence is enabled. The default is 32 |
persistCidrIpv6 | number | Specifies the number of bits the system uses to identify IPv6 addresses when Persistence is enabled. The default is 128 |
persistence | string | Specifies, when checked, that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests |
poolLbMode | string | Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. global-availability: 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. ratio: The system selects a pool based on the ratio that you assign to the pool. round-robin: The system selects the pools sequentially. topology: 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 defined a topology statement |
ttlPersistence | number | Specifies, in seconds, the length of time for which the persistence entry is valid. The default is 3600 |
type | string | Specifies the type of this wide IP. DNS wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply |
poolReferences | array_of_objects | |
poolReference | reference | A pool reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
poolCnameReferences | array_of_objects | |
poolReference | reference | A pool CNAME reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
aliases | array_of_strings | Specifies alternate domain names for the web site content you are load balancing |
rulesReference | reference | Specifies references for iRules that this wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed, until it finds a matching iRule |
name | string | Name of the resource |
link | string | URI link of the reference. |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the wide IP |
description | string | A description of the wide IP |
deviceGroupReference | reference | DNS Sync Group on which this object is deployed |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
DNS_Viewer | No |
DNS_Deployer | No |
Service_Catalog_Viewer | No |
DNS_Editor | Yes |
Service_Catalog_Editor | No |
Application_Manager | No |
Application_Viewer | No |
Trust_Discovery_Import | No |
DNS_Manager | Yes |
PATCH /mgmt/cm/dns/working-config/wideip/a/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
enabled | boolean | False | Specifies whether the system can use this wide IP and its resources for load balancing. The default setting is Enabled |
failureRcode | string | False | Specifies the DNS RCODE used when Return Code On Failure is enabled. The default is NOERROR (No Error). If SOA Negative Caching TTL is non-zero, only the Authority section of the NOERROR or NXDOMAIN response will include a SOA record. noerror: Indicates that no type exists at this name. formerr: Indicates that a format error exists in the query. servfail: Indicates that the system is unable to process the query. nxdomain: Indicates that the name does not exist. notimpl: Indicates that there is no support for this kind of query. refused: Indicates that the system refuses to process based on policy |
failureRcodeResponse | string | False | When enabled, specifies that the system returns a RCODE response to Wide IP requests after exhausting all load-balancing methods. This response is an authoritative empty answer from the system to NAPTR record requests. The default is Disabled |
failureRcodeTtl | number | False | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0 (zero), meaning no SOA is included, which results in no caching |
lastResortPool | string | False | Specifies which pool, for the system to use as the last resort pool for the wide IP |
loadBalancingDecisionLogVerbosity | array_of_strings | False | Specifies which load balancing decisions the system displays in the logs. pool-selection: When checked (enabled), the system logs the pool selected to handle a request. pool-traversal: When checked (enabled), the system logs each pool that was considered in a load balancing decision. pool-member-selection: When checked (enabled), the system logs the pool member selected to handle a request. pool-member-traversal: When checked (enabled), the system logs each pool member that was considered in a load balancing decision |
minimalResponse | string | False | Specifies that the system forms the smallest allowable DNS response to a query. Typically, this is a single resource record in the answer section. When set to disabled, the system attempts to chase CNAME chains, if required, to obtain the ultimate answer, and it attempts to add address resource records to the additional section of the response for each answer when needed. The default is Enabled |
persistCidrIpv4 | number | False | Specifies the number of bits the system uses to identify IPv4 addresses when Persistence is enabled. The default is 32 |
persistCidrIpv6 | number | False | Specifies the number of bits the system uses to identify IPv6 addresses when Persistence is enabled. The default is 128 |
persistence | string | False | Specifies, when checked, that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests |
poolLbMode | string | False | Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. global-availability: 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. ratio: The system selects a pool based on the ratio that you assign to the pool. round-robin: The system selects the pools sequentially. topology: 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 defined a topology statement |
ttlPersistence | number | False | Specifies, in seconds, the length of time for which the persistence entry is valid. The default is 3600 |
type | string | False | Specifies the type of this wide IP. DNS wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply |
poolReferences | array_of_objects | False | |
poolReference | reference | False | A pool reference for this wide IP to use for load balancing |
link | string | True | URI link of the reference. |
order | number | False | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | False | The system uses this number with the Ratio load balancing method. The default is 1 |
poolCnameReferences | array_of_objects | False | |
poolReference | reference | False | A pool CNAME reference for this wide IP to use for load balancing |
link | string | True | URI link of the reference. |
order | number | False | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | False | The system uses this number with the Ratio load balancing method. The default is 1 |
aliases | array_of_strings | False | Specifies alternate domain names for the web site content you are load balancing |
rulesReference | reference | False | Specifies references for iRules that this wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed, until it finds a matching iRule |
link | string | True | URI link of the reference. |
description | string | False | A description of the wide IP |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can use this wide IP and its resources for load balancing. The default setting is Enabled |
failureRcode | string | Specifies the DNS RCODE used when Return Code On Failure is enabled. The default is NOERROR (No Error). If SOA Negative Caching TTL is non-zero, only the Authority section of the NOERROR or NXDOMAIN response will include a SOA record. noerror: Indicates that no type exists at this name. formerr: Indicates that a format error exists in the query. servfail: Indicates that the system is unable to process the query. nxdomain: Indicates that the name does not exist. notimpl: Indicates that there is no support for this kind of query. refused: Indicates that the system refuses to process based on policy |
failureRcodeResponse | string | When enabled, specifies that the system returns a RCODE response to Wide IP requests after exhausting all load-balancing methods. This response is an authoritative empty answer from the system to NAPTR record requests. The default is Disabled |
failureRcodeTtl | number | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0 (zero), meaning no SOA is included, which results in no caching |
lastResortPool | string | Specifies which pool, for the system to use as the last resort pool for the wide IP |
loadBalancingDecisionLogVerbosity | array_of_strings | Specifies which load balancing decisions the system displays in the logs. pool-selection: When checked (enabled), the system logs the pool selected to handle a request. pool-traversal: When checked (enabled), the system logs each pool that was considered in a load balancing decision. pool-member-selection: When checked (enabled), the system logs the pool member selected to handle a request. pool-member-traversal: When checked (enabled), the system logs each pool member that was considered in a load balancing decision |
minimalResponse | string | Specifies that the system forms the smallest allowable DNS response to a query. Typically, this is a single resource record in the answer section. When set to disabled, the system attempts to chase CNAME chains, if required, to obtain the ultimate answer, and it attempts to add address resource records to the additional section of the response for each answer when needed. The default is Enabled |
persistCidrIpv4 | number | Specifies the number of bits the system uses to identify IPv4 addresses when Persistence is enabled. The default is 32 |
persistCidrIpv6 | number | Specifies the number of bits the system uses to identify IPv6 addresses when Persistence is enabled. The default is 128 |
persistence | string | Specifies, when checked, that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests |
poolLbMode | string | Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. global-availability: 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. ratio: The system selects a pool based on the ratio that you assign to the pool. round-robin: The system selects the pools sequentially. topology: 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 defined a topology statement |
ttlPersistence | number | Specifies, in seconds, the length of time for which the persistence entry is valid. The default is 3600 |
type | string | Specifies the type of this wide IP. DNS wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply |
poolReferences | array_of_objects | |
poolReference | reference | A pool reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
poolCnameReferences | array_of_objects | |
poolReference | reference | A pool CNAME reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
aliases | array_of_strings | Specifies alternate domain names for the web site content you are load balancing |
rulesReference | reference | Specifies references for iRules that this wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed, until it finds a matching iRule |
name | string | Name of the resource |
link | string | URI link of the reference. |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the wide IP |
description | string | A description of the wide IP |
deviceGroupReference | reference | DNS Sync Group on which this object is deployed |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
DNS_Viewer | No |
DNS_Deployer | No |
Service_Catalog_Viewer | No |
DNS_Editor | Yes |
Service_Catalog_Editor | No |
Application_Manager | No |
Application_Viewer | No |
Trust_Discovery_Import | No |
DNS_Manager | Yes |
DELETE /mgmt/cm/dns/working-config/wideip/a/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
enabled | boolean | Specifies whether the system can use this wide IP and its resources for load balancing. The default setting is Enabled |
failureRcode | string | Specifies the DNS RCODE used when Return Code On Failure is enabled. The default is NOERROR (No Error). If SOA Negative Caching TTL is non-zero, only the Authority section of the NOERROR or NXDOMAIN response will include a SOA record. noerror: Indicates that no type exists at this name. formerr: Indicates that a format error exists in the query. servfail: Indicates that the system is unable to process the query. nxdomain: Indicates that the name does not exist. notimpl: Indicates that there is no support for this kind of query. refused: Indicates that the system refuses to process based on policy |
failureRcodeResponse | string | When enabled, specifies that the system returns a RCODE response to Wide IP requests after exhausting all load-balancing methods. This response is an authoritative empty answer from the system to NAPTR record requests. The default is Disabled |
failureRcodeTtl | number | Specifies the negative caching TTL of the SOA for the RCODE response. The default is 0 (zero), meaning no SOA is included, which results in no caching |
lastResortPool | string | Specifies which pool, for the system to use as the last resort pool for the wide IP |
loadBalancingDecisionLogVerbosity | array_of_strings | Specifies which load balancing decisions the system displays in the logs. pool-selection: When checked (enabled), the system logs the pool selected to handle a request. pool-traversal: When checked (enabled), the system logs each pool that was considered in a load balancing decision. pool-member-selection: When checked (enabled), the system logs the pool member selected to handle a request. pool-member-traversal: When checked (enabled), the system logs each pool member that was considered in a load balancing decision |
minimalResponse | string | Specifies that the system forms the smallest allowable DNS response to a query. Typically, this is a single resource record in the answer section. When set to disabled, the system attempts to chase CNAME chains, if required, to obtain the ultimate answer, and it attempts to add address resource records to the additional section of the response for each answer when needed. The default is Enabled |
persistCidrIpv4 | number | Specifies the number of bits the system uses to identify IPv4 addresses when Persistence is enabled. The default is 32 |
persistCidrIpv6 | number | Specifies the number of bits the system uses to identify IPv6 addresses when Persistence is enabled. The default is 128 |
persistence | string | Specifies, when checked, that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests |
poolLbMode | string | Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. global-availability: 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. ratio: The system selects a pool based on the ratio that you assign to the pool. round-robin: The system selects the pools sequentially. topology: 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 defined a topology statement |
ttlPersistence | number | Specifies, in seconds, the length of time for which the persistence entry is valid. The default is 3600 |
type | string | Specifies the type of this wide IP. DNS wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply |
poolReferences | array_of_objects | |
poolReference | reference | A pool reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
poolCnameReferences | array_of_objects | |
poolReference | reference | A pool CNAME reference for this wide IP to use for load balancing |
name | string | Name of the resource |
link | string | URI link of the reference. |
order | number | Specifies the order of this pool. The system evaluates the pools in the order in which they are listed, until it finds a matching pool |
ratio | number | The system uses this number with the Ratio load balancing method. The default is 1 |
aliases | array_of_strings | Specifies alternate domain names for the web site content you are load balancing |
rulesReference | reference | Specifies references for iRules that this wide IP uses for load balancing decisions. The system evaluates the iRules in the order in which they are listed, until it finds a matching iRule |
name | string | Name of the resource |
link | string | URI link of the reference. |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the wide IP |
description | string | A description of the wide IP |
deviceGroupReference | reference | DNS Sync Group on which this object is deployed |
name | string | Name of the resource |
link | string | URI link of the reference. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
DNS_Viewer | No |
DNS_Deployer | No |
Service_Catalog_Viewer | No |
DNS_Editor | Yes |
Service_Catalog_Editor | No |
Application_Manager | No |
Application_Viewer | No |
Trust_Discovery_Import | No |
DNS_Manager | Yes |
Examples¶
Get a wide IP of type A¶
GET /mgmt/cm/dns/working-config/wideip/a/<id>
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Get all wide IPs of type A¶
GET /mgmt/cm/dns/working-config/wideip/a
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Create new wide IP A¶
POST /mgmt/cm/dns/working-config/wideip/a
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Update wide IP A¶
PATCH /mgmt/cm/dns/working-config/wideip/a/<id>
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}],
"description": "example server"
}
Response¶
HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}