vippool modify

--id ID

Specifies the virtual IP pool to modify.

--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 <start IP>,<end IP>. 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.

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, it is appended to the domain name to form a FQDN.

--role PROTOCOLS|REPLICATION

Determines the usage of the virtual IP pool:

--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. 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.  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

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

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:

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.

Notice

This feature is introduced in VAST Cluster 5.3.1.