--- title: "vippool modify" slug: "vippool-modify" updated: 2026-10-27T17:24:49Z published: 2026-10-27T17:24:49Z canonical: "docs.vastdata.com/vippool-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. # vippool modify This command modifies a [virtual IP pool](/docs-5-3/docs/en/configuring-network-access).Managing Virtual IP (VIP) Pools ##### Usage ```plaintext vippool modify --id ID              [--ip-ranges IP_RANGES]              [--subnet-cidr CIDR]              [--subnet-cidr-ipw6 CIDR]              [--cnode-ids CNODE_IDs]              [--cnode-names CNODE_NAMEs]              [--gw-ip IPV4]              [--gw-ipv6 IPV6]              [--name NAME]              [--vlan VLAN]              [--vast-dns-domain-name DOMAIN_NAME]              [--role PROTOCOLS|REPLICATION]              [--vms-preferred]              [--not-vms-preferred]              [--port-membership ALL|RIGHT|LEFT]              [--tenant-id TENANT_ID]              [--serve-all-tenants]              [--enable-weighted-balancing|--disable-weighted-balancing]              [--bgp-config-id ID] ``` ##### Required Parameters | `--id ID` | Specifies the virtual IP pool to modify. | | --- | --- | ##### Options | `--ip-ranges IP_RANGES` | Lists the ranges of IPv4 or IPv6 addresses included in the virtual IP pool. Specify `IP_RANGES` as a list of IP ranges in the format *,*. Separate ranges with a space. For example, `--ip-ranges 10.10.10.2,10.10.10.4 10.10.10.8,10.10.10.24` | | --- | --- | | `--subnet-cidr CIDR` | Specifies the subnet in Classless Inter-Domain Routing (CIDR) notation for IPv4. 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.255.0 is expressed as 24 in CIDR notation. Specify `CIDR` as an integer. For example: `--subnet-cidr 24` | | `--subnet-cidr-ipv6 CIDR` | Specifies the subnet in Classless Inter-Domain Routing (CIDR) notation for IPv6. In CIDR notation, the subnet is expressed as the number of bits of each IP address that represent the subnet address. For IPv6, this is known as *IPv6 prefix length*. For example, the prefix length of /32 in 2001:db8::/32 would include IP addresses from 2001:db8:: to 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff. Specify `CIDR` as an integer. For example: `--subnet-cidr-ipv6 48` | | `--cnode-ids CNODE_IDs` | Dedicates a specific group of CNodes to the virtual IP pool. The virtual IPs in this pool will only be distributed among the specified CNodes. By default, virtual IP pools are distributed among all active CNodes. | | `--cnode-names CNODE_NAMEs` | Dedicates a group of CNodes to the virtual IP pool, specifying CNodes by name. Specify CNode names as a comma separated list. For example: `--cnode-names cnode-1,cnode-3,cnode-4` By default, virtual IP pools are distributed among all active CNodes. | | `--gw-ip IPV4` | Specifies a gateway IPv4 address. Use this option if your storage clients are on multiple subnets and you are routing your client storage traffic through a local gateway. | | `--gw-ipv6 IPV6` | Specifies a gateway IPv6 address. Use this option if your storage clients are on multiple subnets and you are routing your client storage traffic through a local gateway. | | `--name NAME` | Specifies a name for the virtual IP pool. | | `--vlan VLAN` | Tags the virtual IP pool with a specific VLAN on the data network. See [Tagging Virtual IP Pools with VLANs](/docs-5-3/docs/en/tagging-virtual-ip-pools-with-vlans). Specify `VLAN` as a VLAN number (0-4096). | | `--vast-dns-domain-name DOMAIN_NAME` | Specifies a domain name to associate with the virtual IP pool for DNS resolution by the VAST Cluster DNS server. If a domain suffix is defined in the [DNS server configuration](/docs-5-3/docs/en/configuring-the-vast-cluster-dns-service), it is appended to the domain name to form a FQDN. | | `--role PROTOCOLS\|REPLICATION` | Determines the usage of the virtual IP pool: - `PROTOCOLS`. The virtual IP pool is used to provide access to the cluster for data network clients. - `REPLICATION`. The virtual IP pool is used for native replication. | | `--vms-preferred` | Sets CNodes participating in the virtual IP pool to belong to a preferred domain for VMS failover. For more details, see [Configuring Network Access](/docs-5-3/docs/en/configuring-network-access). Configuring Network Access | | `--not-vms-preferred` | Disables `--vms-preferred`. | | `--port-membership ALL\|RIGHT\|LEFT` | Determines which port (right or left) in a group of CNodes is allocated to the virtual IP pool. For more information, see [Configuring Network Access](/docs-5-3/docs/en/configuring-network-access). By default, all ports on the pool's CNodes are included in the virtual IP pool.Configuring Network Access | | `--tenant-id TENANT_ID` | Specifies a tenant for the virtual IP pool to serve exclusively. If a tenant ID is specified, only this particular tenant is able to access the virtual IP pool. If no tenant ID is set, the pool can be accessed by any tenant. > [!NOTE] > Note > > You cannot detach a tenant from a virtual IP pool as long as there are view policies associated with that tenant. This is in order to avoid a scenario where a client using a virtual IP gets disconnected from the tenant. | | `--serve-all-tenants` | Detaches a tenant from the virtual IP pool, so that the virtual IP pool serves all tenants. > [!NOTE] > Note > > You cannot detach a tenant from a Virtual IP pool as long as there are view policies associated with that tenant. This is in order to avoid a scenario where a client using a virtual IP gets disconnected from the tenant. | | `--enable-weighted-balancing` | Applicable for combinations of CNodes of different generations. Enables automatic rebalancing of virtual IPs across CNodes according to the following ratios: - Ice Lake CNodes are allocated 50% more virtual IPs than Cascade Lake CNodes, - Cascade Lake CNodes are allocated 50% more virtual IPs than Broadwell CNodes. - Genoa and Gen5 CNodes are allocated 100% more virtual IPs than Ice lake CNodes. This feature allows you to leverage the increased CPU capacity of newer CNode generations that can handle a higher workload. | | `--disable-weighted-balancing` | Disables CNode virtual IP rebalancing. | | `--bgp-config-id ID` | Set the BGP Configuration ID to `ID` to be used for L3 networking. This must be set if L3 is enabled for the VIP Pool. > [!NOTE] > Notice > > This feature is introduced in VAST Cluster 5.3.1. | ##### Example This example changes the last IP in the pool's IP range and tags the pool with VLAN 70: ```plaintext vcli: admin> vippool modify --id 1 --vlan 70 ```