DNS Pool Member AAAA¶
Overview¶
This document describes the API to configure DNS AAAA pool members and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/pool/aaaa/*/members¶
Requests¶
GET /mgmt/cm/dns/working-config/pool/aaaa/<id>/members/<pool-member-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
serverReference | reference | The server that hosts the virtual server that this pool member represents |
name | string | Name of the resource |
link | string | URI link of the reference. |
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server 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 on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxPpsStatus | string | |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
healthMonitors | string | Specifies whether any health monitors are assigned to the pool member and, if so, how those monitors are assigned |
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 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
dependsOn | array_of_strings | Specifies the virtual servers on which the availability of the current pool member depends |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
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/<id>/members¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
serverReference | reference | False | The server that hosts the virtual server that this pool member represents |
link | string | True | URI link of the reference. |
enabled | boolean | False | Specifies whether the system can include the pool member in its load balancing calculations |
limitMaxBps | number | False | The maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server 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 | Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server 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 on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxPpsStatus | string | False | |
memberOrder | number | False | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
healthMonitors | string | False | Specifies whether any health monitors are assigned to the pool member and, if so, how those monitors are assigned |
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 |
ratio | number | False | Specifies the weight to the pool member for load balancing purposes |
dependsOn | array_of_strings | False | Specifies the virtual servers on which the availability of the current pool member depends |
name | string | False | Displays the name of the pool |
description | string | False | A description of the pool member |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
serverReference | reference | The server that hosts the virtual server that this pool member represents |
name | string | Name of the resource |
link | string | URI link of the reference. |
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server 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 on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxPpsStatus | string | |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
healthMonitors | string | Specifies whether any health monitors are assigned to the pool member and, if so, how those monitors are assigned |
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 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
dependsOn | array_of_strings | Specifies the virtual servers on which the availability of the current pool member depends |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
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>/members/<pool-member-id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
serverReference | reference | False | The server that hosts the virtual server that this pool member represents |
link | string | True | URI link of the reference. |
enabled | boolean | False | Specifies whether the system can include the pool member in its load balancing calculations |
limitMaxBps | number | False | The maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server 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 | Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server 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 on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxPpsStatus | string | False | |
memberOrder | number | False | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
healthMonitors | string | False | Specifies whether any health monitors are assigned to the pool member and, if so, how those monitors are assigned |
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 |
ratio | number | False | Specifies the weight to the pool member for load balancing purposes |
dependsOn | array_of_strings | False | Specifies the virtual servers on which the availability of the current pool member depends |
description | string | False | A description of the pool member |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
serverReference | reference | The server that hosts the virtual server that this pool member represents |
name | string | Name of the resource |
link | string | URI link of the reference. |
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server 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 on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxPpsStatus | string | |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
healthMonitors | string | Specifies whether any health monitors are assigned to the pool member and, if so, how those monitors are assigned |
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 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
dependsOn | array_of_strings | Specifies the virtual servers on which the availability of the current pool member depends |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
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>/members/<pool-member-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
serverReference | reference | The server that hosts the virtual server that this pool member represents |
name | string | Name of the resource |
link | string | URI link of the reference. |
enabled | boolean | Specifies whether the system can include the pool member in its load balancing calculations |
limitMaxBps | number | The maximum allowable data throughput rate, in bits per second, for the virtual servers on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxBpsStatus | string | Specifies whether a limit should be set for the maximum allowable data throughput rate, in bits per second |
limitMaxConnections | number | Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server 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 on the server. If the network traffic volume exceeds this limit, the system marks the server as unavailable |
limitMaxPpsStatus | string | |
memberOrder | number | Specifies the order number of the pool member. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method |
healthMonitors | string | Specifies whether any health monitors are assigned to the pool member and, if so, how those monitors are assigned |
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 |
ratio | number | Specifies the weight to the pool member for load balancing purposes |
dependsOn | array_of_strings | Specifies the virtual servers on which the availability of the current pool member depends |
name | string | Displays the name of the pool |
description | string | A description of the pool member |
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 member of a given AAAA pool¶
GET /mgmt/cm/dns/working-config/pool/aaaa/<id>/members/<pool-member-id>
Response¶
HTTP/1.1 200 OK
{
"serverReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member"
}
Get all pool members of a given AAAA pool¶
GET /mgmt/cm/dns/working-config/pool/aaaa/<id>/members
Response¶
HTTP/1.1 200 OK
{
"serverReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member"
}
Create a new pool member for a given AAAA pool¶
POST /mgmt/cm/dns/working-config/pool/aaaa/<id>/members
{
"serverReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member"
}
Response¶
HTTP/1.1 200 OK
{
"serverReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member"
}
Update pool member for a given AAAA pool¶
PATCH /mgmt/cm/dns/working-config/pool/aaaa/<id>/members/<pool-member-id>
{
"serverReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"description": "example pool member"
}
Response¶
HTTP/1.1 200 OK
{
"serverReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member"
}
Delete AAAA pool member¶
DELETE /mgmt/cm/dns/working-config/pool/aaaa/<id>
Response¶
HTTP/1.1 200 OK
{
"serverReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enabled": 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 ,
"memberOrder": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"ratio": No example value specified ,
"dependsOn": No example value specified ,
"name": "pool_member_1" ,
"description": "example pool member"
}