DNS Pool Member NAPR

Overview

This document describes the API to configure DNS NAPTR pool members and their properties.

REST Endpoint: /mgmt/cm/dns/working-config/pool/naptr/*/members

Requests

GET /mgmt/cm/dns/working-config/pool/naptr/<id>/members/<pool-member-id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
enabled boolean Specifies whether the system can include the pool member in its load balancing calculations
flags string Specifies the response resource record’s flags RDATA field value when this member is picked. Supported record types are a and s
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
order number Specifies the response resource record’s order RDATA field value when this member is picked. The default is 10
pref number Specifies the response resource record’s preference RDATA field value when this member is picked. The default is 10
ratio number Specifies the weight of the pool member for load balancing purposes. The default is 1
service string Specifies the response resource record’s service RDATA field value when this member is picked
wideIpAReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpAaaaReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpSrvReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
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/naptr/<id>/members

Request Parameters

Name Type Required Description
enabled boolean False Specifies whether the system can include the pool member in its load balancing calculations
flags string False Specifies the response resource record’s flags RDATA field value when this member is picked. Supported record types are a and s
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
order number False Specifies the response resource record’s order RDATA field value when this member is picked. The default is 10
pref number False Specifies the response resource record’s preference RDATA field value when this member is picked. The default is 10
ratio number False Specifies the weight of the pool member for load balancing purposes. The default is 1
service string False Specifies the response resource record’s service RDATA field value when this member is picked
wideIpAReference reference False A reference of the Wide IP for the pool member to use
     link string True URI link of the reference.
wideIpAaaaReference reference False A reference of the Wide IP for the pool member to use
     link string True URI link of the reference.
wideIpSrvReference reference False A reference of the Wide IP for the pool member to use
     link string True URI link of the reference.
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
enabled boolean Specifies whether the system can include the pool member in its load balancing calculations
flags string Specifies the response resource record’s flags RDATA field value when this member is picked. Supported record types are a and s
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
order number Specifies the response resource record’s order RDATA field value when this member is picked. The default is 10
pref number Specifies the response resource record’s preference RDATA field value when this member is picked. The default is 10
ratio number Specifies the weight of the pool member for load balancing purposes. The default is 1
service string Specifies the response resource record’s service RDATA field value when this member is picked
wideIpAReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpAaaaReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpSrvReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
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/naptr/<id>/members/<pool-member-id>

Request Parameters

Name Type Required Description
enabled boolean False Specifies whether the system can include the pool member in its load balancing calculations
flags string False Specifies the response resource record’s flags RDATA field value when this member is picked. Supported record types are a and s
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
order number False Specifies the response resource record’s order RDATA field value when this member is picked. The default is 10
pref number False Specifies the response resource record’s preference RDATA field value when this member is picked. The default is 10
ratio number False Specifies the weight of the pool member for load balancing purposes. The default is 1
service string False Specifies the response resource record’s service RDATA field value when this member is picked
wideIpAReference reference False A reference of the Wide IP for the pool member to use
     link string True URI link of the reference.
wideIpAaaaReference reference False A reference of the Wide IP for the pool member to use
     link string True URI link of the reference.
wideIpSrvReference reference False A reference of the Wide IP for the pool member to use
     link string True URI link of the reference.
description string False A description of the pool member

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
enabled boolean Specifies whether the system can include the pool member in its load balancing calculations
flags string Specifies the response resource record’s flags RDATA field value when this member is picked. Supported record types are a and s
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
order number Specifies the response resource record’s order RDATA field value when this member is picked. The default is 10
pref number Specifies the response resource record’s preference RDATA field value when this member is picked. The default is 10
ratio number Specifies the weight of the pool member for load balancing purposes. The default is 1
service string Specifies the response resource record’s service RDATA field value when this member is picked
wideIpAReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpAaaaReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpSrvReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
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/naptr/<id>/members/<pool-member-id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
enabled boolean Specifies whether the system can include the pool member in its load balancing calculations
flags string Specifies the response resource record’s flags RDATA field value when this member is picked. Supported record types are a and s
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
order number Specifies the response resource record’s order RDATA field value when this member is picked. The default is 10
pref number Specifies the response resource record’s preference RDATA field value when this member is picked. The default is 10
ratio number Specifies the weight of the pool member for load balancing purposes. The default is 1
service string Specifies the response resource record’s service RDATA field value when this member is picked
wideIpAReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpAaaaReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
wideIpSrvReference reference A reference of the Wide IP for the pool member to use
     name string Name of the resource
     link string URI link of the reference.
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 NAPTR pool

GET /mgmt/cm/dns/working-config/pool/naptr/<id>/members/<pool-member-id>

Response

HTTP/1.1 200 OK
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "pool_member_1"    ,
    "description": "example pool member"
}

Get all pool members of a given NAPTR pool

GET /mgmt/cm/dns/working-config/pool/naptr/<id>/members

Response

HTTP/1.1 200 OK
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "pool_member_1"    ,
    "description": "example pool member"
}

Create a new pool member for a given NAPTR pool

POST /mgmt/cm/dns/working-config/pool/naptr/<id>/members
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "pool_member_1"    ,
    "description": "example pool member"
}

Response

HTTP/1.1 200 OK
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "pool_member_1"    ,
    "description": "example pool member"
}

Update pool member for a given NAPTR pool

PATCH /mgmt/cm/dns/working-config/pool/naptr/<id>/members/<pool-member-id>
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "description": "example pool member"
}

Response

HTTP/1.1 200 OK
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "pool_member_1"    ,
    "description": "example pool member"
}

Delete NAPTR pool member

DELETE /mgmt/cm/dns/working-config/pool/naptr/<id>

Response

HTTP/1.1 200 OK
{
    "enabled": No example value specified    ,
    "flags": "a"    ,
    "memberOrder": No example value specified    ,
    "order": No example value specified    ,
    "pref": No example value specified    ,
    "ratio": No example value specified    ,
    "service": No example value specified    ,
    "wideIpAReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpAaaaReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "wideIpSrvReference": {
        "name": "resourceName"    ,
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "pool_member_1"    ,
    "description": "example pool member"
}