DNS Topology

Overview

This document describes the API to configure DNS topologies and their properties.

REST Endpoint: /mgmt/cm/dns/working-config/topology

Requests

GET /mgmt/cm/dns/working-config/topology/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
order number The ldns part specifies the origination of an incoming DNS request: subnet: Type an IP address and network mask in the CIDR format (for example, 192.168.15.1/24), region: Specifies a region already defined in the configuration. continent: Specifies one of the seven continents, along with the Unknown setting. Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. country: Specifies a country. state: Specifies a state. isp: Specifies an Internet service provider (for example, AOL (America Online), Comcast, and so on). geoip-isp: Specifies a geolocation ISP. The server part specifies where the system directs the incoming DNS request and it has two more options: pool and datacenter. If the ldns part and/or the server part should not match, “not” should be placed at the beginning of each part
score number Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score
name string Displays the name of the topology
description string A description of the topology
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/topology

Request Parameters

Name Type Required Description
order number False The ldns part specifies the origination of an incoming DNS request: subnet: Type an IP address and network mask in the CIDR format (for example, 192.168.15.1/24), region: Specifies a region already defined in the configuration. continent: Specifies one of the seven continents, along with the Unknown setting. Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. country: Specifies a country. state: Specifies a state. isp: Specifies an Internet service provider (for example, AOL (America Online), Comcast, and so on). geoip-isp: Specifies a geolocation ISP. The server part specifies where the system directs the incoming DNS request and it has two more options: pool and datacenter. If the ldns part and/or the server part should not match, “not” should be placed at the beginning of each part
score number False Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score
name string False Displays the name of the topology
description string False A description of the topology
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
order number The ldns part specifies the origination of an incoming DNS request: subnet: Type an IP address and network mask in the CIDR format (for example, 192.168.15.1/24), region: Specifies a region already defined in the configuration. continent: Specifies one of the seven continents, along with the Unknown setting. Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. country: Specifies a country. state: Specifies a state. isp: Specifies an Internet service provider (for example, AOL (America Online), Comcast, and so on). geoip-isp: Specifies a geolocation ISP. The server part specifies where the system directs the incoming DNS request and it has two more options: pool and datacenter. If the ldns part and/or the server part should not match, “not” should be placed at the beginning of each part
score number Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score
name string Displays the name of the topology
description string A description of the topology
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/topology/<id>

Request Parameters

Name Type Required Description
order number False The ldns part specifies the origination of an incoming DNS request: subnet: Type an IP address and network mask in the CIDR format (for example, 192.168.15.1/24), region: Specifies a region already defined in the configuration. continent: Specifies one of the seven continents, along with the Unknown setting. Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. country: Specifies a country. state: Specifies a state. isp: Specifies an Internet service provider (for example, AOL (America Online), Comcast, and so on). geoip-isp: Specifies a geolocation ISP. The server part specifies where the system directs the incoming DNS request and it has two more options: pool and datacenter. If the ldns part and/or the server part should not match, “not” should be placed at the beginning of each part
score number False Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score
description string False A description of the topology

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
order number The ldns part specifies the origination of an incoming DNS request: subnet: Type an IP address and network mask in the CIDR format (for example, 192.168.15.1/24), region: Specifies a region already defined in the configuration. continent: Specifies one of the seven continents, along with the Unknown setting. Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. country: Specifies a country. state: Specifies a state. isp: Specifies an Internet service provider (for example, AOL (America Online), Comcast, and so on). geoip-isp: Specifies a geolocation ISP. The server part specifies where the system directs the incoming DNS request and it has two more options: pool and datacenter. If the ldns part and/or the server part should not match, “not” should be placed at the beginning of each part
score number Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score
name string Displays the name of the topology
description string A description of the topology
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/topology/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
order number The ldns part specifies the origination of an incoming DNS request: subnet: Type an IP address and network mask in the CIDR format (for example, 192.168.15.1/24), region: Specifies a region already defined in the configuration. continent: Specifies one of the seven continents, along with the Unknown setting. Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. country: Specifies a country. state: Specifies a state. isp: Specifies an Internet service provider (for example, AOL (America Online), Comcast, and so on). geoip-isp: Specifies a geolocation ISP. The server part specifies where the system directs the incoming DNS request and it has two more options: pool and datacenter. If the ldns part and/or the server part should not match, “not” should be placed at the beginning of each part
score number Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score
name string Displays the name of the topology
description string A description of the topology
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 topology

GET /mgmt/cm/dns/working-config/topology/<id>

Response

HTTP/1.1 200 OK
{
    "order": No example value specified    ,
    "score": 1    ,
    "name": "topology1"    ,
    "description": "example topology"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Get all topologys

GET /mgmt/cm/dns/working-config/topology

Response

HTTP/1.1 200 OK
{
    "order": No example value specified    ,
    "score": 1    ,
    "name": "topology1"    ,
    "description": "example topology"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Create new topology

POST /mgmt/cm/dns/working-config/topology
{
    "order": No example value specified    ,
    "score": 1    ,
    "name": "topology1"    ,
    "description": "example topology"    ,
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Response

HTTP/1.1 200 OK
{
    "order": No example value specified    ,
    "score": 1    ,
    "name": "topology1"    ,
    "description": "example topology"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Update topology

PATCH /mgmt/cm/dns/working-config/topology/<id>
{
    "order": No example value specified    ,
    "score": 1    ,
    "description": "example topology"
}

Response

HTTP/1.1 200 OK
{
    "order": No example value specified    ,
    "score": 1    ,
    "name": "topology1"    ,
    "description": "example topology"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Delete topology

DELETE /mgmt/cm/dns/working-config/topology/<id>

Response

HTTP/1.1 200 OK
{
    "order": No example value specified    ,
    "score": 1    ,
    "name": "topology1"    ,
    "description": "example topology"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}