callhomeconfig modify

Prev Next

This command modifies the call home configuration. The call home feature sends non-sensitive information to VAST support to provide proactive analysis and fast response on critical issues.

Usage

callhomeconfig modify --id ID
                     [--enable]
                     [--disable]
                     [--bundle-interval INTERVAL]
                     [--log-interval INTERVAL]
                     [--luna-on-alarm-interval INTERVAL]
                     [--luna-analyze-period INTERVAL]
                     [--customer CUSTOMER_NAME]
                     [--site SITE_NAME]
                     [--location LOCATION]
                     [--proxy-scheme PROXY_SCHEME]
                     [--proxy-host PROXY_HOST]
                     [--proxy-port PROXY_PORT]
                     [--proxy-username PROXY_USER]
                     [--proxy-password PROXY_PWD]
                     [--test-mode]
                     [--prod-mode]
                     [--verify-ssl-enable]
                     [--verify-ssl-disable]
                     [--support-channel-enable]
                     [--support-channel-disable]
                     [--max-upload-concurrency MAX_UPLOAD_CONCURRENCY]
                     [--max-upload-bandwidth MAX_UPLOAD_BW]
                     [--cloud-enable]
                     [--cloud-disable]
                     [--cloud-api-key CLOUD_API_KEY ]
                     [--cloud-api-domain CLOUD_DOMAIN]
                     [--cloud-subdomain CLOUD_SUBDOMAIN]
                     [--aws-s3-bucket-subdir ]
                     [--aws-s3-ak S3_ACCESS_KEY]
                     [--aws-s3-sk S3_SECRET_KEY]
                     [--aws-s3-bucket-name S3_BUCKET]
                     [--compress-method COMPRESS_METHOD ]
                     [--obfuscated-enable]
                     [--obfuscated-disable]
                     [--upload-via-vms-enable]
                     [--upload-via-vms-disable] 
                     [--alt_s3_host_port PORT]   

Options

--id ID

The call home configuration to modify. This is assumed to be 1.

--enable

When enabled, VAST Cluster sends logs to the support server.

--disable

Disables the call home configuration.

--bundle-interval INTERVAL

The interval (in minutes) to send VMS metadata and metrics to the support server. If disabled, no VMS metadata and metrics is not sent.

--log-interval INTERVAL

The interval (in minutes) to send system state data to the support server. If disabled, no system state data is sent.

--luna-on-alarm-interval INTERVAL

The interval (in hours) to send Luna results to the support server. If disabled, no Luna data is sent.

Specify INTERVAL in hours.

--luna-analyze-period INTERVAL

Sets the period for Luna analysis.

Specify INTERNAL in hours.

--customer CUSTOMER_NAME

Your customer name.

Specify CUSTOMER_NAME as a string

--site SITE_NAME

The name of the site where the cluster is installed.

Specify SITE_NAME as a string

--location LOCATION

The location of the site.

Specify LOCATION as a string

--proxy-scheme PROXY_SCHEME

Specifies the proxy scheme. Relevant only if a proxy host is used.

Specify PROXY_SCHEME as a string

--proxy-host PROXY_HOST

Specifies the proxy host. Relevant only if a proxy host is used.

Specify PROXY_HOST as a string

--proxy-port PROXY_PORT

Specifies the proxy port. Relevant only if a proxy host is used.

Specify PROXY_PORT as an integer

--proxy-username PROXY_USER

Specifies the proxy username. Relevant only if a proxy host is used.

Specify PROXY_USER as a string

--proxy-password PROXY_PWD

Specifies the proxy password. Relevant only if a proxy host is used.

Specify PROXY_PASSWD as a string

--test-mode

Enables test mode. This is only used by VAST Support personnel, for testing.

--prod-mode

Sets the production support server as the destination for call home bundles. For normal use, this should be enabled.

--verify-ssl-enable

Enables SSL verification. Disable if, for example, you are sending the call home data through a proxy server that does not have an SSL certificate recognized by VAST Cluster. VAST Cluster recognizes SSL certificates from a large range of widely recognized certificate authorities (CAs). VAST Cluster may not recognize an SSL certificate signed by your own in-house CA.

--verify-ssl-disable

Disables SSL verification.

--support-channel-enable

Enables the support channel.

--support-channel-disable

Disables the support channel.

--max-upload-concurrency MAX_UPLOAD_CONCURRENCY

Sets the maximum number of concurrent threads.

Specify MAX_UPLOAD_CONCURRENCY as an integer

--max-upload-bandwidth MAX_UPLOAD_BW

Sets the maximum upload bandwidth (in bytes/sec)

Specify MAX_UPLOAD_BW as an integer

--cloud-enable

Enables reporting call home data to VAST Cloud Call Home service

--cloud-disable

Disables reporting to VAST Cloud services

--cloud-api-key CLOUD_API_KEY

Overrides the Cloud services API key.

Specify CLOUD_API_KEY as a string

--cloud-api-domain CLOUD_API_DOMAIN

Overrides the Cloud services API domain name

Specify CLOUD_API_DOMAIN as a string

--cloud-subdomain CLOUD_SUBDOMAIN

Specifies the unique subdomain for the customer in the VAST Cloud call home service.

Specify CLOUD_SUBDOMAIN as a string

--aws-s3-bucket-subdir

Specifies the S3 bucket prefix for the bundle upload.

--aws-s3-ak S3_ACCESS_KEY

Sets the S3 access key to upload the bundle to an S3 bucket.

Note

When configuring call home, leave this field empty. This setting is used for support bundle uploads.

Specify S3_ACCESS_KEY as a string

--aws-s3-sk S3_SECRET_KEY

Sets the S3 secret key to upload the bundle to an S3 bucket.

Specify S3_SECRET_KEY as a string

--aws-s3-bucket-name S3_BUCKET

Specifies the name of the S3 bucket to which to upload the bundle.

Specify S3_BUCKET as a valid S3 bucket name (string)

--compress-method COMPRESS_METHOD

Sets the compression method used to compress call home bundles:

  • zstd (default)

  • gzip

Specify COMPRESS_METHOD as a string

--obfuscated-enable

Enables obfuscation of data in call home bundles, metrics and heartbeats. These details are replaced with a non-reversible hash: file and directory names, IP addresses, host names, user names, passwords, MAC addresses.

--obfuscated-disable

Disables data obfuscation.

--upload-via-vms-enable

Uploads a call home bundle via VMS. Otherwise, the upload is done from each node.

--upload-via-vms-disable

Disables upload via VMS.

--alt_s3_host_port HOST_PORT    

Specifies an alternate S3 endpoint on a VAST Cluster.

Use this as an alternative to the VAST Cloud Call Home Service (so, --cloud-disable is asserted). If used, use also --aws-s3-ak and --aws-s3-sk to indicate the access keys to the S3 bucket on the VAST Cluster.

Specify HOST_PORT as a string in the form host:port

Notice

This option is available from VAST Cluster 5.1.2

Example

This example configures call home to the VAST Cloud Call Home service

vcli: admin> callhomeconfig modify --id 1 --cloud-enable --prod-mode  

This must be followed by

vcli: admin> callhomeconfig register-cluster --id 1 --email myemail@mydomain.com

This example configures call home to an alternate S3 bucket on a VAST Cluster (and disables access to the Cloud Call Home service).

vcli: admin> callhomeconfig modify --id 1 --cloud-disable --prod-mode --alt_s3_host_port myhost:myport --aws-s3-ak < S3_ACCESS_KEY> --aws-s3-sk <S3_SECRET_KEY>