DNS Server¶
Overview¶
This document describes the API to configure DNS servers and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/server¶
Requests¶
GET /mgmt/cm/dns/working-config/server/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
devicesReference | reference | |
link | string | URI link of the reference. |
virtualServersReference | reference | |
link | string | URI link of the reference. |
dataCenterReference | reference | |
name | string | Name of the resource |
link | string | URI link of the reference. |
datacenter | string | Specifies the data center to which the server belongs |
state | boolean | Specifies whether the system can use this server and its resources for load balancing. The default is Enabled. |
exposeRouteDomains | string | |
iqAllowPath | string | Specifies that the system verifies the logical network route between a data center server and a local DNS server. |
iqAllowServiceCheck | string | Specifies that the system verifies that an application on a server is running, by remotely running the application using an external service checker program. |
iqAllowSnmp | string | Specifies that the system checks the performance of a server running an SNMP agent. |
limitCpuUsage | number | Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
limitCpuUsageStatus | string | |
limitMaxBps | number | Specifies 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 | |
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 | |
limitMaxPps | number | Specifies 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 | |
limitMemAvail | number | Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
limitMemAvailStatus | string | |
linkDiscovery | string | Specifies that the system automatically discovers links configured on the server. The default is Disabled. disabled: Specifies that you plan to add links manually. enabled: Specifies that the system uses the discovery feature to add links. enabled-no-delete: Specifies that the system uses the discovery feature and does not delete the links that already exist |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this 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 Health Monitors: Specifies that all of the active health monitors must report success before the link is considered up |
proberPreference | string | Specifies the type of prober to use to monitor this server’s resources. The default value is Inherit From Data Center. Selecting any other setting overrides the prober preference value on this server’s data center. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. Note: Prober pools are not used by the bigip monitor |
proberFallback | string | Specifies the type of prober to use to monitor this server’s resources when the preferred prober is not available. The default value is Inherit From Data Center. any-available: Uses any available prober. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. none: Uses no failback prober |
product | string | Specifies the server type. The server type determines the metrics that the system can collect from the server. |
virtualServerDiscovery | string | Specifies whether the system auto-discovers the virtual servers for this server. The default setting is Disabled. Disabled: The system does not auto-discover the virtual servers that are configured on the server. With this setting, you must manually configure any virtual servers for this server, by adding them to the Virtual Server List. Enabled: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds, deletes, and modifies virtual server settings in the configuration. enabled-no-delete: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds and modifies virtual server settings in the configuration, but does not delete them. This option is useful when you regularly take virtual servers in and out of service |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the server |
description | string | A description of the server |
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/server¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
devicesReference | reference | False | |
link | string | True | URI link of the reference. |
virtualServersReference | reference | False | |
link | string | True | URI link of the reference. |
dataCenterReference | reference | False | |
link | string | True | URI link of the reference. |
datacenter | string | False | Specifies the data center to which the server belongs |
state | boolean | False | Specifies whether the system can use this server and its resources for load balancing. The default is Enabled. |
exposeRouteDomains | string | False | |
iqAllowPath | string | False | Specifies that the system verifies the logical network route between a data center server and a local DNS server. |
iqAllowServiceCheck | string | False | Specifies that the system verifies that an application on a server is running, by remotely running the application using an external service checker program. |
iqAllowSnmp | string | False | Specifies that the system checks the performance of a server running an SNMP agent. |
limitCpuUsage | number | False | Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
limitCpuUsageStatus | string | False | |
limitMaxBps | number | False | Specifies 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 | |
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 | |
limitMaxPps | number | False | Specifies 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 | |
limitMemAvail | number | False | Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
limitMemAvailStatus | string | False | |
linkDiscovery | string | False | Specifies that the system automatically discovers links configured on the server. The default is Disabled. disabled: Specifies that you plan to add links manually. enabled: Specifies that the system uses the discovery feature to add links. enabled-no-delete: Specifies that the system uses the discovery feature and does not delete the links that already exist |
healthMonitors | string | False | Specifies the health monitors that the system uses to determine whether it can use this 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 Health Monitors: Specifies that all of the active health monitors must report success before the link is considered up |
proberPreference | string | False | Specifies the type of prober to use to monitor this server’s resources. The default value is Inherit From Data Center. Selecting any other setting overrides the prober preference value on this server’s data center. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. Note: Prober pools are not used by the bigip monitor |
proberFallback | string | False | Specifies the type of prober to use to monitor this server’s resources when the preferred prober is not available. The default value is Inherit From Data Center. any-available: Uses any available prober. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. none: Uses no failback prober |
product | string | False | Specifies the server type. The server type determines the metrics that the system can collect from the server. |
virtualServerDiscovery | string | False | Specifies whether the system auto-discovers the virtual servers for this server. The default setting is Disabled. Disabled: The system does not auto-discover the virtual servers that are configured on the server. With this setting, you must manually configure any virtual servers for this server, by adding them to the Virtual Server List. Enabled: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds, deletes, and modifies virtual server settings in the configuration. enabled-no-delete: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds and modifies virtual server settings in the configuration, but does not delete them. This option is useful when you regularly take virtual servers in and out of service |
partition | string | False | The BIG-IP partition in which the configuration for this object is placed |
name | string | False | Displays the name of the server |
description | string | False | A description of the server |
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 |
---|---|---|
devicesReference | reference | |
link | string | URI link of the reference. |
virtualServersReference | reference | |
link | string | URI link of the reference. |
dataCenterReference | reference | |
name | string | Name of the resource |
link | string | URI link of the reference. |
datacenter | string | Specifies the data center to which the server belongs |
state | boolean | Specifies whether the system can use this server and its resources for load balancing. The default is Enabled. |
exposeRouteDomains | string | |
iqAllowPath | string | Specifies that the system verifies the logical network route between a data center server and a local DNS server. |
iqAllowServiceCheck | string | Specifies that the system verifies that an application on a server is running, by remotely running the application using an external service checker program. |
iqAllowSnmp | string | Specifies that the system checks the performance of a server running an SNMP agent. |
limitCpuUsage | number | Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
limitCpuUsageStatus | string | |
limitMaxBps | number | Specifies 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 | |
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 | |
limitMaxPps | number | Specifies 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 | |
limitMemAvail | number | Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
limitMemAvailStatus | string | |
linkDiscovery | string | Specifies that the system automatically discovers links configured on the server. The default is Disabled. disabled: Specifies that you plan to add links manually. enabled: Specifies that the system uses the discovery feature to add links. enabled-no-delete: Specifies that the system uses the discovery feature and does not delete the links that already exist |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this 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 Health Monitors: Specifies that all of the active health monitors must report success before the link is considered up |
proberPreference | string | Specifies the type of prober to use to monitor this server’s resources. The default value is Inherit From Data Center. Selecting any other setting overrides the prober preference value on this server’s data center. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. Note: Prober pools are not used by the bigip monitor |
proberFallback | string | Specifies the type of prober to use to monitor this server’s resources when the preferred prober is not available. The default value is Inherit From Data Center. any-available: Uses any available prober. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. none: Uses no failback prober |
product | string | Specifies the server type. The server type determines the metrics that the system can collect from the server. |
virtualServerDiscovery | string | Specifies whether the system auto-discovers the virtual servers for this server. The default setting is Disabled. Disabled: The system does not auto-discover the virtual servers that are configured on the server. With this setting, you must manually configure any virtual servers for this server, by adding them to the Virtual Server List. Enabled: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds, deletes, and modifies virtual server settings in the configuration. enabled-no-delete: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds and modifies virtual server settings in the configuration, but does not delete them. This option is useful when you regularly take virtual servers in and out of service |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the server |
description | string | A description of the server |
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/server/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
devicesReference | reference | False | |
link | string | True | URI link of the reference. |
virtualServersReference | reference | False | |
link | string | True | URI link of the reference. |
dataCenterReference | reference | False | |
link | string | True | URI link of the reference. |
datacenter | string | False | Specifies the data center to which the server belongs |
state | boolean | False | Specifies whether the system can use this server and its resources for load balancing. The default is Enabled. |
exposeRouteDomains | string | False | |
iqAllowPath | string | False | Specifies that the system verifies the logical network route between a data center server and a local DNS server. |
iqAllowServiceCheck | string | False | Specifies that the system verifies that an application on a server is running, by remotely running the application using an external service checker program. |
iqAllowSnmp | string | False | Specifies that the system checks the performance of a server running an SNMP agent. |
limitCpuUsage | number | False | Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
limitCpuUsageStatus | string | False | |
limitMaxBps | number | False | Specifies 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 | |
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 | |
limitMaxPps | number | False | Specifies 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 | |
limitMemAvail | number | False | Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
limitMemAvailStatus | string | False | |
linkDiscovery | string | False | Specifies that the system automatically discovers links configured on the server. The default is Disabled. disabled: Specifies that you plan to add links manually. enabled: Specifies that the system uses the discovery feature to add links. enabled-no-delete: Specifies that the system uses the discovery feature and does not delete the links that already exist |
virtualServerDiscovery | string | False | Specifies whether the system auto-discovers the virtual servers for this server. The default setting is Disabled. Disabled: The system does not auto-discover the virtual servers that are configured on the server. With this setting, you must manually configure any virtual servers for this server, by adding them to the Virtual Server List. Enabled: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds, deletes, and modifies virtual server settings in the configuration. enabled-no-delete: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds and modifies virtual server settings in the configuration, but does not delete them. This option is useful when you regularly take virtual servers in and out of service |
description | string | False | A description of the server |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
devicesReference | reference | |
link | string | URI link of the reference. |
virtualServersReference | reference | |
link | string | URI link of the reference. |
dataCenterReference | reference | |
name | string | Name of the resource |
link | string | URI link of the reference. |
datacenter | string | Specifies the data center to which the server belongs |
state | boolean | Specifies whether the system can use this server and its resources for load balancing. The default is Enabled. |
exposeRouteDomains | string | |
iqAllowPath | string | Specifies that the system verifies the logical network route between a data center server and a local DNS server. |
iqAllowServiceCheck | string | Specifies that the system verifies that an application on a server is running, by remotely running the application using an external service checker program. |
iqAllowSnmp | string | Specifies that the system checks the performance of a server running an SNMP agent. |
limitCpuUsage | number | Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
limitCpuUsageStatus | string | |
limitMaxBps | number | Specifies 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 | |
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 | |
limitMaxPps | number | Specifies 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 | |
limitMemAvail | number | Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
limitMemAvailStatus | string | |
linkDiscovery | string | Specifies that the system automatically discovers links configured on the server. The default is Disabled. disabled: Specifies that you plan to add links manually. enabled: Specifies that the system uses the discovery feature to add links. enabled-no-delete: Specifies that the system uses the discovery feature and does not delete the links that already exist |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this 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 Health Monitors: Specifies that all of the active health monitors must report success before the link is considered up |
proberPreference | string | Specifies the type of prober to use to monitor this server’s resources. The default value is Inherit From Data Center. Selecting any other setting overrides the prober preference value on this server’s data center. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. Note: Prober pools are not used by the bigip monitor |
proberFallback | string | Specifies the type of prober to use to monitor this server’s resources when the preferred prober is not available. The default value is Inherit From Data Center. any-available: Uses any available prober. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. none: Uses no failback prober |
product | string | Specifies the server type. The server type determines the metrics that the system can collect from the server. |
virtualServerDiscovery | string | Specifies whether the system auto-discovers the virtual servers for this server. The default setting is Disabled. Disabled: The system does not auto-discover the virtual servers that are configured on the server. With this setting, you must manually configure any virtual servers for this server, by adding them to the Virtual Server List. Enabled: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds, deletes, and modifies virtual server settings in the configuration. enabled-no-delete: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds and modifies virtual server settings in the configuration, but does not delete them. This option is useful when you regularly take virtual servers in and out of service |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the server |
description | string | A description of the server |
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/server/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
devicesReference | reference | |
link | string | URI link of the reference. |
virtualServersReference | reference | |
link | string | URI link of the reference. |
dataCenterReference | reference | |
name | string | Name of the resource |
link | string | URI link of the reference. |
datacenter | string | Specifies the data center to which the server belongs |
state | boolean | Specifies whether the system can use this server and its resources for load balancing. The default is Enabled. |
exposeRouteDomains | string | |
iqAllowPath | string | Specifies that the system verifies the logical network route between a data center server and a local DNS server. |
iqAllowServiceCheck | string | Specifies that the system verifies that an application on a server is running, by remotely running the application using an external service checker program. |
iqAllowSnmp | string | Specifies that the system checks the performance of a server running an SNMP agent. |
limitCpuUsage | number | Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
limitCpuUsageStatus | string | |
limitMaxBps | number | Specifies 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 | |
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 | |
limitMaxPps | number | Specifies 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 | |
limitMemAvail | number | Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
limitMemAvailStatus | string | |
linkDiscovery | string | Specifies that the system automatically discovers links configured on the server. The default is Disabled. disabled: Specifies that you plan to add links manually. enabled: Specifies that the system uses the discovery feature to add links. enabled-no-delete: Specifies that the system uses the discovery feature and does not delete the links that already exist |
healthMonitors | string | Specifies the health monitors that the system uses to determine whether it can use this 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 Health Monitors: Specifies that all of the active health monitors must report success before the link is considered up |
proberPreference | string | Specifies the type of prober to use to monitor this server’s resources. The default value is Inherit From Data Center. Selecting any other setting overrides the prober preference value on this server’s data center. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. Note: Prober pools are not used by the bigip monitor |
proberFallback | string | Specifies the type of prober to use to monitor this server’s resources when the preferred prober is not available. The default value is Inherit From Data Center. any-available: Uses any available prober. inside-data-center: Uses a prober inside the data center. outside-data-center: Uses a prober outside the data center. inherit: Uses the prober assigned to the data center. none: Uses no failback prober |
product | string | Specifies the server type. The server type determines the metrics that the system can collect from the server. |
virtualServerDiscovery | string | Specifies whether the system auto-discovers the virtual servers for this server. The default setting is Disabled. Disabled: The system does not auto-discover the virtual servers that are configured on the server. With this setting, you must manually configure any virtual servers for this server, by adding them to the Virtual Server List. Enabled: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds, deletes, and modifies virtual server settings in the configuration. enabled-no-delete: The system auto-discovers the virtual servers that are configured on the server. With this setting, the system automatically adds and modifies virtual server settings in the configuration, but does not delete them. This option is useful when you regularly take virtual servers in and out of service |
partition | string | The BIG-IP partition in which the configuration for this object is placed |
name | string | Displays the name of the server |
description | string | A description of the server |
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 server¶
GET /mgmt/cm/dns/working-config/server/<id>
Response¶
HTTP/1.1 200 OK
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"healthMonitors": No example value specified ,
"availabilityRequirements": No example value specified ,
"proberPreference": No example value specified ,
"proberFallback": No example value specified ,
"product": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"partition": No example value specified ,
"name": "server1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Get all servers¶
GET /mgmt/cm/dns/working-config/server
Response¶
HTTP/1.1 200 OK
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"healthMonitors": No example value specified ,
"availabilityRequirements": No example value specified ,
"proberPreference": No example value specified ,
"proberFallback": No example value specified ,
"product": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"partition": No example value specified ,
"name": "server1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Create a new server¶
POST /mgmt/cm/dns/working-config/server
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"healthMonitors": No example value specified ,
"availabilityRequirements": No example value specified ,
"proberPreference": No example value specified ,
"proberFallback": No example value specified ,
"product": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"partition": No example value specified ,
"name": "server1" ,
"description": "example server" ,
"deviceGroupReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Response¶
HTTP/1.1 200 OK
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"healthMonitors": No example value specified ,
"availabilityRequirements": No example value specified ,
"proberPreference": No example value specified ,
"proberFallback": No example value specified ,
"product": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"partition": No example value specified ,
"name": "server1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Update server¶
PATCH /mgmt/cm/dns/working-config/server/<id>
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"description": "example server"
}
Response¶
HTTP/1.1 200 OK
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"healthMonitors": No example value specified ,
"availabilityRequirements": No example value specified ,
"proberPreference": No example value specified ,
"proberFallback": No example value specified ,
"product": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"partition": No example value specified ,
"name": "server1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Delete server¶
DELETE /mgmt/cm/dns/working-config/server/<id>
Response¶
HTTP/1.1 200 OK
{
"devicesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"virtualServersReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"dataCenterReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"datacenter": No example value specified ,
"state": No example value specified ,
"exposeRouteDomains": No example value specified ,
"iqAllowPath": No example value specified ,
"iqAllowServiceCheck": No example value specified ,
"iqAllowSnmp": No example value specified ,
"limitCpuUsage": No example value specified ,
"limitCpuUsageStatus": 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 ,
"limitMemAvail": No example value specified ,
"limitMemAvailStatus": No example value specified ,
"linkDiscovery": No example value specified ,
"healthMonitors": No example value specified ,
"availabilityRequirements": No example value specified ,
"proberPreference": No example value specified ,
"proberFallback": No example value specified ,
"product": No example value specified ,
"virtualServerDiscovery": No example value specified ,
"partition": No example value specified ,
"name": "server1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}