Articles in this section

vms modify

Sara Levy
  • Updated
Follow

This command modifies an object.

Usage

vms modify [--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]
           [--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 object.

Options

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

  • 1.2 (default)

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

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

vcli: admin> vms modify --id 1 --login-banner 'You are logging into VMS'

To remove a custom login banner text:

vcli: admin> vms modify --login-banner ''

To set the access token lifetime to 2 hours and the refresh token lifetime to 12 hours:

vcli: admin> vms modify --access-token-lifetime 02:00:00 --refresh-token-lifetime 12:00:00

Related articles

Comments

0 comments

Article is closed for comments.