DNS Region

Overview

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

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

Requests

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

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
regionMembers array_of_strings Specifies a list of types of members. 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. If the request source should not match, “not” should be placed at the beginning of the string
partition string The BIG-IP partition in which the configuration for this object is placed
name string Displays the name of the region
description string A description of the region
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/region

Request Parameters

Name Type Required Description
regionMembers array_of_strings False Specifies a list of types of members. 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. If the request source should not match, “not” should be placed at the beginning of the string
partition string False The BIG-IP partition in which the configuration for this object is placed
name string False Displays the name of the region
description string False A description of the region
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
regionMembers array_of_strings Specifies a list of types of members. 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. If the request source should not match, “not” should be placed at the beginning of the string
partition string The BIG-IP partition in which the configuration for this object is placed
name string Displays the name of the region
description string A description of the region
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/region/<id>

Request Parameters

Name Type Required Description
regionMembers array_of_strings False Specifies a list of types of members. 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. If the request source should not match, “not” should be placed at the beginning of the string
description string False A description of the region

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
regionMembers array_of_strings Specifies a list of types of members. 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. If the request source should not match, “not” should be placed at the beginning of the string
partition string The BIG-IP partition in which the configuration for this object is placed
name string Displays the name of the region
description string A description of the region
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/region/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
regionMembers array_of_strings Specifies a list of types of members. 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. If the request source should not match, “not” should be placed at the beginning of the string
partition string The BIG-IP partition in which the configuration for this object is placed
name string Displays the name of the region
description string A description of the region
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 region

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

Response

HTTP/1.1 200 OK
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "partition": No example value specified    ,
    "name": "region1"    ,
    "description": "example region"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Get all regions

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

Response

HTTP/1.1 200 OK
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "partition": No example value specified    ,
    "name": "region1"    ,
    "description": "example region"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Create new region

POST /mgmt/cm/dns/working-config/region
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "partition": No example value specified    ,
    "name": "region1"    ,
    "description": "example region"    ,
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Response

HTTP/1.1 200 OK
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "partition": No example value specified    ,
    "name": "region1"    ,
    "description": "example region"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Update region

PATCH /mgmt/cm/dns/working-config/region/<id>
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "description": "example region"
}

Response

HTTP/1.1 200 OK
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "partition": No example value specified    ,
    "name": "region1"    ,
    "description": "example region"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}

Delete region

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

Response

HTTP/1.1 200 OK
{
    "regionMembers": "not datacenter /Common/dc1"    ,
    "partition": No example value specified    ,
    "name": "region1"    ,
    "description": "example region"    ,
    "deviceGroupReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    }
}