DNS Pool AAAA¶
Overview¶
This document describes the API to configure DNS AAAA pools and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/pool/aaaa¶
Requests¶
GET /mgmt/cm/dns/working-config/pool/aaaa/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
alternateMode | string | The load balancing mode that the system tries if the Preferred method is unsuccessful in picking a pool |
dynamicRatio | string | Specifies, whether the system applies a dynamic ratio to the load balancing algorithms for this pool. When dynamic ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation. Checked (enabled): This setting is applicable only when the pool is assigned a dynamic load balancing method: Round Trip Times, VS Score, Completion Rate, Hops, Kilobytes/Second, VS Capacity, or Quality of Service. Unchecked (disabled): The system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. This is the default value |
enabled | boolean | Specifies whether the pool and its resources are available for load balancing. The default is Enabled |
fallbackIp | string | Specifies the IP address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select a Fallback load |
fallbackMode | string | The load balancing mode that the system tries if both the Preferred and Alternate methods are unsuccessful in picking a pool |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | The number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable |
limitMaxConnectionsStatus | string | Specifies whether a limit should be set for the number of current connections allowed for the virtual servers in the pool |
limitMaxPps | number | The maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxPpsStatus | string | |
loadBalancingMode | string | The load balancing mode that the system tries first |
manualResume | string | Specifies, whether you must manually restart a pool member that goes down |
maxAnswersReturned | number | Specifies the maximum number of available virtual servers that the system lists in a response. The default is 1. The maximum is 500 |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing |
availabilityRequirements | string | Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available |
qosHitRatio | number | Specifies the weight of the pool member for load balancing purposes. The default is 1 |
qosHops | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosKilobytesSecond | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosLcs | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosPacketRate | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosRtt | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosTopology | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsCapacity | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsScore | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
ttl | number | Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. You can type a value between 0 and 4294967295; the default setting is 30 |
type | string | Specifies the type of pool. DNS pools 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 |
verifyMemberAvailability | string | Specifies that the system verifies the availability of the pool members before sending a connection to those resources. When set to disabled, pool members that are marked down (red) by a monitor will be treated as if they were up (green). The default setting is enabled |
membersReference | reference | Pool members that make up this pool |
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 pool |
description | string | A description of the pool |
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/pool/aaaa¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
alternateMode | string | False | The load balancing mode that the system tries if the Preferred method is unsuccessful in picking a pool |
dynamicRatio | string | False | Specifies, whether the system applies a dynamic ratio to the load balancing algorithms for this pool. When dynamic ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation. Checked (enabled): This setting is applicable only when the pool is assigned a dynamic load balancing method: Round Trip Times, VS Score, Completion Rate, Hops, Kilobytes/Second, VS Capacity, or Quality of Service. Unchecked (disabled): The system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. This is the default value |
enabled | boolean | False | Specifies whether the pool and its resources are available for load balancing. The default is Enabled |
fallbackIp | string | False | Specifies the IP address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select a Fallback load |
fallbackMode | string | False | The load balancing mode that the system tries if both the Preferred and Alternate methods are unsuccessful in picking a pool |
limitMaxBps | number | False | The maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxBpsStatus | string | False | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | False | The number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable |
limitMaxConnectionsStatus | string | False | Specifies whether a limit should be set for the number of current connections allowed for the virtual servers in the pool |
limitMaxPps | number | False | The maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxPpsStatus | string | False | |
loadBalancingMode | string | False | The load balancing mode that the system tries first |
manualResume | string | False | Specifies, whether you must manually restart a pool member that goes down |
maxAnswersReturned | number | False | Specifies the maximum number of available virtual servers that the system lists in a response. The default is 1. The maximum is 500 |
healthMonitors | string | False | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing |
availabilityRequirements | string | False | Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available |
qosHitRatio | number | False | Specifies the weight of the pool member for load balancing purposes. The default is 1 |
qosHops | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosKilobytesSecond | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosLcs | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosPacketRate | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosRtt | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosTopology | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsCapacity | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsScore | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
ttl | number | False | Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. You can type a value between 0 and 4294967295; the default setting is 30 |
type | string | False | Specifies the type of pool. DNS pools 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 |
verifyMemberAvailability | string | False | Specifies that the system verifies the availability of the pool members before sending a connection to those resources. When set to disabled, pool members that are marked down (red) by a monitor will be treated as if they were up (green). The default setting is enabled |
membersReference | reference | False | Pool members that make up this pool |
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 pool |
description | string | False | A description of the pool |
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 |
---|---|---|
alternateMode | string | The load balancing mode that the system tries if the Preferred method is unsuccessful in picking a pool |
dynamicRatio | string | Specifies, whether the system applies a dynamic ratio to the load balancing algorithms for this pool. When dynamic ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation. Checked (enabled): This setting is applicable only when the pool is assigned a dynamic load balancing method: Round Trip Times, VS Score, Completion Rate, Hops, Kilobytes/Second, VS Capacity, or Quality of Service. Unchecked (disabled): The system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. This is the default value |
enabled | boolean | Specifies whether the pool and its resources are available for load balancing. The default is Enabled |
fallbackIp | string | Specifies the IP address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select a Fallback load |
fallbackMode | string | The load balancing mode that the system tries if both the Preferred and Alternate methods are unsuccessful in picking a pool |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | The number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable |
limitMaxConnectionsStatus | string | Specifies whether a limit should be set for the number of current connections allowed for the virtual servers in the pool |
limitMaxPps | number | The maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxPpsStatus | string | |
loadBalancingMode | string | The load balancing mode that the system tries first |
manualResume | string | Specifies, whether you must manually restart a pool member that goes down |
maxAnswersReturned | number | Specifies the maximum number of available virtual servers that the system lists in a response. The default is 1. The maximum is 500 |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing |
availabilityRequirements | string | Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available |
qosHitRatio | number | Specifies the weight of the pool member for load balancing purposes. The default is 1 |
qosHops | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosKilobytesSecond | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosLcs | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosPacketRate | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosRtt | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosTopology | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsCapacity | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsScore | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
ttl | number | Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. You can type a value between 0 and 4294967295; the default setting is 30 |
type | string | Specifies the type of pool. DNS pools 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 |
verifyMemberAvailability | string | Specifies that the system verifies the availability of the pool members before sending a connection to those resources. When set to disabled, pool members that are marked down (red) by a monitor will be treated as if they were up (green). The default setting is enabled |
membersReference | reference | Pool members that make up this pool |
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 pool |
description | string | A description of the pool |
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/pool/aaaa/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
alternateMode | string | False | The load balancing mode that the system tries if the Preferred method is unsuccessful in picking a pool |
dynamicRatio | string | False | Specifies, whether the system applies a dynamic ratio to the load balancing algorithms for this pool. When dynamic ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation. Checked (enabled): This setting is applicable only when the pool is assigned a dynamic load balancing method: Round Trip Times, VS Score, Completion Rate, Hops, Kilobytes/Second, VS Capacity, or Quality of Service. Unchecked (disabled): The system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. This is the default value |
enabled | boolean | False | Specifies whether the pool and its resources are available for load balancing. The default is Enabled |
fallbackIp | string | False | Specifies the IP address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select a Fallback load |
fallbackMode | string | False | The load balancing mode that the system tries if both the Preferred and Alternate methods are unsuccessful in picking a pool |
limitMaxBps | number | False | The maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxBpsStatus | string | False | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | False | The number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable |
limitMaxConnectionsStatus | string | False | Specifies whether a limit should be set for the number of current connections allowed for the virtual servers in the pool |
limitMaxPps | number | False | The maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxPpsStatus | string | False | |
loadBalancingMode | string | False | The load balancing mode that the system tries first |
manualResume | string | False | Specifies, whether you must manually restart a pool member that goes down |
maxAnswersReturned | number | False | Specifies the maximum number of available virtual servers that the system lists in a response. The default is 1. The maximum is 500 |
healthMonitors | string | False | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing |
qosHitRatio | number | False | Specifies the weight of the pool member for load balancing purposes. The default is 1 |
qosHops | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosKilobytesSecond | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosLcs | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosPacketRate | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosRtt | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosTopology | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsCapacity | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsScore | number | False | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
ttl | number | False | Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. You can type a value between 0 and 4294967295; the default setting is 30 |
type | string | False | Specifies the type of pool. DNS pools 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 |
verifyMemberAvailability | string | False | Specifies that the system verifies the availability of the pool members before sending a connection to those resources. When set to disabled, pool members that are marked down (red) by a monitor will be treated as if they were up (green). The default setting is enabled |
membersReference | reference | False | Pool members that make up this pool |
link | string | True | URI link of the reference. |
description | string | False | A description of the pool |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
alternateMode | string | The load balancing mode that the system tries if the Preferred method is unsuccessful in picking a pool |
dynamicRatio | string | Specifies, whether the system applies a dynamic ratio to the load balancing algorithms for this pool. When dynamic ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation. Checked (enabled): This setting is applicable only when the pool is assigned a dynamic load balancing method: Round Trip Times, VS Score, Completion Rate, Hops, Kilobytes/Second, VS Capacity, or Quality of Service. Unchecked (disabled): The system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. This is the default value |
enabled | boolean | Specifies whether the pool and its resources are available for load balancing. The default is Enabled |
fallbackIp | string | Specifies the IP address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select a Fallback load |
fallbackMode | string | The load balancing mode that the system tries if both the Preferred and Alternate methods are unsuccessful in picking a pool |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | The number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable |
limitMaxConnectionsStatus | string | Specifies whether a limit should be set for the number of current connections allowed for the virtual servers in the pool |
limitMaxPps | number | The maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxPpsStatus | string | |
loadBalancingMode | string | The load balancing mode that the system tries first |
manualResume | string | Specifies, whether you must manually restart a pool member that goes down |
maxAnswersReturned | number | Specifies the maximum number of available virtual servers that the system lists in a response. The default is 1. The maximum is 500 |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing |
availabilityRequirements | string | Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available |
qosHitRatio | number | Specifies the weight of the pool member for load balancing purposes. The default is 1 |
qosHops | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosKilobytesSecond | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosLcs | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosPacketRate | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosRtt | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosTopology | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsCapacity | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsScore | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
ttl | number | Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. You can type a value between 0 and 4294967295; the default setting is 30 |
type | string | Specifies the type of pool. DNS pools 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 |
verifyMemberAvailability | string | Specifies that the system verifies the availability of the pool members before sending a connection to those resources. When set to disabled, pool members that are marked down (red) by a monitor will be treated as if they were up (green). The default setting is enabled |
membersReference | reference | Pool members that make up this pool |
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 pool |
description | string | A description of the pool |
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/pool/aaaa/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
alternateMode | string | The load balancing mode that the system tries if the Preferred method is unsuccessful in picking a pool |
dynamicRatio | string | Specifies, whether the system applies a dynamic ratio to the load balancing algorithms for this pool. When dynamic ratio is enabled, the system treats QOS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QOS calculation. Checked (enabled): This setting is applicable only when the pool is assigned a dynamic load balancing method: Round Trip Times, VS Score, Completion Rate, Hops, Kilobytes/Second, VS Capacity, or Quality of Service. Unchecked (disabled): The system uses only the server or virtual server with the best metrics, or highest quality of service (QOS) score, for load balancing. This is the default value |
enabled | boolean | Specifies whether the pool and its resources are available for load balancing. The default is Enabled |
fallbackIp | string | Specifies the IP address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select a Fallback load |
fallbackMode | string | The load balancing mode that the system tries if both the Preferred and Alternate methods are unsuccessful in picking a pool |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | The number of current connections allowed for the virtual servers in the pool. If the current connections exceed this value, the system marks the pool as unavailable |
limitMaxConnectionsStatus | string | Specifies whether a limit should be set for the number of current connections allowed for the virtual servers in the pool |
limitMaxPps | number | The maximum allowable data transfer rate, in packets per second, for the virtual servers in the pool. If the network traffic volume exceeds this value, the system marks the pool as unavailable |
limitMaxPpsStatus | string | |
loadBalancingMode | string | The load balancing mode that the system tries first |
manualResume | string | Specifies, whether you must manually restart a pool member that goes down |
maxAnswersReturned | number | Specifies the maximum number of available virtual servers that the system lists in a response. The default is 1. The maximum is 500 |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this pool for load balancing |
availabilityRequirements | string | Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available |
qosHitRatio | number | Specifies the weight of the pool member for load balancing purposes. The default is 1 |
qosHops | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosKilobytesSecond | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosLcs | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosPacketRate | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosRtt | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosTopology | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsCapacity | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
qosVsScore | number | When you select the load balancing method, Quality of Service, this option becomes available. Here, you can assign weights that determine the priority the Global Traffic Manager places on different performance metrics |
ttl | number | Specifies the number of seconds that the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again. You can type a value between 0 and 4294967295; the default setting is 30 |
type | string | Specifies the type of pool. DNS pools 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 |
verifyMemberAvailability | string | Specifies that the system verifies the availability of the pool members before sending a connection to those resources. When set to disabled, pool members that are marked down (red) by a monitor will be treated as if they were up (green). The default setting is enabled |
membersReference | reference | Pool members that make up this pool |
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 pool |
description | string | A description of the pool |
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 pool of type AAAA¶
GET /mgmt/cm/dns/working-config/pool/aaaa/<id>
Response¶
HTTP/1.1 200 OK
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"partition": No example value specified ,
"name": "pool1" ,
"description": "example pool" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Get all pools of type AAAA¶
GET /mgmt/cm/dns/working-config/pool/aaaa
Response¶
HTTP/1.1 200 OK
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"partition": No example value specified ,
"name": "pool1" ,
"description": "example pool" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Create new pool AAAA¶
POST /mgmt/cm/dns/working-config/pool/aaaa
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"partition": No example value specified ,
"name": "pool1" ,
"description": "example pool" ,
"deviceGroupReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Response¶
HTTP/1.1 200 OK
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"partition": No example value specified ,
"name": "pool1" ,
"description": "example pool" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Update pool AAAA¶
PATCH /mgmt/cm/dns/working-config/pool/aaaa/<id>
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"description": "example pool"
}
Response¶
HTTP/1.1 200 OK
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"partition": No example value specified ,
"name": "pool1" ,
"description": "example pool" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Delete AAAA pool¶
DELETE /mgmt/cm/dns/working-config/pool/aaaa/<id>
Response¶
HTTP/1.1 200 OK
{
"alternateMode": No example value specified ,
"dynamicRatio": No example value specified ,
"enabled": No example value specified ,
"fallbackIp": No example value specified ,
"fallbackMode": No example value specified ,
"limitMaxBps": No example value specified ,
"limitMaxBpsStatus": No example value specified ,
"limitMaxConnections": No example value specified ,
"limitMaxConnectionsStatus": No example value specified ,
"limitMaxPps": No example value specified ,
"limitMaxPpsStatus": No example value specified ,
"loadBalancingMode": No example value specified ,
"manualResume": No example value specified ,
"maxAnswersReturned": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"qosHitRatio": No example value specified ,
"qosHops": No example value specified ,
"qosKilobytesSecond": No example value specified ,
"qosLcs": No example value specified ,
"qosPacketRate": No example value specified ,
"qosRtt": No example value specified ,
"qosTopology": No example value specified ,
"qosVsCapacity": No example value specified ,
"qosVsScore": No example value specified ,
"ttl": No example value specified ,
"type": No example value specified ,
"verifyMemberAvailability": No example value specified ,
"membersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"partition": No example value specified ,
"name": "pool1" ,
"description": "example pool" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}