Skip to content

Commit a1d3359

Browse files
committed
add deleteDnsServer documentation
1 parent 459ec7d commit a1d3359

2 files changed

Lines changed: 51 additions & 2 deletions

File tree

144 KB
Loading

source/adminguide/networking/dns_framework.rst

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,55 @@ Using the API:
232232
.. note:: Updating ``nameservers`` only affects new DNS zones created through this server. Existing DNS zones and their current NS records are not modified.
233233

234234

235+
Deleting a DNS Server
236+
---------------------
237+
238+
A DNS server can be deleted from CloudStack using the UI or API.
239+
240+
By default, all DNS zones associated with the server are also deleted. To retain them, set ``cleanup`` to ``false``.
241+
242+
When cleanup is enabled, you can use ``unmanage`` to remove DNS zones only from CloudStack without deleting them in the external DNS provider.
243+
244+
From UI:
245+
246+
Quick action buttons are available in the UI to delete a DNS server.
247+
248+
.. image:: /_static/images/delete_dns_server.png
249+
:width: 400px
250+
:align: center
251+
:alt: Delete DNS Server in CloudStack UI
252+
253+
.. raw:: html
254+
255+
<br>
256+
257+
Using the API:
258+
259+
.. code:: bash
260+
261+
cmk delete dnsserver id=<dns-server-id> cleanup=true unmanage=false
262+
263+
264+
**Parameters**
265+
266+
.. list-table::
267+
:widths: 20 15 65
268+
:header-rows: 1
269+
270+
* - Name
271+
- Required
272+
- Description
273+
* - ``id``
274+
- Yes
275+
- The ID of the DNS server
276+
* - ``cleanup``
277+
- No
278+
- If false, DNS zones associated with this server will not be deleted. **Default**: ``true``
279+
* - ``unmanage``
280+
- No
281+
- Applicable only when ``cleanup: true``. If set to true, associated DNS zones are removed only from CloudStack and not from the external DNS provider. **Default**: ``false``
282+
283+
235284
DNS Zone Management
236285
^^^^^^^^^^^^^^^^^^^
237286

@@ -278,7 +327,7 @@ Using the API:
278327
- The description of the DNS zone
279328
* - ``existing``
280329
- No
281-
- If true, imports an existing DNS zone from the external DNS provider into CloudStack; if false, creates a new DNS zone in both CloudStack and the DNS provider. **Default**: ``false``
330+
- If true, imports an existing DNS zone from the external DNS provider into CloudStack; if false, creates the zone in the DNS provider and registers it in CloudStack. **Default**: ``false``
282331

283332

284333
Listing DNS Zones
@@ -342,7 +391,7 @@ Using the API:
342391
- The ID of the DNS zone
343392
* - ``unmanage``
344393
- No
345-
- If false, removes it from both CloudStack and the DNS provider, if true, removes the DNS zone only from CloudStack. **Default**: ``false``
394+
- If true, removes the DNS zone only from CloudStack (unmanaged); if false, removes it from CloudStack and deletes it from the DNS provider. **Default**: ``false``
346395

347396

348397
.. note:: Deleting a DNS zone will also delete all DNS records within that zone.

0 commit comments

Comments
 (0)