tfctl profile set

The tfctl profile set command sets a profile configuration property.

Usage

$ tfctl profile set PROPERTY VALUE

Description

The tfctl profile set command sets the specified property in your active profile. A property governs the behavior of a specific aspect of the tfctl CLI, such as setting the hostname and organization to target.

To unset properties, use tfctl profile unset.

Refer to Available properties for a list of the properties that can be configured for each profile.

You cannot rename a profile using this command. Use the tfctl profile profiles rename command instead.

Arguments

PROPERTY: (Required) Property to be set, such as default_organization and hostname.
VALUE: (Required) Value to be set.

Global flags

All tfctl commands support options that control output formatting and CLI behavior. Refer to Global flags reference for the complete list of available options.

Examples

The following examples demonstrate how to set profile configuration properties.

Set the default organization

The following example sets the default organization for the active profile. Replace <ORG_NAME> with your organization name.

$ tfctl profile set default_organization <ORG_NAME>

Set a custom hostname

The following example sets a custom hostname for a Terraform Enterprise instance. Replace <HOSTNAME> with your HCP Terraform or Terraform Enterprise hostname.

$ tfctl profile set hostname <HOSTNAME>

Disable telemetry

The following example disables telemetry collection.

$ tfctl profile set telemetry disabled

Enable telemetry logging

The following example enables telemetry logging to view transmitted data.

$ tfctl profile set telemetry log