tfctl profile profiles rename

The tfctl profile profiles rename command renames an existing profile.

Usage

$ tfctl profile profiles rename NAME --new_name=NEW_NAME [options]

Description

The tfctl profile profiles rename command renames an existing profile without modifying existing configuration or settings. Only the profile name changes.

Arguments

NAME: (Required) The current name of the profile to rename.

Flags

--new_name=NAME: Specifies the new name of the profile. Cannot already exist and must follow the Profile naming rules.
- Required.
- Data type: string
- Default value: None

Options

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 rename an existing profile.

Rename a profile

The following example renames a profile. Replace <OLD_NAME> and <NEW_NAME> with the old and new names of the profile.

$ tfctl profile profiles rename <OLD_NAME> --new_name=<NEW_NAME>