You can use the gkeadm command-line interface for a variety of tasks, including the following:

  • Create a template for an admin workstation configuration file.
  • Create an admin workstation.
  • Upgrade an admin workstation.
  • Roll back an admin workstation to a previous version.
  • Restore an admin workstation from a backup.
  • Delete an admin workstation.

Basic commands

To list all commands:

gkeadm help

To get help for a specific command:

gkeadm COMMAND --help

For information on downloading gkeadm, see Downloads.

Default logging behavior for gkeadm

For gkeadm it's sufficient to use the default logging setting. For gkeadm, the default log file is logs/gkeadm-$(date).log in the local directory where you run gkeadm.

The default -v5 verbosity level covers all the log entries needed by the support team. The log file includes the command executed and the failure message.

We recommend that you send the log file to the support team when you need help.

Specifying a non-default locations for log files

To specify a non-default location for the gkeadm log file, use the --log_file flag.