Automate CLI (HA)

Chef Automate CLI Commands

chef-automate

A helpful utility to deploy and manage Chef Automate. Docs: https://docs.chef.io/automate/cli_chef_automate/ Patents: https://www.chef.io/patents

Usage

chef-automate COMMAND [flags]

Flags

Flags	Description
-d, --debug	Enable debug output (default: false)
-h, --help	help for chef-automate (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate airgap
chef-automate applications	Manage applications observability features
chef-automate backup	Chef Automate backup
chef-automate cert	Chef Automate Certificate Management
chef-automate cert-rotate	Chef Automate rotate cert
chef-automate config	Chef Automate configuration
chef-automate deploy	Deploy Chef Automate
chef-automate external-cert	Manage Chef Automate's external certificate
chef-automate gather-logs	Gather system diagnostics and logs
chef-automate iam	Chef Automate iam commands
chef-automate info	Info about Automate HA
chef-automate infrastructure	Chef Automate infrastructure
chef-automate init-config	Initialize default config
chef-automate init-config-ha	Initialize default config for Automate HA
chef-automate internal-ca	Manage Chef Automate's internal certificate authority
chef-automate license	Chef Automate license management
chef-automate maintenance	Put Chef Automate into or out of maintenance mode
chef-automate migrate-from-v1	Migrate from Chef Automate v1
chef-automate migrate-from-v1-status	Watch the status of the migration to Chef Automate 2
chef-automate node	This command is used to add or delete HA nodes
chef-automate post-major-upgrade	Utilities for post-major-upgrade
chef-automate preflight-check	Perform preflight check
chef-automate provision-infra	Provision Automate HA infra.
chef-automate restart-services	restart deployment services
chef-automate secrets	Set secrets to Automate HA
chef-automate service-versions	Retrieve the versions of the individual Chef Automate services
chef-automate ssh	SSH into Automate HA servers
chef-automate start	Start Chef Automate
chef-automate status	Retrieve Chef Automate status
chef-automate stop	Stop deployment
chef-automate system-logs	Tail Chef Automate logs
chef-automate test	Run Automate HA smoke tests
chef-automate uninstall	Uninstall Chef Automate
chef-automate upgrade	upgrade automate to the latest version
chef-automate version	Show CLI version
chef-automate workspace	Set workspace env for Automate HA.

chef-automate airgap

Usage

chef-automate airgap COMMAND [flags]

Flags

Flags	Description
-h, --help	help for airgap (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
airgap bundle

chef-automate airgap bundle

Usage

chef-automate airgap bundle COMMAND [flags]

Flags

Flags	Description
-h, --help	help for bundle (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
airgap
airgap bundle create
airgap bundle info

chef-automate airgap bundle create

Usage

chef-automate airgap bundle create [/path/to/bundle.aib] [flags]

Flags

Flags	Description
-c, --channel	Release channel to pull packages from
-h, --help	help for create (default: false)
-m, --manifest	Path to a release manifest.json
-r, --retries	Number of times to retry failed hab package downloads (default: 2)
--retry-delay	Number of seconds to wait between retries (exponential backoff is used if not provided) (default: -1)
--version	Chef Automate version to create an airgap bundle for
-w, --workspace	Path to workspace storage location where temporary data will be stored
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
airgap bundle

chef-automate airgap bundle info

Usage

chef-automate airgap bundle info /path/to/bundle.aib [flags]

Flags

Flags	Description
-h, --help	help for info (default: false)
--verbose	Output full AIB metadata (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
airgap bundle

chef-automate applications

Usage

chef-automate applications COMMAND [flags]

Flags

Flags	Description
-h, --help	help for applications (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Automate

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
applications remove-svcs	Remove services from the applications database
applications show-svcs	Show services in the applications database

chef-automate applications remove-svcs

Remove services from the applications database. You must fully decommission services by retiring physical hardware, terminating the VM or container, or by using 'hab svc unload', before using the 'remove-svcs' command. Services that are incompletely decommissioned will send a health-check at the appointed time and Automate will re-add them to the services database.

Usage

chef-automate applications remove-svcs [flags]

Flags

Flags	Description
--all	Delete all services in the database. This flag must be given if no other filter is given. (default: false)
-a, --application	Select only services where the application name matches the given pattern
-b, --buildstamp	Select only services where the buildstamp matches the given pattern
-c, --channel	Select only services where the subscribed channel matches the given pattern
-D, --disconnected	Select only services that are disconnected (default: false)
-e, --environment	Select only services where the application environment matches the given pattern
-g, --group	Select only services where the group name (suffix) matches the given pattern
-h, --help	help for remove-svcs (default: false)
-o, --origin	Select only services where the origin matches the given pattern
-n, --service-name	Select only services where the name matches the given pattern
-s, --site	Select only services where the site matches the given pattern
-v, --version	Select only services where the package version matches the given pattern
-y, --yes	Delete the services without a confirmation prompt (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Automate

Related Commands

Commands	Description
applications	Manage applications observability features

chef-automate applications show-svcs

Display a list of the habitat services stored in the applications database.

Usage

chef-automate applications show-svcs [flags]

Flags

Flags	Description
-a, --application	Select only services where the application name matches the given pattern
-b, --buildstamp	Select only services where the buildstamp matches the given pattern
-c, --channel	Select only services where the subscribed channel matches the given pattern
-D, --disconnected	Select only services that are disconnected (default: false)
-e, --environment	Select only services where the application environment matches the given pattern
-g, --group	Select only services where the group name (suffix) matches the given pattern
-h, --help	help for show-svcs (default: false)
-o, --origin	Select only services where the origin matches the given pattern
-n, --service-name	Select only services where the name matches the given pattern
-s, --site	Select only services where the site matches the given pattern
-v, --version	Select only services where the package version matches the given pattern
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Automate

Related Commands

Commands	Description
applications	Manage applications observability features

chef-automate backup

Usage

chef-automate backup COMMAND [flags]

Flags

Flags	Description
--gcs-credentials-path	The path to the GCP service account json file
-h, --help	help for backup (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
backup cancel	cancel the running backup operation
backup create	create a backup of Chef Automate
backup delete	delete backups of Chef Automate
backup fix-repo-permissions	Ensure the hab user has the required permissions on the given path
backup integrity	Chef Automate shared object integrity
backup list	list all Chef Automate backups
backup restore	restore a Chef Automate backup
backup show	show the Chef Automate backup details
backup status	show the Chef Automate backup runner status
backup stream-status	Stream the Chef Automate backup runner status

chef-automate backup cancel

Cancel the currently running backup create, delete, or restore operation

Usage

chef-automate backup cancel [flags]

Flags

Flags	Description
-h, --help	help for cancel (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup create

Create a backup of Chef Automate

Usage

chef-automate backup create [flags]

Flags

Flags	Description
-h, --help	help for create (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 43200)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup delete

Delete one or many backups of Chef Automate that match the space separated strings of backup IDs

Usage

chef-automate backup delete ID [ID2 IDN...] [flags]

Flags

Flags	Description
-h, --help	help for delete (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 43200)
--yes	Agree to all prompts (default: false)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup fix-repo-permissions

Ensure the hab user has the required permissions on the given path

Usage

chef-automate backup fix-repo-permissions PATH [flags]

Flags

Flags	Description
-h, --help	help for fix-repo-permissions (default: false)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup integrity

Usage

chef-automate backup integrity COMMAND [flags]

Flags

Flags	Description
-h, --help	help for integrity (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup
backup integrity show	show the shared object integrity metadata
backup integrity validate	validate the shared object integrity

chef-automate backup integrity show

Show the shared object integrity metadata

Usage

chef-automate backup integrity show [flags]

Flags

Flags	Description
-h, --help	help for show (default: false)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)

Supported On

Bastion

Related Commands

Commands	Description
backup integrity	Chef Automate shared object integrity

chef-automate backup integrity validate

Validate the shared object integrity. If one or more snapshot IDs is not given all snapshots will be validated

Usage

chef-automate backup integrity validate [ID IDN] [flags]

Flags

Flags	Description
-h, --help	help for validate (default: false)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)

Supported On

Bastion

Related Commands

Commands	Description
backup integrity	Chef Automate shared object integrity

chef-automate backup list

List all Chef Automate backups

Usage

chef-automate backup list [flags]

Flags

Flags	Description
-h, --help	help for list (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup restore

Restore a Chef Automate backup. If no ID or path is given the latest found backup will be restored.

Usage

chef-automate backup restore [ID_OR_PATH] [flags]

Flags

Flags	Description
--airgap-bundle	The artifact to use for an air-gapped installation
-b, --backup-dir	Directory used for backups (default: /var/opt/chef-automate/backups)
-h, --help	help for restore (default: false)
--patch-config	Path to patch config if required
--sha256	The SHA256 checksum of the backup
--skip-preflight	Skip preflight checks when restoring a backup (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 43200)
--yes	Agree to all prompts (default: false)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup show

Show the details of a Chef Automate backup

Usage

chef-automate backup show ID [flags]

Flags

Flags	Description
-h, --help	help for show (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup status

Show the Chef Automate backup runner status

Usage

chef-automate backup status [flags]

Flags

Flags	Description
-h, --help	help for status (default: false)
-t, --wait-timeout	How long to wait for a operation to complete before raising an error (default: 60)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Bastion

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate backup stream-status

Stream the Chef Automate backup runner status

Usage

chef-automate backup stream-status [flags]

Flags

Flags	Description
-h, --help	help for stream-status (default: false)
-d, --debug	Enable debug output (default: false)
--gcs-credentials-path	The path to the GCP service account json file
--no-check-version	Disable version check (default: false)
-r, --request-timeout	API request timeout for deployment-service in seconds (default: 20)
--result-json	Write command result as JSON to PATH
--s3-access-key	The S3 access key ID
--s3-endpoint	The S3 region endpoint URL
--s3-secret-key	The S3 secret access key
--s3-session-token	The S3 session token when assuming an IAM role

Supported On

Automate

Related Commands

Commands	Description
backup	Chef Automate backup

chef-automate cert

Chef Automate certificate management, this command should always be executed from AutomateHA Bastion Node.

Usage

chef-automate cert COMMAND [flags]

Flags

Flags	Description
-h, --help	help for cert (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
cert show	Chef Automate Certificates Show

chef-automate cert-rotate

Chef Automate CLI command to rotate certificates, this command should always be executed from AutomateHA Bastion Node

Usage

chef-automate cert-rotate [flags]

Flags

Flags	Description
--a2	Automate Certificate Rotation (default: false)
--admin-cert	Admin certificate
--admin-key	Admin Private certificate
-a, --automate	Automate Certificate Rotation (default: false)
-c, --chef_server	Chef Infra Server Certificate Rotation (default: false)
--cs	Chef Infra Server Certificate Rotation (default: false)
-h, --help	help for cert-rotate (default: false)
--node	Node Ip address
-o, --opensearch	OS Certificate Rotation (default: false)
--os	OS Certificate Rotation (default: false)
--pg	Postgres Certificate Rotation (default: false)
-p, --postgresql	Postgres Certificate Rotation (default: false)
--private-cert	Private certificate
--public-cert	Public certificate
--root-ca	RootCA certificate
--wait-timeout	This flag sets the operation timeout duration (in seconds) for each individual node during the certificate rotation process (default: 180)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate cert show

Chef Automate CLI command to show all certificates on HA cluster, this command should always be executed from AutomateHA Bastion Node

Usage

chef-automate cert show [flags]

Flags

Flags	Description
--a2	Show Automate Certificates (default: false)
-a, --automate	Show Automate Certificates (default: false)
-c, --chef_server	Show Chef Server Certificates (default: false)
--cs	Show Chef Server Certificates (default: false)
-h, --help	help for show (default: false)
-n, --node	Service cluster's node IP address to show certificates, if not provided then all nodes certificates will be shown
-o, --opensearch	Show Opensearch Certificates (default: false)
--os	Show Opensearch Certificates (default: false)
--pg	Show Postgres Certificates (default: false)
-p, --postgresql	Show Postgres Certificates (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
cert	Chef Automate Certificate Management

chef-automate config

Usage

chef-automate config COMMAND [flags]

Flags

Flags	Description
-y, --auto-approve	Do not prompt for confirmation; accept defaults and continue (default: false)
-h, --help	help for config (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
config patch	patch the Chef Automate configuration
config set	set the Chef Automate configuration
config show	show the Chef Automate configuration

chef-automate config patch

Apply a partial Chef Automate configuration to the deployment. It will take the partial configuration, merge it with the existing configuration, and apply and required changes.

Usage

chef-automate config patch path/to/config.toml [flags]

Flags

Flags	Description
--a2	Patch toml configuration to the automate node[DUPLICATE] (default: false)
-a, --automate	Patch toml configuration to the automate node (default: false)
-c, --chef_server	Patch toml configuration to the chef_server node (default: false)
--cs	Patch toml configuration to the chef_server node[DUPLICATE] (default: false)
--fe	Patch toml configuration to the all frontend nodes[DUPLICATE] (default: false)
-f, --frontend	Patch toml configuration to the all frontend nodes (default: false)
-h, --help	help for patch (default: false)
-o, --opensearch	Patch toml configuration to the opensearch node (default: false)
--os	Patch toml configuration to the opensearch node[DUPLICATE] (default: false)
--pg	Patch toml configuration to the postgresql node[DUPLICATE] (default: false)
-p, --postgresql	Patch toml configuration to the postgresql node (default: false)
--wait-timeout	This flag sets the operation timeout duration (in seconds) for each individual node during the config patch process (default: 180)
-y, --auto-approve	Do not prompt for confirmation; accept defaults and continue (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
config	Chef Automate configuration

chef-automate config set

Set the Chef Automate configuration for the deployment. It will replace the Chef Automate configuration with the given configuration and apply any required changes.

Usage

chef-automate config set path/to/config.toml [flags]

Flags

Flags	Description
--a2	Set toml configuration to the automate node[DUPLICATE] (default: false)
-a, --automate	Set toml configuration to the automate node (default: false)
-c, --chef_server	Set toml configuration to the chef_server node (default: false)
--cs	Set toml configuration to the chef_server node[DUPLICATE] (default: false)
-h, --help	help for set (default: false)
-o, --opensearch	Set toml configuration to the opensearch node (default: false)
--os	Set toml configuration to the opensearch node[DUPLICATE] (default: false)
--pg	Set toml configuration to the postgresql node[DUPLICATE] (default: false)
-p, --postgresql	Set toml configuration to the postgresql node (default: false)
-y, --auto-approve	Do not prompt for confirmation; accept defaults and continue (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
config	Chef Automate configuration

chef-automate config show

Show the Chef Automate configuration. When given a filepath, the output will be written to the file instead of printed to STDOUT

Usage

chef-automate config show [/path/to/write/config.toml] [flags]

Flags

Flags	Description
--a2	Shows configurations from Automate node(HA)[DUPLICATE] (default: false)
-a, --automate	Shows configurations from Automate node(HA) (default: false)
-c, --chef_server	Shows configurations from Chef-server node(HA) (default: false)
--cs	Shows configurations from Chef-server node(HA)[DUPLICATE] (default: false)
-h, --help	help for show (default: false)
-o, --opensearch	Shows configurations from OpenSearch node (default: false)
--os	Shows configurations from OpenSearch node[DUPLICATE] (default: false)
-O, --overwrite	Overwrite existing config.toml [Standalone] (default: false)
--pg	Shows configurations from PostgresQL node[DUPLICATE] (default: false)
-p, --postgresql	Shows configurations from PostgresQL node (default: false)
--wait-timeout	This flag sets the operation timeout duration (in seconds) for each individual node during the config show process (default: 180)
-y, --auto-approve	Do not prompt for confirmation; accept defaults and continue (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
config	Chef Automate configuration

chef-automate deploy

Deploy a new Chef Automate instance using the supplied configuration. - <CONFIG_FILE> must be a valid path to a TOML formatted configuration file

Usage

chef-automate deploy [/path/to/config.toml] [flags]

Flags

Flags	Description
--accept-terms-and-mlsa	Agree to the Chef Software Terms of Service and the Master License and Services Agreement (default: false)
--airgap-bundle	Path to an airgap install bundle
-h, --help	help for deploy (default: false)
-y, --yes	Do not prompt for confirmation; accept defaults and continue (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate external-cert

Manage Chef Automate's external certificate authority. Used for establishing TLS/SSL communication with automate.

Usage

chef-automate external-cert COMMAND [flags]

Flags

Flags	Description
-f, --file	File path to save automate TLS certifcate to.
-h, --help	help for external-cert (default: false)
-n, --hostname	Hostname for the automate TLS certificate
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
external-cert show	Show the external TLS/SSL certificates in Automate. Optionally, save the certificates to a file in the specified path.

chef-automate external-cert show

Usage

chef-automate external-cert show [flags]

Flags

Flags	Description
-h, --help	help for show (default: false)
-d, --debug	Enable debug output (default: false)
-f, --file	File path to save automate TLS certifcate to.
-n, --hostname	Hostname for the automate TLS certificate
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
external-cert	Manage Chef Automate's external certificate

chef-automate gather-logs

Collect system diagnostics and logs from Chef Automate and other services

Usage

chef-automate gather-logs [/path/to/log/bundle.tar.gz] [flags]

Flags

Flags	Description
-h, --help	help for gather-logs (default: false)
-l, --local-fallback	run gather-logs in local fallback mode (default: false)
--log-lines	Number of system log lines (journald logs) to collect (0 for all logs) (default: 500000)
-o, --overwrite	Overwrite existing log archive (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate iam

Usage

chef-automate iam COMMAND [flags]

Flags

Flags	Description
-h, --help	help for iam (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
iam admin-access	Manage and restore default admin access
iam token	Manage tokens
iam version	Retrieve IAM version in use

chef-automate iam admin-access

Usage

chef-automate iam admin-access COMMAND [flags]

Flags

Flags	Description
-h, --help	help for admin-access (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
iam	Chef Automate iam commands
iam admin-access restore	Restore the factory default admin user, team, and access

chef-automate iam admin-access restore

Recreate the admin user, admin team, and related admin policy as needed to restore to factory default and update the admin user's password

Usage

chef-automate iam admin-access restore PASSWORD [flags]

Flags

Flags	Description
--dry-run	Show what would be updated by this command without performing any changes (default: false)
-h, --help	help for restore (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
iam admin-access	Manage and restore default admin access

chef-automate iam token

Usage

chef-automate iam token COMMAND [flags]

Flags

Flags	Description
-h, --help	help for token (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
iam	Chef Automate iam commands
iam token create	Generate a token

chef-automate iam token create

Usage

chef-automate iam token create NAME [flags]

Flags

Flags	Description
--admin	Generate a token and add it to the chef-managed admin policy (default: false)
-h, --help	help for create (default: false)
--id	Specify a custom ID (if omitted, an ID will be generated based on NAME)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
iam token	Manage tokens

chef-automate iam version

Usage

chef-automate iam version [flags]

Flags

Flags	Description
-h, --help	help for version (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
iam	Chef Automate iam commands

chef-automate info

Info for Automate HA cluster

Usage

chef-automate info [flags]

Flags

Flags	Description
-h, --help	help for info (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate infrastructure

Commands for automation infrastructure management, for data related to chef-client runs and chef-server actions.

Usage

chef-automate infrastructure COMMAND [flags]

Flags

Flags	Description
-h, --help	help for infrastructure (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Automate

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
infrastructure node-delete	Delete node by node uuid

chef-automate infrastructure node-delete

Usage

chef-automate infrastructure node-delete [uuid] [flags]

Flags

Flags	Description
-h, --help	help for node-delete (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Automate

Related Commands

Commands	Description
infrastructure	Chef Automate infrastructure

chef-automate init-config-ha

Initialized default configuration for HA and save it to a file.

Usage

chef-automate init-config-ha [flags]

Flags

Flags	Description
--file	File path to write the config (default: config.toml)
-h, --help	help for init-config-ha (default: false)
--path	a2ha hab workspace dir path (default: /hab/a2_deploy_workspace/)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate internal-ca

Manage Chef Automate's internal certificate authority. Used for inter-service encryption and authentication.

Usage

chef-automate internal-ca COMMAND [flags]

Flags

Flags	Description
-h, --help	help for internal-ca (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
internal-ca info	Print information the root certificate for the internal certificate authority
internal-ca regenerate	Commands to regenerate certificates issued by the internal certificate authority

chef-automate internal-ca info

Usage

chef-automate internal-ca info [flags]

Flags

Flags	Description
-h, --help	help for info (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
internal-ca	Manage Chef Automate's internal certificate authority

chef-automate internal-ca regenerate

Usage

chef-automate internal-ca regenerate [flags]

Flags

Flags	Description
-h, --help	help for regenerate (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
internal-ca	Manage Chef Automate's internal certificate authority
internal-ca regenerate root	Regenerate the root certificate for the internal certificate authority

chef-automate internal-ca regenerate root

Usage

chef-automate internal-ca regenerate root [flags]

Flags

Flags	Description
-h, --help	help for root (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
internal-ca regenerate	Commands to regenerate certificates issued by the internal certificate authority

chef-automate license

Usage

chef-automate license COMMAND [flags]

Flags

Flags	Description
-h, --help	help for license (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
license apply	Apply Chef Automate license
license complianceResourceRunCount	Generates the unique count of reported Compliance scans on hourly basis between the time duration
license complianceResourceRunReport	Generates daily Compliance scan reports for a span of time duration
license nodeRunReport	Generates daily Infra Client Run reports for a span of time duration
license status	Retrieve Chef Automate license status
license uniqNodeRunReport	Generates the unique count of reported Infra Client nodes on hourly basis between the time duration

chef-automate license apply

Apply Chef Automate license token. - <LICENSE> must be valid encoded license string

Usage

chef-automate license apply LICENSE [flags]

Flags

Flags	Description
-f, --force	Force set license (default: false)
-h, --help	help for apply (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
license	Chef Automate license management

chef-automate license complianceResourceRunCount

Usage

chef-automate license complianceResourceRunCount [flags]

Flags

Flags	Description
-e, --end_time	end time of the report in yyyy-mm-dd format
-n, --es_hostname	hostname of the OpenSource host (default: localhost)
-p, --es_port	port of the OpenSource host (default: 10168)
-f, --fileName	file name for the report Ex: complianceUniqueResourceCount
-h, --help	help for complianceResourceRunCount (default: false)
-P, --os_password	password of the OpenSource host (default: admin)
-u, --os_username	username of the OpenSource host (default: admin)
-s, --start_time	start time of the report in yyyy-mm-dd format
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
license	Chef Automate license management

chef-automate license complianceResourceRunReport

Usage

chef-automate license complianceResourceRunReport [flags]

Flags

Flags	Description
-e, --end_time	end time of the report in yyyy-mm-dd format
-n, --es_hostname	hostname of the OpenSource host (default: localhost)
-p, --es_port	port of the OpenSource host (default: 10168)
-f, --fileName	file name for the report Ex: complianceUniqueResourceCount
-h, --help	help for complianceResourceRunReport (default: false)
-P, --os_password	password of the OpenSource host (default: admin)
-u, --os_username	username of the OpenSource host (default: admin)
-s, --start_time	start time of the report in yyyy-mm-dd format
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
license	Chef Automate license management

chef-automate license nodeRunReport

Usage

chef-automate license nodeRunReport [flags]

Flags

Flags	Description
-e, --end_time	end time of the report in yyyy-mm-dd format
-n, --es_hostname	hostname of the OpenSource host (default: localhost)
-p, --es_port	port of the OpenSource host (default: 10168)
-f, --fileName	file name for the report Ex: complianceUniqueResourceCount
-h, --help	help for nodeRunReport (default: false)
-P, --os_password	password of the OpenSource host (default: admin)
-u, --os_username	username of the OpenSource host (default: admin)
-s, --start_time	start time of the report in yyyy-mm-dd format
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
license	Chef Automate license management

chef-automate license status

Usage

chef-automate license status [flags]

Flags

Flags	Description
-h, --help	help for status (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
license	Chef Automate license management

chef-automate license uniqNodeRunReport

Usage

chef-automate license uniqNodeRunReport [flags]

Flags

Flags	Description
-e, --end_time	end time of the report in yyyy-mm-dd format
-f, --fileName	file name for the report Ex: complianceUniqueResourceCount
-h, --help	help for uniqNodeRunReport (default: false)
-n, --os_hostname	hostname of the OpenSource host (default: localhost)
-P, --os_password	password of the OpenSource host (default: admin)
-p, --os_port	port of the OpenSource host (default: 10168)
-u, --os_username	username of the OpenSource host (default: admin)
-s, --start_time	start time of the report in yyyy-mm-dd format
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
license	Chef Automate license management

chef-automate maintenance

Chef Automate maintenance mode keeps all services running but rejects new connections at the load balancer so that maintenance operations can be performed.

Usage

chef-automate maintenance [on|off] [flags]

Flags

Flags	Description
-h, --help	help for maintenance (default: false)
-t, --timeout	Request timeout in seconds (default: 10)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate node

Usage

chef-automate node COMMAND [flags]

Flags

Flags	Description
-h, --help	help for node (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
node add	Add new node in HA
node remove	remove existing node in HA

chef-automate node add

Add new node in HA

Usage

chef-automate node add [flags]

Flags

Flags	Description
-y, --auto-accept	auto-accept (default: false)
-a, --automate-count	New automate instances to be added. Works with --aws-mode flag (default: 0)
-A, --automate-ips	New automate ip addresses to be added. Works with --onprem-mode flag
--aws-mode	Use this flag if the deployment type is AWS (default: false)
-c, --chef-server-count	New chef-server instances to be added. Works with --aws-mode flag (default: 0)
-C, --chef-server-ips	New chef-server ip addresses to be added. Works with --onprem-mode flag
-h, --help	help for add (default: false)
--onprem-mode	Use this flag if the deployment type is on prem (default: false)
-o, --opensearch-count	New opensearch instances to be added. Works with --aws-mode flag (default: 0)
-O, --opensearch-ips	New opensearch ip addresses to be added. Works with --onprem-mode flag
-p, --postgresql-count	New postgresql instances to be added. Works with --aws-mode flag (default: 0)
-P, --postgresql-ips	New postgres ip addresses to be added. Works with --onprem-mode flag
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
node	This command is used to add or delete HA nodes

chef-automate node remove

remove existing node in HA

Usage

chef-automate node remove [flags]

Flags

Flags	Description
-y, --auto-accept	auto-accept (default: false)
-A, --automate-ip	Automate ip addresses to be removed. Works with --onprem-mode flag
--aws-mode	Use this flag if the deployment type is AWS (default: false)
-C, --chef-server-ip	Chef-server ip addresses to be removed. Works with --onprem-mode flag
-h, --help	help for remove (default: false)
--onprem-mode	Use this flag if the deployment type is on prem (default: false)
-O, --opensearch-ip	OpenSearch ip addresses to be removed. Works with --onprem-mode flag
-P, --postgresql-ip	Postgresql ip addresses to be removed. Works with --onprem-mode flag
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
node	This command is used to add or delete HA nodes

chef-automate preflight-check

Perform preflight check to verify host meets installation criteria.

Usage

chef-automate preflight-check [flags]

Flags

Flags	Description
--a2	Pass this flag to run pre-flight check on automate node(HA) (default: false)
--airgap	Pass this flag when the environment is airgapped (default: false)
-a, --automate	Pass this flag to run pre-flight check on automate node(HA) (default: false)
-c, --chef_server	Pass this flag to run pre-flight check on chef-server node(HA) (default: false)
--config	Optional config file to use
--cs	Pass this flag to run pre-flight check on chef-server node(HA) (default: false)
--fe	Pass this flag to run pre-flight check on all Frontend nodes (default: false)
-f, --frontend	Pass this flag to run pre-flight check on all Frontend nodes (default: false)
--ha-deployment-config	Pass this flag to run pre-flight check on automate-HA (default: false)
-h, --help	help for preflight-check (default: false)
--node	Pass this flag to run pre-flight check on a perticular node node(HA)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
preflight-check migrate-from-v1	Run preflight checks specific to migrating from Chef Automate v1

chef-automate provision-infra

Provision infra for Automate HA deployment.

Usage

chef-automate provision-infra [flags]

Flags

Flags	Description
--airgap-bundle	Path to an airgap install bundle
--channel	Release channel to deploy all services from
-h, --help	help for provision-infra (default: false)
--saas	Flag for saas setup (default: false)
-y, --yes	Do not prompt for confirmation; accept defaults and continue (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate restart-services

Restart services for a deployment

Usage

chef-automate restart-services [flags]

Flags

Flags	Description
-h, --help	help for restart-services (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate secrets

Set secrets for Automate sudo password and admin password in HA mode.

Usage

chef-automate secrets [flags]

Flags

Flags	Description
-h, --help	help for secrets (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate service-versions

Retrieve the versions of the individual Chef Automate services

Usage

chef-automate service-versions [flags]

Flags

Flags	Description
-h, --help	help for service-versions (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate ssh

SSH into Automate HA servers

Usage

chef-automate ssh [flags]

Flags

Flags	Description
-h, --help	help for ssh (default: false)
-H, --hostname	Automate ha server name to ssh
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate start

Usage

chef-automate start [flags]

Flags

Flags	Description
--a2	start chef automate service on automate nodes[DUPLICATE] (default: false)
-a, --automate	start chef automate service on automate nodes (default: false)
-c, --chef_server	start chef automate service on chef-server nodes (default: false)
--cs	start chef automate service on chef-server nodes[DUPLICATE] (default: false)
-h, --help	help for start (default: false)
-o, --opensearch	start hab-sup service on opensearch nodes (default: false)
--os	start hab-sup service on opensearch nodes[DUPLICATE] (default: false)
--pg	start hab-sup service on postgresql nodes[DUPLICATE] (default: false)
-p, --postgresql	start hab-sup service on postgresql nodes (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate status

Retrieve Chef Automate status. Includes status of Automate services.

Usage

chef-automate status [flags]

Flags

Flags	Description
-h, --help	help for status (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
status summary	Retrieve Chef Automate status-summary

chef-automate status summary

Retrieve Chef Automate status node summary for HA deployment

Usage

chef-automate status summary [flags]

Flags

Flags	Description
-a, --automate	Get only automate Status (default: false)
-c, --chef-server	Get only chef server Status (default: false)
-h, --help	help for summary (default: false)
--node	Node Ip address
-o, --opensearch	Get only opensearch Status (default: false)
-p, --postgresql	Get only postgresql Status (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
status	Retrieve Chef Automate status

chef-automate stop

Stop a running deployment of Automate.

Usage

chef-automate stop [flags]

Flags

Flags	Description
-h, --help	help for stop (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate system-logs

Start streaming logs from the Chef Automate server. Ctrl + c to stop.

Usage

chef-automate system-logs [flags]

Flags

Flags	Description
-h, --help	help for system-logs (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate test

Run smoke test for Automate HA services.

Usage

chef-automate test [flags]

Flags

Flags	Description
--full	Automate ha cluster test full (default: false)
-h, --help	help for test (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate upgrade

Usage

chef-automate upgrade COMMAND [flags]

Flags

Flags	Description
-h, --help	help for upgrade (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI
upgrade run	Run an upgrade of Chef Automate
upgrade status	Get upgrade status of Chef Automate

chef-automate upgrade run

Run an upgrade of Chef Automate

Usage

chef-automate upgrade run [flags]

Flags

Flags	Description
--airgap-bundle	Path to an airgap install bundle
-y, --auto-approve	Do not prompt for confirmation; accept defaults and continue (default: false)
-h, --help	help for run (default: false)
--saas	Flag for saas setup (default: false)
--skip-deploy	will only upgrade and not deploy the bundle (default: false)
--upgrade-airgap-bundles	Update Chef Automate both frontend and backend version to install (default: false)
--upgrade-backends	Update Chef Automate backends version to install (default: false)
--upgrade-frontends	upgrade Chef Automate HA frontends version to install (default: false)
-w, --workspace-upgrade	Do not prompt for confirmation to accept workspace upgrade
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
upgrade	upgrade automate to the latest version

chef-automate upgrade status

Get upgrade status of Chef Automate

Usage

chef-automate upgrade status [flags]

Flags

Flags	Description
-h, --help	help for status (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
upgrade	upgrade automate to the latest version

chef-automate version

Show the CLI version.

Usage

chef-automate version [flags]

Flags

Flags	Description
--connection-timeout	Most time to wait to connect to service (default: 0s)
--endpoint	The endpoint the service is listening on
-h, --help	help for version (default: false)
-v, --verbose	Show additional version information (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

FrontEnd

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

chef-automate workspace

Set up Automate HA cluster workspace.

Usage

chef-automate workspace [flags]

Flags

Flags	Description
-h, --help	help for workspace (default: false)
-d, --debug	Enable debug output (default: false)
--no-check-version	Disable version check (default: false)
--result-json	Write command result as JSON to PATH

Supported On

Bastion

Related Commands

Commands	Description
chef-automate	Chef Automate CLI

Error Codes

If chef-automate encounters an error during execution, it exits with a non-zero error code. Here’s what our error codes mean:

Chef Automate CLI Status Error Codes
Exit Code	Name	Description
68	HabUserAccessError	Unable to access file or directory with the hab user
69	SnapshotChecksumMismatchError	A file in the snapshot did not have the expected checksum
70	DatabaseError	An issue occurred with the database
71	CommandExecutionError	An issue occurred when running an executable command
72	TraceError	An issue occurred when attempting to trace the request
73	ProfileError	An issue occurred when attempting to profile the request
74	HabCommandError	An issue occurred when running a hab command
75	HabAPIError	An issue occurred when attempting to query the Habitat API
76	GatherLogsError	Unable to complete log gathering
77	PackageInstallError	Unable to install the habitat package
78	TimedOutError	Timed out waiting for the operation to complete
79	BackupRestoreError	Unable to restore backup
80	ServiceUnloadError	Unable to unload the habitat service
81	ServiceStartError	Unable to start the habitat service
82	AirgapUnpackInstallBundleError	An issue occurred when attempting to unpack the airgap install bundle
83	AirgapCreateInstallBundleError	An issue occurred when attempting to create the airgap install bundle
84	DownloadError	An issue occurred when attempting to perform a file download
85	UninstallError	An issue occurred when attempting to uninstall Chef Automate
86	BackupError	An issue occurred when creating or restoring a backup
87	UpgradeError	An issue occurred during the upgrade
88	MarshalError	Unable to convert or deconvert a textual representation of an internal object
89	LicenseError	The license is invalid, expired or incomplete
90	FileAccessError	Unable to access the file or directory
91	DiagnosticsError	One or more diagnostics checks failed
92	MustBeRootError	The command must be run as the root user
93	ConfigError	The configuration is invalid
94	DeployError	Unable to install, configure and start the service
95	PreflightError	One or more preflight checks failed
96	InvalidCommandArgsError	The arguments provided are invalid
97	UnhealthyStatusError	System status is unhealthy
98	DeploymentServiceCallError	A request to the deployment-service failed
99	DeploymentServiceUnreachableError	Unable to make a request to the deployment-service
100	APIError	An API error occurred during execution
112	UpdateExecError	An issue occurred when trying to run an auto-updated CLI executable
113	UnknownError	An unknown issue occurred during execution
114	APIUnreachableError	Could not connect to Automate API
115	UnknownError	Failed to upgrade IAM to v2
116	UnknownError	Failed to reset IAM state to v1
117	DeploymentServiceError	Failed to restart Deployment Service
118	InappropriateSettingError	Settings are not appropriate
119	AvailableSpaceError	Error in getting available space
120	CalESDirSizeError	Error in calculating ES directory size
121	CalDestDirSizeError	Error in calculating Dest directory size
122	InsufficientSpaceError	Insufficient disk space