This site will be decommissioned on December 31st 2024. After that date content will be available at techdocs.broadcom.com.

tanzu telemetry

Manages the status of VMware’s Customer Experience Improvement Program (CEIP) for the Tanzu CLI, standalone management clusters, and workload clusters.

Usage

CLI plugin: telemetry | Plugin version: v1.1.0 | Target: global

Syntax:

tanzu telemetry [COMMAND]

Global Flags

-h, --help

Help text.

tanzu telemetry cli-usage-analytics

Manages CEIP participation for the Tanzu CLI. When CEIP is activated, your CLI usage data is pushed to VMware servers. It is also written to ~/.config/tanzu-cli-telemetry/cli_metrics.db.

Available commands:

tanzu telemetry cli-usage-analytics collect

Collects your local CLI usage data from the specified SQLite database file.

Usage

tanzu telemetry cli-usage-analytics collect [FLAGS]

Example

To collect your local CLI usage data from the default location, ~/.config/tanzu-cli-telemetry/cli_metrics.db:

tanzu telemetry cli-usage-analytics collect --source="~/.config/tanzu-cli-telemetry/cli_metrics.db"

Flags

-h, --help

Help text.

-q, --quiet

Deactivates logging for the command.

-s, --source

The location of the SQLite file from which you want to collect your local CLI usage data. To retrieve the file location, you can use tanzu telemetry cli-usage-analytics status. The default location is ~/.config/tanzu-cli-telemetry/cli_metrics.db.

-t, --timeout

The timeout value, in seconds, for the command.

tanzu telemetry cli-usage-analytics status

Prints the current CEIP participation status for the Tanzu CLI.

Usage

tanzu telemetry cli-usage-analytics status [FLAGS]

Example

To print the current CEIP status:

tanzu telemetry cli-usage-analytics status

Flags

-h, --help

Help text.

tanzu telemetry cli-usage-analytics update

Activates and deactivates CEIP participation for the Tanzu CLI.

Usage

tanzu telemetry cli-usage-analytics update [FLAGS]

Examples

To activate CEIP participation:

tanzu telemetry cli-usage-analytics update --opt-in

To deactivate CEIP participation:

tanzu telemetry cli-usage-analytics update --opt-out

To set your environment identifiers:

tanzu telemetry cli-usage-analytics update --csp-org-id "example-organization" --entitlement-account-number "MY-EAN"

Flags

--csp-org-id

The CSP org ID that you want to use for your local CLI usage data.

--entitlement-account-number

The entitlement account number that you want to use for your local CLI usage data.

-h, --help

Help text.

--opt-in

Activates CEIP participation and local data usage collection.

--opt-out

Deactivates CEIP participation and local data usage collection.

tanzu telemetry metadata

Manages CEIP metadata for the target cluster.

Available commands:

When these commands are used for Tanzu Kubernetes Grid with a standalone management cluster, run them against the management cluster. For more information, see Manage Participation in CEIP.

tanzu telemetry metadata status

Prints the current CEIP metadata for the target cluster.

Usage

tanzu telemetry metadata status [FLAGS]

Example

To print the current CEIP metadata:

tanzu telemetry metadata status

Flags

-h, --help

Help text.

tanzu telemetry metadata update

Updates CEIP metadata for the target cluster.

Usage

tanzu telemetry metadata update [FLAGS]

Examples

To set the environment type to prod:

tanzu telemetry metadata update --env-is-prod "true"

To update the CSP org ID:

tanzu telemetry metadata update --csp-org-id "1234"

Flags

--csp-org-id

Sets a cluster-wide CSP org ID. Empty string is equivalent to unsetting this value.

--entitlement-account-number

Sets a cluster-wide entitlement account number. Empty string is equivalent to unsetting this value.

--env-is-prod

Sets a cluster-wide value denoting whether the target is a production cluster or not. Supported values are true and false.

-h, --help

Help text.

tanzu telemetry participation

Manages CEIP participation for the target cluster.

Available commands:

When these commands are used for Tanzu Kubernetes Grid with a standalone management cluster, run them against the management cluster. For more information, see Manage Participation in CEIP.

tanzu telemetry participation status

Prints the current CEIP status for the target cluster.

Usage

tanzu telemetry participation status [FLAGS]

Example

To get the current CEIP status:

tanzu telemetry participation status

Flags

-h, --help

Help text.

tanzu telemetry participation update

Activates and deactivates CEIP participation.

Usage

tanzu telemetry participation update [FLAGS]

Examples

To activate CEIP participation for a cluster:

tanzu telemetry participation update --CEIP-opt-in

To deactivate CEIP participation for a cluster:

tanzu telemetry participation update --CEIP-opt-out

Flags

--CEIP-opt-in

Activates CEIP participation.

--CEIP-opt-out

Deactivates CEIP participation.

-h, --help

Help text.

check-circle-line exclamation-circle-line close-line
Scroll to top icon