DNS Virtual Server¶
Overview¶
This document describes the API to configure DNS virtual servers and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/server/*/virtual-servers¶
Requests¶
GET /mgmt/cm/dns/working-config/server/<id>/virtual-servers/<vs-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
address | string | Displays the IP Address of the virtual server. |
servicePort | string | Displays the service port number for the virtual server. For example, the HTTP service is typically port 80. |
explicitLinkName | string | An explicit link to assign to the virtual server. |
limitMaxBps | number | Specifies the maximum allowable data throughput rate, in bits per second, for the virtual server. |
limitMaxBpsStatus | string | Enables or Disables limit max bps |
limitMaxConnections | number | Specifies the maximum number of concurrent connections for the virtual server. |
limitMaxConnectionsStatus | string | Enables or Disables limit max connections |
limitMaxPps | number | Specifies the maximum allowable data transfer rate, in packets per second, for the virtual server. |
limitMaxPpsStatus | string | Enables or Disables limit max pps |
ltmName | string | the name of the virtual server in the LTM namespace |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this virtual server 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. All: Specifies that all of the active health monitors must be successful before the link is considered up. At Least: Specifies the minimum number of active health monitors that must be successful before the link is considered up. Require: Specifies the minimum number of probes that must succeed for this server to be declared up and the number of probers that should be used. |
translationAddress | string | Specifies the translation IP address for the virtual server. |
translationPort | string | Specifies the translation port number or service name for the virtual server. |
dependsOn | array_of_strings | Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
name | string | Specifies the name of the virtual server. |
description | string | A description of the virtual server |
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/server/<id>/virtual-servers¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
address | string | False | Displays the IP Address of the virtual server. |
servicePort | string | False | Displays the service port number for the virtual server. For example, the HTTP service is typically port 80. |
explicitLinkName | string | False | An explicit link to assign to the virtual server. |
limitMaxBps | number | False | Specifies the maximum allowable data throughput rate, in bits per second, for the virtual server. |
limitMaxBpsStatus | string | False | Enables or Disables limit max bps |
limitMaxConnections | number | False | Specifies the maximum number of concurrent connections for the virtual server. |
limitMaxConnectionsStatus | string | False | Enables or Disables limit max connections |
limitMaxPps | number | False | Specifies the maximum allowable data transfer rate, in packets per second, for the virtual server. |
limitMaxPpsStatus | string | False | Enables or Disables limit max pps |
ltmName | string | False | the name of the virtual server in the LTM namespace |
healthMonitors | string | False | Specifies the health monitors that the system uses to determine whether it can use this virtual server 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. All: Specifies that all of the active health monitors must be successful before the link is considered up. At Least: Specifies the minimum number of active health monitors that must be successful before the link is considered up. Require: Specifies the minimum number of probes that must succeed for this server to be declared up and the number of probers that should be used. |
translationAddress | string | False | Specifies the translation IP address for the virtual server. |
translationPort | string | False | Specifies the translation port number or service name for the virtual server. |
dependsOn | array_of_strings | False | Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
name | string | False | Specifies the name of the virtual server. |
description | string | False | A description of the virtual server |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
address | string | Displays the IP Address of the virtual server. |
servicePort | string | Displays the service port number for the virtual server. For example, the HTTP service is typically port 80. |
explicitLinkName | string | An explicit link to assign to the virtual server. |
limitMaxBps | number | Specifies the maximum allowable data throughput rate, in bits per second, for the virtual server. |
limitMaxBpsStatus | string | Enables or Disables limit max bps |
limitMaxConnections | number | Specifies the maximum number of concurrent connections for the virtual server. |
limitMaxConnectionsStatus | string | Enables or Disables limit max connections |
limitMaxPps | number | Specifies the maximum allowable data transfer rate, in packets per second, for the virtual server. |
limitMaxPpsStatus | string | Enables or Disables limit max pps |
ltmName | string | the name of the virtual server in the LTM namespace |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this virtual server 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. All: Specifies that all of the active health monitors must be successful before the link is considered up. At Least: Specifies the minimum number of active health monitors that must be successful before the link is considered up. Require: Specifies the minimum number of probes that must succeed for this server to be declared up and the number of probers that should be used. |
translationAddress | string | Specifies the translation IP address for the virtual server. |
translationPort | string | Specifies the translation port number or service name for the virtual server. |
dependsOn | array_of_strings | Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
name | string | Specifies the name of the virtual server. |
description | string | A description of the virtual server |
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/server/<id>/virtual-servers/<vs-id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
servicePort | string | False | Displays the service port number for the virtual server. For example, the HTTP service is typically port 80. |
limitMaxBps | number | False | Specifies the maximum allowable data throughput rate, in bits per second, for the virtual server. |
limitMaxBpsStatus | string | False | Enables or Disables limit max bps |
limitMaxConnections | number | False | Specifies the maximum number of concurrent connections for the virtual server. |
limitMaxConnectionsStatus | string | False | Enables or Disables limit max connections |
limitMaxPps | number | False | Specifies the maximum allowable data transfer rate, in packets per second, for the virtual server. |
limitMaxPpsStatus | string | False | Enables or Disables limit max pps |
ltmName | string | False | the name of the virtual server in the LTM namespace |
healthMonitors | string | False | Specifies the health monitors that the system uses to determine whether it can use this virtual server for load balancing. |
translationAddress | string | False | Specifies the translation IP address for the virtual server. |
translationPort | string | False | Specifies the translation port number or service name for the virtual server. |
dependsOn | array_of_strings | False | Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
description | string | False | A description of the virtual server |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
address | string | Displays the IP Address of the virtual server. |
servicePort | string | Displays the service port number for the virtual server. For example, the HTTP service is typically port 80. |
explicitLinkName | string | An explicit link to assign to the virtual server. |
limitMaxBps | number | Specifies the maximum allowable data throughput rate, in bits per second, for the virtual server. |
limitMaxBpsStatus | string | Enables or Disables limit max bps |
limitMaxConnections | number | Specifies the maximum number of concurrent connections for the virtual server. |
limitMaxConnectionsStatus | string | Enables or Disables limit max connections |
limitMaxPps | number | Specifies the maximum allowable data transfer rate, in packets per second, for the virtual server. |
limitMaxPpsStatus | string | Enables or Disables limit max pps |
ltmName | string | the name of the virtual server in the LTM namespace |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this virtual server 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. All: Specifies that all of the active health monitors must be successful before the link is considered up. At Least: Specifies the minimum number of active health monitors that must be successful before the link is considered up. Require: Specifies the minimum number of probes that must succeed for this server to be declared up and the number of probers that should be used. |
translationAddress | string | Specifies the translation IP address for the virtual server. |
translationPort | string | Specifies the translation port number or service name for the virtual server. |
dependsOn | array_of_strings | Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
name | string | Specifies the name of the virtual server. |
description | string | A description of the virtual server |
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/server/<id>/virtual-servers/<vs-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
address | string | Displays the IP Address of the virtual server. |
servicePort | string | Displays the service port number for the virtual server. For example, the HTTP service is typically port 80. |
explicitLinkName | string | An explicit link to assign to the virtual server. |
limitMaxBps | number | Specifies the maximum allowable data throughput rate, in bits per second, for the virtual server. |
limitMaxBpsStatus | string | Enables or Disables limit max bps |
limitMaxConnections | number | Specifies the maximum number of concurrent connections for the virtual server. |
limitMaxConnectionsStatus | string | Enables or Disables limit max connections |
limitMaxPps | number | Specifies the maximum allowable data transfer rate, in packets per second, for the virtual server. |
limitMaxPpsStatus | string | Enables or Disables limit max pps |
ltmName | string | the name of the virtual server in the LTM namespace |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this virtual server 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. All: Specifies that all of the active health monitors must be successful before the link is considered up. At Least: Specifies the minimum number of active health monitors that must be successful before the link is considered up. Require: Specifies the minimum number of probes that must succeed for this server to be declared up and the number of probers that should be used. |
translationAddress | string | Specifies the translation IP address for the virtual server. |
translationPort | string | Specifies the translation port number or service name for the virtual server. |
dependsOn | array_of_strings | Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
name | string | Specifies the name of the virtual server. |
description | string | A description of the virtual server |
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 virtual server of a given server¶
GET /mgmt/cm/dns/working-config/server/<id>/virtual-servers/<vs-id>
Response¶
HTTP/1.1 200 OK
{
"address": "1.1.1.1" ,
"servicePort": No example value specified ,
"explicitLinkName": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"name": "VS_1" ,
"description": "example virtual server"
}
Get all virtual servers of a given server¶
GET /mgmt/cm/dns/working-config/server/<id>/virtual-servers
Response¶
HTTP/1.1 200 OK
{
"address": "1.1.1.1" ,
"servicePort": No example value specified ,
"explicitLinkName": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"name": "VS_1" ,
"description": "example virtual server"
}
Create a new virtual server for a given server¶
POST /mgmt/cm/dns/working-config/server/<id>/virtual-servers
{
"address": "1.1.1.1" ,
"servicePort": No example value specified ,
"explicitLinkName": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"name": "VS_1" ,
"description": "example virtual server"
}
Response¶
HTTP/1.1 200 OK
{
"address": "1.1.1.1" ,
"servicePort": No example value specified ,
"explicitLinkName": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"name": "VS_1" ,
"description": "example virtual server"
}
Update virtual server¶
PATCH /mgmt/cm/dns/working-config/server/<id>/virtual-servers/<vs-id>
{
"servicePort": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"description": "example virtual server"
}
Response¶
HTTP/1.1 200 OK
{
"address": "1.1.1.1" ,
"servicePort": No example value specified ,
"explicitLinkName": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"name": "VS_1" ,
"description": "example virtual server"
}
Delete virtual server¶
DELETE /mgmt/cm/dns/working-config/server/<id>/virtual-servers/<vs-id>
Response¶
HTTP/1.1 200 OK
{
"address": "1.1.1.1" ,
"servicePort": No example value specified ,
"explicitLinkName": 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 ,
"ltmName": No example value specified ,
"healthMonitors": "bigip" ,
"availabilityRequirements": No example value specified ,
"translationAddress": No example value specified ,
"translationPort": No example value specified ,
"dependsOn": No example value specified ,
"name": "VS_1" ,
"description": "example virtual server"
}