--- title: "vms modify" slug: "vms-modify" tags: ["5.4"] updated: 2026-10-28T01:53:11Z published: 2026-10-28T01:53:11Z canonical: "docs.vastdata.com/vms-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. # vms modify This command modifies VMS settings. ## Usage ```plaintext vms modify [--delete-mgmt-data-vip ]           [--mgmt-data-vip MGMT_DATA_VIP]           [--mgmt-data-interface MGMT_DATA_INTERFACE]           [--mgmt-data-netmask NETMASK]           [--mgmt-data-vip-gateway MGMT_DATA_GATEWAY]           [--mgmt-data-vip-vlan MGMT_DATA_VLAN]           [--mgmt-data-vip-ipv6 MGMT_DATA_VIP_IPv6]           [--mgmt-data-vip-prefix-ipv6 PREFIX_IPv6 ]           [--mgmt-data-vip-gateway-ipv6 GATEWAY_IPv6]           [--mgmt-vip MGMT_VIP]           [--mgmt-inner-vip MGMT_INNER_VIP]           [--min-tls-version MIN_TLS_VERSION]           [--access-token-lifetime ACCESS_TOKEN_LIFETIME]           [--refresh-token-lifetime REFRESH_TOKEN_LIFETIME]           [--enable-vms-metrics]           [--disable-vms-metrics]           [--performance-base-10]           [--performance-base-2]           [--capacity-base-10]           [--capacity-base-2]           [--login-banner LOGIN_BANNER]           [--min-pwd-length LENGTH]           [--preferred-cnode-ids PREFERRED_CNODE_IDS]           [--enable-vms-perf-debug-metrics]           [--disable-vms-perf-debug-metrics]         ``` ## Required Parameters | `--id ID` | Specifies the ID of the VMS resource. | | --- | --- | ## Options | `--delete-mgmt-data-vip` | If there is a management virtual IP configured on the data network, this option removes the IP. | | --- | --- | | `--mgmt-data-vip MGMT_DATA_VIP` | Configures a data network management VIP in IPv4 format. This is an optional management virtual IP address on the data subnet, configured on the data management interfaces of all CNodes. VAST Management Service (VMS) listens on this IP. You can configure either an IPv4 address with this option or an IPv6 address with the `--mgmt-data-vip-ipv6` option. When specifying `--mgmt-data-vip` you must also specify `--mgmt-data-netmask`. Specify `MGMT_DATA_VIP` as an IPv4 address. | | `--mgmt-data-interface MGMT_DATA_INTERFACE` | Specifies the management interface on each CNode on which to configure a data network management IP. For example: `--mgmt-data-interface bond0` | | `--mgmt-data-netmask NETMASK` | Specifies the netmask for an IPv4 data network management VIP. This option is required when setting `--mgmt-data-vip`. | | `--mgmt-data-vip-gateway MGMT_DATA_GATEWAY` | Specifies a gateway for an IPv4 data network management VIP. | | `--mgmt-data-vip-vlan MGMT_DATA_VLAN` | Tags the data network management interface (if there is one) with the specified VLAN. | | `--mgmt-data-vip-ipv6 MGMT_DATA_VIP_IPv6` | Configures a data network management VIP in IPv6 format. This is an optional management virtual IP address on the data subnet, configured on the data management interfaces of all CNodes. VAST Management Service (VMS) listens on this IP. You can configure either an IPv6 address with this option or an IPv4 address with the `--mgmt-data-vip` option. When specifying `--mgmt-data-vip-ipv6` you must also specify `--mgmt-data-vip-prefix-ipv6`. Specify `MGMT_DATA_VIP_IPv6` as an IPv6 address. | | `--mgmt-data-vip-prefix-ipv6 PREFIX_IPv6` | Specifies the IPv6 prefix for the IPv6 data network management VIP, if there is one. For example: `--mgmt-data-vip-prefix-ipv6 64` | | `--mgmt-data-vip-gateway-ipv6 GATEWAY_IPv6` | The IPv6 address of the gateway for the IPv6 data network management VIP, if there is one. For example: `--mgmt-data-vip-gateway-ipv6 2001:0db8:85a3:0000:0000:8a2e:0370:7334` | | `--mgmt-vip MGMT_VIP` | Changes the IP address configured on the management interfaces on all CNodes. VAST Management Service (VMS) listens on this IP. The IP should be on the management subnet. | | `--mgmt-inner-vip MGMT_INNER_VIP` | Changes the management inner VIP, a virtual IP on the cluster's internal network used for mounting the VMS database. | | `--min-tls-version MIN_TLS_VERSION` | Sets minimum supported version of TLS for HTTPS connection to VMS. Possible values: - 1.2 (default) - 1.3 | | `--access-token-lifetime ACCESS_TOKEN_LIFETIME` | Changes the VMS session access token timeout. See also `--refresh-token-lifetime`. When a user logs in to the VMS GUI, two session tokens are issued: an access token and a refresh token. The access token is a digitally encoded signature used to authenticate the user and authorize access. Access tokens are designed to have a minimal lifetime, to ensure minimum time for a user's identity to be exploited. The refresh token must have a longer lifetime than the access token. It is used to request a new access token on behalf of the user before the access token expires, without bothering the user for login credentials. When the refresh token expires, the user is logged out. Default: 1 hour Example: `--access-token-lifetime 02:00:00` | | `--refresh-token-lifetime REFRESH_TOKEN_LIFETIME` | Changes the VMS session refresh token timeout. See also `--access-token-lifetime`. When a user logs in to the VMS GUI, two session tokens are issued: an access token and a refresh token. The access token is a digitally encoded signature used to authenticate the user and authorize access. Access tokens are designed to have a minimal lifetime, to ensure minimum time for a user's identity to be exploited. The refresh token must have a longer lifetime than the access token. It is used to request a new access token on behalf of the user before the access token expires, without bothering the user for login credentials. When the refresh token expires, the user is logged out. Default: 1 day Example: `--refresh-token-lifetime 12:00:00` | | `--enable-vms-metrics` | Enables VMS metrics collection. | | `-disable-vms-metrics` | Disables VMS metrics collection. | | `--performance-base-10` | Set units of measurement for performance metrics, displayed on the VAST Web UI dashboard and in VMS analytics reports to base10 units (default setting). Base10 units have the prefixes M, G, T, and so on, representing powers of 10. In base10, 1 TB refers to 1000 GB, which refers to 1000 MB, and so on. | | `--performance-base-2` | Set units of measurement for performance metrics, displayed on the VAST Web UI dashboard and in VMS analytics reports to base2 units instead of the default base10 units. Base2 units have the prefixes TiB, GiB, MiB, and so on, in which 1 TiB = 1024 GiB, 1 GiB = 1024 MiB, and so on. | | `--capacity-base-10` | Set units of measurement for capacity metrics, displayed on the VAST Web UI dashboard and in VMS analytics reports to base10 units (default setting). Base10 units have the prefixes M, G, T, and so on, representing powers of 10. In base10, 1 TB refers to 1000 GB, which refers to 1000 MB, and so on. | | `--capacity-base-2` | Set units of measurement for capacity metrics, displayed on the VAST Web UI dashboard and in VMS analytics reports to base2 units instead of the default base10 units. Base2 units have the prefixes TiB, GiB, MiB, and so on, in which 1 TiB = 1024 GiB, 1 GiB = 1024 MiB, and so on. | | `--login-banner LOGIN_BANNER` | Sets a custom login banner or removes a custom login banner. To set a custom login banner, specify a string and enter it in single quotes. Multiple lines are not supported when specifying the banner text via the VAST CLI. However, there is no limit on the line length and the words wrap from one line to the next when displayed. To remove a custom login banner, specify an empty string in single quotes. | | `--preferred-cnode-ids PREFERRED_CNODE_IDS` | Specifies VMS preferred CNodes IDs. | | `--min-pwd-length LENGTH` | Sets the minimum required password length. Specify `LENGTH` as a number of characters. Default: 8 | | `--enable-vms-perf-debug-metrics` | Enables VMS performance debug metrics. | | `--disable-vms-perf-debug-metrics` | Disables VMS performance debug metrics. | ## Examples To specify custom login banner text: ```plaintext vcli: admin> vms modify --id 1 --login-banner 'You are logging into VMS'         ``` To remove a custom login banner text: ```plaintext vcli: admin> vms modify --login-banner '' ``` To set the access token lifetime to 2 hours and the refresh token lifetime to 12 hours: ```plaintext vcli: admin> vms modify --access-token-lifetime 02:00:00 --refresh-token-lifetime 12:00:00         ``` To set a management VIP on the data network: ```plaintext vcli: admin> vms modify --mgmt-data-interface bond0 --mgmt-data-vip 1.1.1.1 --mgmt-data-netmask 255.255.0.0 ```