DNS Server Device¶
Overview¶
This document describes the API to configure DNS server devices and their properties.
REST Endpoint: /mgmt/cm/dns/working-config/server/*/devices¶
Requests¶
GET /mgmt/cm/dns/working-config/server/<id>/devices/<server-device-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
addresses | array_of_objects | The addresses belonging to the server device. |
address | string | Specifies an external (public) address for the server device. |
translation | string | Specifies the internal (private) address that corresponds to the external address. |
explicitLinkName | string | Specifies the explicit link to assign to the server device. |
name | string | Displays the name of the device. The device name must be unique per server. |
description | string | A description of the server device |
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>/devices¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
addresses | array_of_objects | False | The addresses belonging to the server device. |
address | string | False | Specifies an external (public) address for the server device. |
translation | string | False | Specifies the internal (private) address that corresponds to the external address. |
explicitLinkName | string | False | Specifies the explicit link to assign to the server device. |
name | string | False | Displays the name of the device. The device name must be unique per server. |
description | string | False | A description of the server device |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
addresses | array_of_objects | The addresses belonging to the server device. |
address | string | Specifies an external (public) address for the server device. |
translation | string | Specifies the internal (private) address that corresponds to the external address. |
explicitLinkName | string | Specifies the explicit link to assign to the server device. |
name | string | Displays the name of the device. The device name must be unique per server. |
description | string | A description of the server device |
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>/devices/<server-device-id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
addresses | array_of_objects | False | The addresses belonging to the server device. |
address | string | False | Specifies an external (public) address for the server device. |
translation | string | False | Specifies the internal (private) address that corresponds to the external address. |
description | string | False | A description of the server device |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
addresses | array_of_objects | The addresses belonging to the server device. |
address | string | Specifies an external (public) address for the server device. |
translation | string | Specifies the internal (private) address that corresponds to the external address. |
explicitLinkName | string | Specifies the explicit link to assign to the server device. |
name | string | Displays the name of the device. The device name must be unique per server. |
description | string | A description of the server device |
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>/devices/<server-device-id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
addresses | array_of_objects | The addresses belonging to the server device. |
address | string | Specifies an external (public) address for the server device. |
translation | string | Specifies the internal (private) address that corresponds to the external address. |
explicitLinkName | string | Specifies the explicit link to assign to the server device. |
name | string | Displays the name of the device. The device name must be unique per server. |
description | string | A description of the server device |
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 device¶
GET /mgmt/cm/dns/working-config/server/<id>/devices/<server-device-id>
Response¶
HTTP/1.1 200 OK
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
"explicitLinkName": No example value specified
}],
"name": No example value specified ,
"description": "example server device"
}
Get all server devices of a certain server¶
GET /mgmt/cm/dns/working-config/server/<id>/devices
Response¶
HTTP/1.1 200 OK
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
"explicitLinkName": No example value specified
}],
"name": No example value specified ,
"description": "example server device"
}
Create a server device¶
POST /mgmt/cm/dns/working-config/server/<id>/devices
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
"explicitLinkName": No example value specified
}],
"name": No example value specified ,
"description": "example server device"
}
Response¶
HTTP/1.1 200 OK
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
"explicitLinkName": No example value specified
}],
"name": No example value specified ,
"description": "example server device"
}
Update server device¶
PATCH /mgmt/cm/dns/working-config/server/<id>/devices/<server-device-id>
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
}],
"description": "example server device"
}
Response¶
HTTP/1.1 200 OK
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
"explicitLinkName": No example value specified
}],
"name": No example value specified ,
"description": "example server device"
}
Delete server device¶
DELETE /mgmt/cm/dns/working-config/server/<id>/devices/<server-device-id>
Response¶
HTTP/1.1 200 OK
{
"addresses": [{
"address": No example value specified ,
"translation": No example value specified ,
"explicitLinkName": No example value specified
}],
"name": No example value specified ,
"description": "example server device"
}