chef-automate CLI
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
Usagechef-automate COMMAND [flags]
Flags-d, --debugEnable debug output (default: false)-h, --helphelp for chef-automate (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage applications observability featuresChef Automate backupChef Automate configurationDeploy Chef AutomateManage Chef Automate's external certificateGather system diagnostics and logsChef Automate iam commandsInfo about Automate HAChef Automate infrastructureInitialize default configInitialize default config for Automate HAManage Chef Automate's internal certificate authorityChef Automate license managementPut Chef Automate into or out of maintenance modeMigrate from Chef Automate v1Watch the status of the migration to Chef Automate 2Perform preflight checkProvision Automate HA infra.restart deployment servicesSet secrets to Automate HARetrieve the versions of the individual Chef Automate servicesSSH into Automate HA serversStart Chef AutomateRetrieve Chef Automate statusStop deploymentTail Chef Automate logsRun Automate HA smoke testsUninstall Chef Automateupgrade automate to the latest versionShow CLI versionSet workspace env for Automate HA.chef-automate airgap
chef-automate COMMAND [flags]
See AlsoManage applications observability featuresChef Automate backupChef Automate configurationDeploy Chef AutomateManage Chef Automate's external certificateGather system diagnostics and logsChef Automate iam commandsInfo about Automate HAChef Automate infrastructureInitialize default configInitialize default config for Automate HAManage Chef Automate's internal certificate authorityChef Automate license managementPut Chef Automate into or out of maintenance modeMigrate from Chef Automate v1Watch the status of the migration to Chef Automate 2Perform preflight checkProvision Automate HA infra.restart deployment servicesSet secrets to Automate HARetrieve the versions of the individual Chef Automate servicesSSH into Automate HA serversStart Chef AutomateRetrieve Chef Automate statusStop deploymentTail Chef Automate logsRun Automate HA smoke testsUninstall Chef Automateupgrade automate to the latest versionShow CLI versionSet workspace env for Automate HA.chef-automate airgap
Usagechef-automate airgap COMMAND [flags]
Flags-h, --helphelp for airgap (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate airgap bundle
chef-automate airgap COMMAND [flags]
See Alsochef-automate airgap bundle
Usagechef-automate airgap bundle COMMAND [flags]
Flags-h, --helphelp for bundle (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate airgap bundle create
chef-automate airgap bundle COMMAND [flags]
See Alsochef-automate airgap bundle create
Usagechef-automate airgap bundle create [/path/to/bundle.aib] [flags]
Flags-c, --channelRelease channel to pull packages from-h, --helphelp for create (default: false)-m, --manifestPath to a release manifest.json-r, --retriesNumber of times to retry failed hab package downloads (default: 2)--retry-delayNumber of seconds to wait between retries (exponential backoff is used if not provided)
(default: -1)--versionChef Automate version to create an airgap bundle for-w, --workspacePath to workspace storage location where temporary data will be stored-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate airgap bundle info
chef-automate airgap bundle create [/path/to/bundle.aib] [flags]
See Alsochef-automate airgap bundle info
Usagechef-automate airgap bundle info /path/to/bundle.aib [flags]
Flags-h, --helphelp for info (default: false)--verboseOutput full AIB metadata (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate applications
chef-automate airgap bundle info /path/to/bundle.aib [flags]
See Alsochef-automate applications
Usagechef-automate applications COMMAND [flags]
Flags-h, --helphelp for applications (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIRemove services from the applications databaseShow services in the applications databasechef-automate applications remove-svcs
chef-automate applications COMMAND [flags]
See AlsoChef Automate CLIRemove services from the applications databaseShow services in the applications databasechef-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.
Usagechef-automate applications remove-svcs [flags]
Flags--allDelete all services in the database. This flag must be given if no other filter is given.
(default: false)-a, --applicationSelect only services where the application name matches the given pattern-b, --buildstampSelect only services where the buildstamp matches the given pattern-c, --channelSelect only services where the subscribed channel matches the given pattern-D, --disconnectedSelect only services that are disconnected (default: false)-e, --environmentSelect only services where the application environment matches the given pattern-g, --groupSelect only services where the group name (suffix) matches the given pattern-h, --helphelp for remove-svcs (default: false)-o, --originSelect only services where the origin matches the given pattern-n, --service-nameSelect only services where the name matches the given pattern-s, --siteSelect only services where the site matches the given pattern-v, --versionSelect only services where the package version matches the given pattern-y, --yesDelete the services without a confirmation prompt (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage applications observability featureschef-automate applications show-svcs
chef-automate applications remove-svcs [flags]
See AlsoManage applications observability featureschef-automate applications show-svcs
Display a list of the habitat services stored in the applications database.
Usagechef-automate applications show-svcs [flags]
Flags-a, --applicationSelect only services where the application name matches the given pattern-b, --buildstampSelect only services where the buildstamp matches the given pattern-c, --channelSelect only services where the subscribed channel matches the given pattern-D, --disconnectedSelect only services that are disconnected (default: false)-e, --environmentSelect only services where the application environment matches the given pattern-g, --groupSelect only services where the group name (suffix) matches the given pattern-h, --helphelp for show-svcs (default: false)-o, --originSelect only services where the origin matches the given pattern-n, --service-nameSelect only services where the name matches the given pattern-s, --siteSelect only services where the site matches the given pattern-v, --versionSelect only services where the package version matches the given pattern-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage applications observability featureschef-automate backup
chef-automate applications show-svcs [flags]
See AlsoManage applications observability featureschef-automate backup
Usagechef-automate backup COMMAND [flags]
Flags--gcs-credentials-pathThe path to the GCP service account json file-h, --helphelp for backup (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM role-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIcancel the running backup operationcreate a backup of Chef Automatedelete backups of Chef AutomateEnsure the hab user has the required permissions on the given pathChef Automate shared object integritylist all Chef Automate backupsrestore a Chef Automate backupshow the Chef Automate backup detailsshow the Chef Automate backup runner statuschef-automate backup cancel
chef-automate backup COMMAND [flags]
See AlsoChef Automate CLIcancel the running backup operationcreate a backup of Chef Automatedelete backups of Chef AutomateEnsure the hab user has the required permissions on the given pathChef Automate shared object integritylist all Chef Automate backupsrestore a Chef Automate backupshow the Chef Automate backup detailsshow the Chef Automate backup runner statuschef-automate backup cancel
Cancel the currently running backup create, delete, or restore operation
Usagechef-automate backup cancel [flags]
Flags-h, --helphelp for cancel (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup create
chef-automate backup cancel [flags]
See AlsoChef Automate backupchef-automate backup create
Create a backup of Chef Automate
Usagechef-automate backup create [flags]
Flags-h, --helphelp for create (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 43200)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup delete
chef-automate backup create [flags]
See AlsoChef Automate backupchef-automate backup delete
Delete one or many backups of Chef Automate that match the space separated strings of backup IDs
Usagechef-automate backup delete ID [ID2 IDN...] [flags]
Flags-h, --helphelp for delete (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 43200)--yesAgree to all prompts (default: false)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup fix-repo-permissions
chef-automate backup delete ID [ID2 IDN...] [flags]
See AlsoChef Automate backupchef-automate backup fix-repo-permissions
Ensure the hab user has the required permissions on the given path
Usagechef-automate backup fix-repo-permissions PATH [flags]
Flags-h, --helphelp for fix-repo-permissions (default: false)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup integrity
chef-automate backup fix-repo-permissions PATH [flags]
See AlsoChef Automate backupchef-automate backup integrity
Usagechef-automate backup integrity COMMAND [flags]
Flags-h, --helphelp for integrity (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupshow the shared object integrity metadatavalidate the shared object integritychef-automate backup integrity show
chef-automate backup integrity COMMAND [flags]
See AlsoChef Automate backupshow the shared object integrity metadatavalidate the shared object integritychef-automate backup integrity show
Show the shared object integrity metadata
Usagechef-automate backup integrity show [flags]
Flags-h, --helphelp for show (default: false)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM role-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)See AlsoChef Automate shared object integritychef-automate backup integrity validate
chef-automate backup integrity show [flags]
See AlsoChef Automate shared object integritychef-automate backup integrity validate
Validate the shared object integrity. If one or more snapshot IDs is not given all snapshots will be validated
Usagechef-automate backup integrity validate [ID IDN] [flags]
Flags-h, --helphelp for validate (default: false)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM role-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)See AlsoChef Automate shared object integritychef-automate backup list
chef-automate backup integrity validate [ID IDN] [flags]
See AlsoChef Automate shared object integritychef-automate backup list
List all Chef Automate backups
Usagechef-automate backup list [flags]
Flags-h, --helphelp for list (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup restore
chef-automate backup list [flags]
See AlsoChef Automate backupchef-automate backup restore
Restore a Chef Automate backup. If no ID or path is given the latest found backup will be restored.
Usagechef-automate backup restore [ID_OR_PATH] [flags]
Flags--airgap-bundleThe artifact to use for an air-gapped installation-b, --backup-dirDirectory used for backups (default: /var/opt/chef-automate/backups)-h, --helphelp for restore (default: false)--patch-configPath to patch config if required--sha256The SHA256 checksum of the backup--skip-preflightSkip preflight checks when restoring a backup (default: false)-u, --upgradeUpgrade to the latest package versions when restoring backups
(default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 43200)--yesAgree to all prompts (default: false)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup show
chef-automate backup restore [ID_OR_PATH] [flags]
See AlsoChef Automate backupchef-automate backup show
Show the details of a Chef Automate backup
Usagechef-automate backup show ID [flags]
Flags-h, --helphelp for show (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate backup status
chef-automate backup show ID [flags]
See AlsoChef Automate backupchef-automate backup status
Show the Chef Automate backup runner status
Usagechef-automate backup status [flags]
Flags-h, --helphelp for status (default: false)-t, --wait-timeoutHow long to wait for a operation to complete before raising an error
(default: 60)-d, --debugEnable debug output (default: false)--gcs-credentials-pathThe path to the GCP service account json file--no-check-versionDisable version check (default: false)--no-progressDon't follow operation progress (default: false)-r, --request-timeoutAPI request timeout for deployment-service in seconds (default: 20)--result-jsonWrite command result as JSON to PATH--s3-access-keyThe S3 access key ID--s3-endpointThe S3 region endpoint URL--s3-secret-keyThe S3 secret access key--s3-session-tokenThe S3 session token when assuming an IAM roleSee AlsoChef Automate backupchef-automate config
chef-automate backup status [flags]
See AlsoChef Automate backupchef-automate config
Usagechef-automate config COMMAND [flags]
Flags-y, --auto-approveDo not prompt for confirmation; accept defaults and continue (default: false)-h, --helphelp for config (default: false)-t, --timeoutRequest timeout in seconds (default: 10)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIpatch the Chef Automate configurationset the Chef Automate configurationshow the Chef Automate configurationchef-automate config patch
chef-automate config COMMAND [flags]
See AlsoChef Automate CLIpatch the Chef Automate configurationset the Chef Automate configurationshow the Chef Automate configurationchef-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.
Usagechef-automate config patch path/to/config.toml [flags]
Flags-h, --helphelp for patch (default: false)-y, --auto-approveDo not prompt for confirmation; accept defaults and continue (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATH-t, --timeoutRequest timeout in seconds (default: 10)See AlsoChef Automate configurationchef-automate config set
chef-automate config patch path/to/config.toml [flags]
See AlsoChef Automate configurationchef-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.
Usagechef-automate config set path/to/config.toml [flags]
Flags-h, --helphelp for set (default: false)-y, --auto-approveDo not prompt for confirmation; accept defaults and continue (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATH-t, --timeoutRequest timeout in seconds (default: 10)See AlsoChef Automate configurationchef-automate config show
chef-automate config set path/to/config.toml [flags]
See AlsoChef Automate configurationchef-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
Usagechef-automate config show [/path/to/write/config.toml] [flags]
Flags-h, --helphelp for show (default: false)-o, --overwriteOverwrite existing config.toml (default: false)-y, --auto-approveDo not prompt for confirmation; accept defaults and continue (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATH-t, --timeoutRequest timeout in seconds (default: 10)See AlsoChef Automate configurationchef-automate deploy
chef-automate config show [/path/to/write/config.toml] [flags]
See AlsoChef Automate configurationchef-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
Usagechef-automate deploy [/path/to/config.toml] [flags]
Flags--accept-terms-and-mlsaAgree to the Chef Software Terms of Service and the Master License and Services Agreement
(default: false)--airgap-bundlePath to an airgap install bundle--certificateThe path to a certificate that should be used for external TLS connections (web and API).--channelRelease channel to deploy all services from--fqdnThe fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine)-h, --helphelp for deploy (default: false)--private-keyThe path to a private key corresponding to the TLS certificate.--productProduct to deploy (default: [])--skip-preflightDeploy regardless of pre-flight conditions (default: false)--upgrade-strategyUpgrade strategy to use for this deployment. (default: at-once)-y, --yesDo not prompt for confirmation; accept defaults and continue (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate external-cert
chef-automate deploy [/path/to/config.toml] [flags]
See AlsoChef Automate CLIchef-automate external-cert
Manage Chef Automate's external certificate authority. Used for establishing TLS/SSL communication with automate.
Usagechef-automate external-cert COMMAND [flags]
Flags-f, --fileFile path to save automate TLS certifcate to.-h, --helphelp for external-cert (default: false)-n, --hostnameHostname for the automate TLS certificate-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIShow the external TLS/SSL certificates in Automate. Optionally, save the certificates to a file in the specified path.chef-automate external-cert show
chef-automate external-cert COMMAND [flags]
See AlsoChef Automate CLIShow the external TLS/SSL certificates in Automate. Optionally, save the certificates to a file in the specified path.chef-automate external-cert show
Usagechef-automate external-cert show [flags]
Flags-h, --helphelp for show (default: false)-d, --debugEnable debug output (default: false)-f, --fileFile path to save automate TLS certifcate to.-n, --hostnameHostname for the automate TLS certificate--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage Chef Automate's external certificatechef-automate gather-logs
chef-automate external-cert show [flags]
See AlsoManage Chef Automate's external certificatechef-automate gather-logs
Collect system diagnostics and logs from Chef Automate and other services
Usagechef-automate gather-logs [/path/to/log/bundle.tar.gz] [flags]
Flags-h, --helphelp for gather-logs (default: false)-l, --local-fallbackrun gather-logs in local fallback mode (default: false)--log-linesNumber of system log lines (journald logs) to collect (0 for all logs)
(default: 500000)-o, --overwriteOverwrite existing log archive (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate iam
chef-automate gather-logs [/path/to/log/bundle.tar.gz] [flags]
See AlsoChef Automate CLIchef-automate iam
Usagechef-automate iam COMMAND [flags]
Flags-h, --helphelp for iam (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIManage and restore default admin accessManage tokensRetrieve IAM version in usechef-automate iam admin-access
chef-automate iam COMMAND [flags]
See AlsoChef Automate CLIManage and restore default admin accessManage tokensRetrieve IAM version in usechef-automate iam admin-access
Usagechef-automate iam admin-access COMMAND [flags]
Flags-h, --helphelp for admin-access (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate iam commandsRestore the factory default admin user, team, and accesschef-automate iam admin-access restore
chef-automate iam admin-access COMMAND [flags]
See AlsoChef Automate iam commandsRestore the factory default admin user, team, and accesschef-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
Usagechef-automate iam admin-access restore PASSWORD [flags]
Flags--dry-runShow what would be updated by this command without performing any changes
(default: false)-h, --helphelp for restore (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage and restore default admin accesschef-automate iam token
chef-automate iam admin-access restore PASSWORD [flags]
See AlsoManage and restore default admin accesschef-automate iam token
Usagechef-automate iam token COMMAND [flags]
Flags-h, --helphelp for token (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate iam token create
chef-automate iam token COMMAND [flags]
See Alsochef-automate iam token create
Usagechef-automate iam token create NAME [flags]
Flags--adminGenerate a token and add it to the chef-managed admin policy (default: false)-h, --helphelp for create (default: false)--idSpecify a custom ID (if omitted, an ID will be generated based on NAME)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage tokenschef-automate iam version
chef-automate iam token create NAME [flags]
See AlsoManage tokenschef-automate iam version
Usagechef-automate iam version [flags]
Flags-h, --helphelp for version (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate iam commandschef-automate info
chef-automate iam version [flags]
See AlsoChef Automate iam commandschef-automate info
Info for Automate HA cluster
Usagechef-automate info [flags]
Flags-h, --helphelp for info (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate infrastructure
chef-automate info [flags]
See AlsoChef Automate CLIchef-automate infrastructure
Commands for automation infrastructure management, for data related to chef-client runs and chef-server actions.
Usagechef-automate infrastructure COMMAND [flags]
Flags-h, --helphelp for infrastructure (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate infrastructure node-delete
chef-automate infrastructure COMMAND [flags]
See Alsochef-automate infrastructure node-delete
Usagechef-automate infrastructure node-delete [uuid] [flags]
Flags-h, --helphelp for node-delete (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate infrastructurechef-automate init-config
chef-automate infrastructure node-delete [uuid] [flags]
See AlsoChef Automate infrastructurechef-automate init-config
Initialize default configuration and save it to a file.
Usagechef-automate init-config [flags]
Flags--certificateThe path to a certificate that should be used for external TLS connections (web and API).--channelRelease channel to deploy all services from (default: current)--es-memThe amount of system memory to allocate to Elasticsearch's heap. (default: 25% of system memory)--fileFile path to write the config (default: config.toml)--fqdnThe fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine)-h, --helphelp for init-config (default: false)--os-memThe amount of system memory to allocate to Opensearch's heap. (default: 25% of system memory)--private-keyThe path to a private key corresponding to the TLS certificate.--upgrade-strategyUpgrade strategy to use for this deployment. (default: at-once)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate init-config-ha
chef-automate init-config [flags]
See AlsoChef Automate CLIchef-automate init-config-ha
Initialized default configuration for HA and save it to a file.
Usagechef-automate init-config-ha [flags]
Flags--fileFile path to write the config (default: config.toml)-h, --helphelp for init-config-ha (default: false)--patha2ha hab workspace dir path (default: /hab/a2_deploy_workspace/)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate internal-ca
chef-automate init-config-ha [flags]
See AlsoChef Automate CLIchef-automate internal-ca
Manage Chef Automate's internal certificate authority. Used for inter-service encryption and authentication.
Usagechef-automate internal-ca COMMAND [flags]
Flags-h, --helphelp for internal-ca (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIPrint information the root certificate for the internal certificate authorityCommands to regenerate certificates issued by the internal certificate authoritychef-automate internal-ca info
chef-automate internal-ca COMMAND [flags]
See AlsoChef Automate CLIPrint information the root certificate for the internal certificate authorityCommands to regenerate certificates issued by the internal certificate authoritychef-automate internal-ca info
Usagechef-automate internal-ca info [flags]
Flags-h, --helphelp for info (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage Chef Automate's internal certificate authoritychef-automate internal-ca regenerate
chef-automate internal-ca info [flags]
See AlsoManage Chef Automate's internal certificate authoritychef-automate internal-ca regenerate
Usagechef-automate internal-ca regenerate [flags]
Flags-h, --helphelp for regenerate (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoManage Chef Automate's internal certificate authorityRegenerate the root certificate for the internal certificate authoritychef-automate internal-ca regenerate root
chef-automate internal-ca regenerate [flags]
See AlsoManage Chef Automate's internal certificate authorityRegenerate the root certificate for the internal certificate authoritychef-automate internal-ca regenerate root
Usagechef-automate internal-ca regenerate root [flags]
Flags-h, --helphelp for root (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoCommands to regenerate certificates issued by the internal certificate authoritychef-automate license
chef-automate internal-ca regenerate root [flags]
See AlsoCommands to regenerate certificates issued by the internal certificate authoritychef-automate license
Usagechef-automate license COMMAND [flags]
Flags-h, --helphelp for license (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIApply Chef Automate licenseGenerates the unique count of reported Compliance scans on hourly basis between the time durationGenerates daily Infra Client Run reports for a span of time durationGenerates daily Infra Client Run reports for a span of time durationRetrieve Chef Automate license statusGenerates the unique count of reported Infra Client nodes on hourly basis between the time durationchef-automate license apply
chef-automate license COMMAND [flags]
See AlsoChef Automate CLIApply Chef Automate licenseGenerates the unique count of reported Compliance scans on hourly basis between the time durationGenerates daily Infra Client Run reports for a span of time durationGenerates daily Infra Client Run reports for a span of time durationRetrieve Chef Automate license statusGenerates the unique count of reported Infra Client nodes on hourly basis between the time durationchef-automate license apply
Apply Chef Automate license token. - <LICENSE> must be valid encoded license string
Usagechef-automate license apply LICENSE [flags]
Flags-f, --forceForce set license (default: false)-h, --helphelp for apply (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate license managementchef-automate license complianceResourceRunCount
chef-automate license apply LICENSE [flags]
See AlsoChef Automate license managementchef-automate license complianceResourceRunCount
Usagechef-automate license complianceResourceRunCount [flags]
Flags-e, --end_timeend time of the report in yyyy-mm-dd format-n, --es_hostnamehostname of the OpenSource host (default: localhost)-p, --es_portport of the OpenSource host (default: 10168)-h, --helphelp for complianceResourceRunCount (default: false)-P, --os_passwordpassword of the OpenSource host (default: admin)-u, --os_usernameusername of the OpenSource host (default: admin)-s, --start_timestart time of the report in yyyy-mm-dd format-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate license managementchef-automate license complianceResourceRunReport
chef-automate license complianceResourceRunCount [flags]
See AlsoChef Automate license managementchef-automate license complianceResourceRunReport
Usagechef-automate license complianceResourceRunReport [flags]
Flags-e, --end_timeend time of the report in yyyy-mm-dd format-n, --es_hostnamehostname of the OpenSource host (default: localhost)-p, --es_portport of the OpenSource host (default: 10168)-h, --helphelp for complianceResourceRunReport (default: false)-P, --os_passwordpassword of the OpenSource host (default: admin)-u, --os_usernameusername of the OpenSource host (default: admin)-s, --start_timestart time of the report in yyyy-mm-dd format-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate license managementchef-automate license nodeRunReport
chef-automate license complianceResourceRunReport [flags]
See AlsoChef Automate license managementchef-automate license nodeRunReport
Usagechef-automate license nodeRunReport [flags]
Flags-e, --end_timeend time of the report in yyyy-mm-dd format-n, --es_hostnamehostname of the OpenSource host (default: localhost)-p, --es_portport of the OpenSource host (default: 10168)-h, --helphelp for nodeRunReport (default: false)-P, --os_passwordpassword of the OpenSource host (default: admin)-u, --os_usernameusername of the OpenSource host (default: admin)-s, --start_timestart time of the report in yyyy-mm-dd format-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate license managementchef-automate license status
chef-automate license nodeRunReport [flags]
See AlsoChef Automate license managementchef-automate license status
Usagechef-automate license status [flags]
Flags-h, --helphelp for status (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate license managementchef-automate license uniqNodeRunReport
chef-automate license status [flags]
See AlsoChef Automate license managementchef-automate license uniqNodeRunReport
Usagechef-automate license uniqNodeRunReport [flags]
Flags-e, --end_timeend time of the report in yyyy-mm-dd format-h, --helphelp for uniqNodeRunReport (default: false)-n, --os_hostnamehostname of the OpenSource host (default: localhost)-P, --os_passwordpassword of the OpenSource host (default: admin)-p, --os_portport of the OpenSource host (default: 10168)-u, --os_usernameusername of the OpenSource host (default: admin)-s, --start_timestart time of the report in yyyy-mm-dd format-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate license managementchef-automate maintenance
chef-automate license uniqNodeRunReport [flags]
See AlsoChef Automate license managementchef-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.
Usagechef-automate maintenance [on|off] [flags]
Flags-h, --helphelp for maintenance (default: false)-t, --timeoutRequest timeout in seconds (default: 10)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate migrate-from-v1
chef-automate maintenance [on|off] [flags]
See AlsoChef Automate CLIchef-automate migrate-from-v1
Migrate an existing Chef Automate v1 deployment to Chef Automate v2. - <CONFIG_FILE> must be a valid path to a TOML formatted configuration file
Usagechef-automate migrate-from-v1 [/path/to/automate-deploy.toml] [flags]
Flags--airgap-bundlePath to an airgap install bundle--channelOptional channel to use when installing packages from the depot--chef-server-runningPath to chef-server-running.json (default: /etc/opscode/chef-server-running.json)-c, --configPath to an automate-deploy.toml-r, --delivery-runningPath to delivery-running.json (default: /etc/delivery/delivery-running.json)-s, --delivery-secretsPath to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json)--enable-chef-serverEnable integrated Chef Server migration and deployment; only valid for all-in-one topology
(default: false)--file-move-timeoutOptional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
(default: 0)-h, --helphelp for migrate-from-v1 (default: false)--postgres-dump-wait-secondsOptional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
(default: 0)--postgres-restore-wait-secondsOptional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
(default: 0)--skip-backupOptionally skip backup of your Chef Automate v1 installation (default = false)
(default: false)--skip-backup-checkOptionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false)--skip-disaster-recovery-checkOptionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false)--skip-external-es-checkOptionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false)--skip-fips-checkOptionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false)--skip-preflightDeploy regardless of pre-flight conditions (default: false)--skip-saml-checkOptionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false)--skip-workflow-checkOptionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false)--upgrade-strategyOptional upgrade strategy to use when configuring the deployment service-y, --yesDo not prompt for confirmation; accept defaults and continue (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsochef-automate migrate-from-v1-status
chef-automate migrate-from-v1 [/path/to/automate-deploy.toml] [flags]
See Alsochef-automate migrate-from-v1-status
Usagechef-automate migrate-from-v1-status [flags]
Flags-h, --helphelp for migrate-from-v1-status (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate migrate-from-v1 gen-config
chef-automate migrate-from-v1-status [flags]
See AlsoChef Automate CLIchef-automate migrate-from-v1 gen-config
Generate a Chef Automate v2 configuration file from Chef Automate v1
Usagechef-automate migrate-from-v1 gen-config [flags]
Flags-h, --helphelp for gen-config (default: false)-o, --outOutput file (default: ./automate-migrate.toml)--airgap-bundlePath to an airgap install bundle--channelOptional channel to use when installing packages from the depot--chef-server-runningPath to chef-server-running.json (default: /etc/opscode/chef-server-running.json)-c, --configPath to an automate-deploy.toml-d, --debugEnable debug output (default: false)-r, --delivery-runningPath to delivery-running.json (default: /etc/delivery/delivery-running.json)-s, --delivery-secretsPath to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json)--enable-chef-serverEnable integrated Chef Server migration and deployment; only valid for all-in-one topology
(default: false)--file-move-timeoutOptional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
(default: 0)--no-check-versionDisable version check (default: false)--postgres-dump-wait-secondsOptional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
(default: 0)--postgres-restore-wait-secondsOptional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
(default: 0)--result-jsonWrite command result as JSON to PATH--skip-backupOptionally skip backup of your Chef Automate v1 installation (default = false)
(default: false)--skip-backup-checkOptionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false)--skip-disaster-recovery-checkOptionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false)--skip-external-es-checkOptionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false)--skip-fips-checkOptionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false)--skip-preflightDeploy regardless of pre-flight conditions (default: false)--skip-saml-checkOptionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false)--skip-workflow-checkOptionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false)--upgrade-strategyOptional upgrade strategy to use when configuring the deployment service-y, --yesDo not prompt for confirmation; accept defaults and continue (default: false)See AlsoMigrate from Chef Automate v1chef-automate preflight-check
chef-automate migrate-from-v1 gen-config [flags]
See AlsoMigrate from Chef Automate v1chef-automate preflight-check
Perform preflight check to verify host meets installation criteria.
Usagechef-automate preflight-check [flags]
Flags--airgapPass this flag when the environment is airgapped (default: false)--configOptional config file to use-h, --helphelp for preflight-check (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIRun preflight checks specific to migrating from Chef Automate v1chef-automate preflight-check migrate-from-v1
chef-automate preflight-check [flags]
See AlsoChef Automate CLIRun preflight checks specific to migrating from Chef Automate v1chef-automate preflight-check migrate-from-v1
Usagechef-automate preflight-check migrate-from-v1 [flags]
Flags-r, --delivery-runningPath to delivery-running.json (default: /etc/delivery/delivery-running.json)-s, --delivery-secretsPath to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json)-h, --helphelp for migrate-from-v1 (default: false)--skip-backup-checkOptionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false)--skip-disaster-recovery-checkOptionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false)--skip-external-es-checkOptionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false)--skip-fips-checkOptionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false)--skip-saml-checkOptionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false)--skip-workflow-checkOptionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false)--airgapPass this flag when the environment is airgapped (default: false)--configOptional config file to use-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoPerform preflight checkchef-automate provision-infra
chef-automate preflight-check migrate-from-v1 [flags]
See AlsoPerform preflight checkchef-automate provision-infra
Provision infra for Automate HA deployment.
Usagechef-automate provision-infra [flags]
Flags--airgap-bundlePath to an airgap install bundle--channelRelease channel to deploy all services from-h, --helphelp for provision-infra (default: false)--saasFlag for saas setup (default: false)-y, --yesDo not prompt for confirmation; accept defaults and continue (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate restart-services
chef-automate provision-infra [flags]
See AlsoChef Automate CLIchef-automate restart-services
Restart services for a deployment
Usagechef-automate restart-services [flags]
Flags-h, --helphelp for restart-services (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate secrets
chef-automate restart-services [flags]
See AlsoChef Automate CLIchef-automate secrets
Set secrets for Automate sudo password and admin password in HA mode.
Usagechef-automate secrets [flags]
Flags-h, --helphelp for secrets (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate service-versions
chef-automate secrets [flags]
See AlsoChef Automate CLIchef-automate service-versions
Retrieve the versions of the individual Chef Automate services
Usagechef-automate service-versions [flags]
Flags-h, --helphelp for service-versions (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate ssh
chef-automate service-versions [flags]
See AlsoChef Automate CLIchef-automate ssh
SSH into Automate HA servers
Usagechef-automate ssh [flags]
Flags-h, --helphelp for ssh (default: false)--hostnameAutomate ha server name to ssh-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate start
chef-automate ssh [flags]
See AlsoChef Automate CLIchef-automate start
Usagechef-automate start [flags]
Flags-h, --helphelp for start (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate status
chef-automate start [flags]
See AlsoChef Automate CLIchef-automate status
Retrieve Chef Automate status. Includes status of Automate services.
Usagechef-automate status [flags]
Flags-h, --helphelp for status (default: false)-w, --wait-for-healthyWait until the status response is healthy or the timeout is reached
(default: false)-r, --wait-refresh-intervalHow many seconds to wait between polling for status updates (default: 2)-t, --wait-timeoutHow many seconds to wait for the status to be healthy before returning an error
(default: 600)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate stop
chef-automate status [flags]
See AlsoChef Automate CLIchef-automate stop
Stop a running deployment of Automate.
Usagechef-automate stop [flags]
Flags-h, --helphelp for stop (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate system-logs
chef-automate stop [flags]
See AlsoChef Automate CLIchef-automate system-logs
Start streaming logs from the Chef Automate server. Ctrl + c to stop.
Usagechef-automate system-logs [flags]
Flags-h, --helphelp for system-logs (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate test
chef-automate system-logs [flags]
See AlsoChef Automate CLIchef-automate test
Run smoke test for Automate HA services.
Usagechef-automate test [flags]
Flags--fullAutomate ha cluster test full (default: false)-h, --helphelp for test (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate uninstall
chef-automate test [flags]
See AlsoChef Automate CLIchef-automate uninstall
Uninstall Chef Automate, deleting all data and configuration
Usagechef-automate uninstall [flags]
Flags-h, --helphelp for uninstall (default: false)--preserve-package-cachePreserve Habitat package cache (useful for faster reinstall) (default: false)--yesUninstall Chef Automate and destroy data without confirmation prompt
(default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate upgrade
chef-automate uninstall [flags]
See AlsoChef Automate CLIchef-automate upgrade
Usagechef-automate upgrade COMMAND [flags]
Flags-h, --helphelp for upgrade (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIRun an upgrade of Chef AutomateGet upgrade status of Chef Automatechef-automate upgrade run
chef-automate upgrade COMMAND [flags]
See AlsoChef Automate CLIRun an upgrade of Chef AutomateGet upgrade status of Chef Automatechef-automate upgrade run
Run an upgrade of Chef Automate
Usagechef-automate upgrade run [flags]
Flags--airgap-bundlePath to an airgap install bundle-y, --auto-approveDo not prompt for confirmation; accept defaults and continue (default: false)-h, --helphelp for run (default: false)--majorThis flag is only needed for major version upgrades (default: false)--os-dest-data-dirFlag for providing custom os destination data directory--saasFlag for saas setup (default: false)--skip-deploywill only upgrade and not deploy the bundle (default: false)--skip-storage-checkFlag for skipping disk space check during upgrade (default: false)--upgrade-airgap-bundlesUpdate Chef Automate both frontend and backend version to install
(default: false)--upgrade-backendsUpdate Chef Automate backends version to install (default: false)--upgrade-frontendsupgrade Chef Automate HA frontends version to install (default: false)--versionThe exact Chef Automate version to install-w, --workspace-upgradeDo not prompt for confirmation to accept workspace upgrade-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsoupgrade automate to the latest versionchef-automate upgrade status
chef-automate upgrade run [flags]
See Alsoupgrade automate to the latest versionchef-automate upgrade status
Get upgrade status of Chef Automate
Usagechef-automate upgrade status [flags]
Flags-h, --helphelp for status (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee Alsoupgrade automate to the latest versionchef-automate version
chef-automate upgrade status [flags]
See Alsoupgrade automate to the latest versionchef-automate version
Show the CLI version.
Usagechef-automate version [flags]
Flags--connection-timeoutMost time to wait to connect to service (default: 0s)--endpointThe endpoint the service is listening on-h, --helphelp for version (default: false)-v, --verboseShow additional version information (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIchef-automate workspace
chef-automate version [flags]
See AlsoChef Automate CLIchef-automate workspace
Set up Automate HA cluster workspace.
Usagechef-automate workspace [flags]
Flags-h, --helphelp for workspace (default: false)-d, --debugEnable debug output (default: false)--no-check-versionDisable version check (default: false)--result-jsonWrite command result as JSON to PATHSee AlsoChef Automate CLIError Codes
chef-automate workspace [flags]
See AlsoChef Automate CLIError Codes
If chef-automate
encounters an error during execution, it exits with a non-zero
error code. Here’s what our error codes mean:
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 |
Was this page helpful?