vippool modify

Prev Next

This command modifies a virtual IP pool.Managing Virtual IP (VIP) Pools

Usage
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|VAST_CATALOG]
               [--vms-preferred]
               [--not-vms-preferred]
               [--port-membership ALL|RIGHT|LEFT]
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 <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|VAST_CATALOG

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.

  • VAST_CATALOG.  The virtual IP pool is dedicated to VAST Catalog. If a virtual IP pool with this role exists, the virtual IPs in this pool are used for VAST Catalog queries run from the VAST Web UI. This pool is not required but creating a pool of this role can improve performance when running VAST Catalog queries.

--vms-preferred

Sets CNodes participating in the virtual IP pool to belong to a preferred domain for VMS failover.  For more details, see VMS Hosting Impact and Preferences.

--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 CNode Port Affinity. By default, all ports on the pool's CNodes are included in the virtual IP pool.

Example

This example changes the last IP in the pool's IP range and tags the pool with VLAN 70:

vcli: admin> vippool modify --id 1 --vlan 70