---
title: "vippool allocate"
slug: "vippool-allocate"
tags: ["5.4"]
updated: 2026-10-28T01:53:01Z
published: 2026-10-28T01:53:01Z
canonical: "docs.vastdata.com/vippool-allocate"
---

> ## 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 allocate

# vippool allocate

This command allocates Virtual IP (VIP) addresses from a cloud environment to a VIP pool.

## Usage

```plaintext
vippool allocate --ips-count COUNT
                [--cluster-id CLUSTER_ID]
                [--cnode-ids CNODE_IDs]
                [--cnode-names CNODE_NAMEs]
                [--name NAME]
                [--vast-dns-domain-name DOMAIN_NAME]
                [--role PROTOCOLS|REPLICATION]
                [--vms-preferred | --not-vms-preferred]
                [--enable | --disable]
                [--tenant-id TENANT_ID | --serve-all-tenants]
                [--enable-weighted-balancing | --disable-weighted-balancing]
```

## Required Parameters

| `--ips-count COUNT` | Specify the number of VIP addresses to allocate from the cloud provider. |
| --- | --- |

## Options

| `--cluster-id CLUSTER_ID` | Specify the cluster ID. |
| --- | --- |
| `--cnode-ids CNODE_IDs` | Dedicates a group of CNodes to the VIP pool. Specify CNode IDs as a comma-separated list. |
| `--cnode-names CNODE_NAMEs` | Dedicates a group of CNodes to the VIP pool. Specify CNode names as a comma-separated list. |
| `--name NAME` | Specifies a name for the VIP pool. |
| `--vast-dns-domain-name DOMAIN_NAME` | Specifies the domain name for the VAST Cluster DNS server. |
| `--role PROTOCOLS\|REPLICATION` | Specify `PROTOCOLS` for a protocol access VIP pool or `REPLICATION` for native replication. |
| `--vms-preferred` | Sets CNodes participating in the VIP pool to be preferred VMS hosts. |
| `--not-vms-preferred` | Disables the vms-preferred setting. |
| `--enable` | Enables the VIP pool. |
| `--disable` | Disables the VIP pool. |
| `--tenant-id TENANT_ID` | Tenant ID. If set, only the tenant with this ID can access the VIP pool. If not set, the VIP pool is accessible to all tenants. |
| `--serve-all-tenants` | Specify to detach tenant from the VIP pool, enabling the VIP pool to serve all tenants. |
| `--enable-weighted-balancing` | Enable weighted balancing. |
| `--disable-weighted-balancing` | Disable weighted balancing. |

## Example

This example shows how to allocate 10 cloud VIPs to a new VIP pool named pool1:

```plaintext
vcli: admin> vippool allocate --ips-count 10 --name pool1
```