---
title: "dns modify"
slug: "dns-modify"
tags: ["5.5"]
updated: 2026-10-27T23:00:54Z
published: 2026-10-27T23:00:54Z
canonical: "docs.vastdata.com/dns-modify"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# dns modify

This command modifies a [VAST DNS service](/docs-5-5/docs/configuring-the-vast-cluster-dns-service) configuration.

## Usage

```plaintext
dns modify [--id ID] 
           [--name NAME]
           [--ip IP]
           [--enable|--disable]           
           [--domain-suffix DOMAIN_SUFFIX]
           [--subnet-cidr CIDR]
           [--gateway GATEWAY_IP]        
           [--ipv6 IPv6]
           [--ipv6-gateway IPv6_GATEWAY]
           [--ipv6-subnet-cidr IPv6_CIDR]
           [--cnode-ids IDs]
           [--vlan VLAN]
           [--net-type NORTH_PORT|SOUTH_PORT|EXTERNAL_PORTNET-TYPE]
           [--ttl TTL]
           [--enable-l3]
           [--bgp-config-id ID]
```

## General Options

| `--id ID` | The ID of the DNS service. |
| --- | --- |
| `--enable\|--disable` | The DNS service is disabled by default. Include the `--enable` option to enable the service when you create it. |
| `--domain-suffix DOMAIN_SUFFIX` | Specifies a suffix to append to domain names of each VIP pool. The suffix should complete each domain name to form a valid FQDN for DNS requests to target. For example, if you have two VIP pools *pool1* and *pool2*, you can set the domain name *domain1* on pool1 and domain name *domain2* on pool2 and the domain suffix to *.vastdata.ourcorp.com*. Requests for *domain1.vastdata.ourcorp.com* will be distributed among the VIPs in pool1 while requests for *domain2.vastdata.ourcorp.com* will be distributed among the VIPs in pool2. |
| `--name NAME` | Specifies a name for the DNS service configuration. |
| `--ip IP` | Assigns an IP address to the DNS service. DNS requests from your external DNS server must be delegated to this IP. |
| `--subnet-cidr CIDR` | Specifies the IP subnet, in CIDR format, on which the DNS service IP address resides. In CIDR notation, the subnet is expressed as the number of bits of each IP address that represent the subnet address. For example, the subnet mask 255.255.0.0 is expressed as *16* in CIDR notation. Specify only the trailing CIDR decimal number that indicates the subnet mask. For example, if the DNS service IP is *192.0.2.3* and the CIDR subnet is *24*, specify *24*. |
| `--gateway GATEWAY_IP` | If the external DNS server doesn't reside on the same subnet as the DNS service IP address, include this option to specify the IP address of a gateway through which to connect to the DNS server. The gateway IP address must be on same subnet as the DNS service IP address. |
| `--ipv6 IPv6` | An IPv6 address for the DNS service. |
| `--ipv6-gateway IPv6_GATEWAY` | The IPv6 address of the gateway for the DNS service. |
| `--ipv6-subnet-cidr IPv6_CIDR` | A subnet mask for the DNS service IPv6 address. |
| `--vlan VLAN` | Specifies a VLAN. If your external DNS server is only exposed to a specific VLAN, include this option and specify the DNS server's VLAN to enable communication with the DNS service. |
| `--net-type NORTH_PORT\|SOUTH_PORT\|EXTERNAL_PORTNET-TYPE` | Specifies which interface listens for DNS service delegation requests: - `EXTERNAL_PORT` (default). The on-board server management interface. - `NORTH_PORT`. The client-facing network interface. - `SOUTH_PORT`. The internal network interface. |
| `--ttl TTL` | The TTL for the port specified in `--net-port`. |

## L3 Access Options

| `--enable-l3` | Enables L3 BGP for the DNS. This is required if L3 BGP networking is used to route communications between CNodes and the customer L3 switch. If enabled, `--bgp-config-id` must also be set. |
| --- | --- |
| `--bgp-config-id ID` | Sets the BGP configuration ID to be used for L3 networking. This must be set if L3 is enabled for the DNS (`--enable-l3` is set). |

## Example

To enable a DNS service:

```plaintext
vcli: admin> dns modify --enable
```