Automate CLI (Standalone)
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]
FlagsFlags 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
Related Commands
chef-automate COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Manage applications observability features | |
Chef Automate backup | |
Chef Automate Certificate Management | |
Chef Automate rotate cert | |
Chef Automate configuration | |
Deploy Chef Automate | |
Manage Chef Automate's external certificate | |
Gather system diagnostics and logs | |
Chef Automate iam commands | |
Info about Automate HA | |
Chef Automate infrastructure | |
Initialize default config | |
Initialize default config for Automate HA | |
Manage Chef Automate's internal certificate authority | |
Chef Automate license management | |
Put Chef Automate into or out of maintenance mode | |
Migrate from Chef Automate v1 | |
Watch the status of the migration to Chef Automate 2 | |
This command is used to add or delete HA nodes | |
Utilities for post-major-upgrade | |
Perform preflight check | |
Provision Automate HA infra. | |
restart deployment services | |
Set secrets to Automate HA | |
Retrieve the versions of the individual Chef Automate services | |
SSH into Automate HA servers | |
Start Chef Automate | |
Retrieve Chef Automate status | |
Stop deployment | |
Tail Chef Automate logs | |
Run Automate HA smoke tests | |
Uninstall Chef Automate | |
upgrade automate to the latest version | |
Show CLI version | |
Set workspace env for Automate HA. |
chef-automate airgap
Usagechef-automate airgap COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate airgap COMMAND [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 |
Related Commands
chef-automate airgap bundle
Usagechef-automate airgap bundle COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate airgap bundle COMMAND [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 |
Related Commands
chef-automate airgap bundle create
Usagechef-automate airgap bundle create [/path/to/bundle.aib] [flags]
FlagsFlags 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
Related Commands
chef-automate airgap bundle create [/path/to/bundle.aib] [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 |
Related Commands
| Commands | Description |
|---|---|
chef-automate airgap bundle info
Usagechef-automate airgap bundle info /path/to/bundle.aib [flags]
FlagsFlags 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
Related Commands
chef-automate airgap bundle info /path/to/bundle.aib [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 |
Related Commands
| Commands | Description |
|---|---|
chef-automate applications
Usagechef-automate applications COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate applications COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Remove services from the applications database | |
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.
Usagechef-automate applications remove-svcs [flags]
FlagsFlags 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
Related Commands
chef-automate applications remove-svcs [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 |
Related Commands
| Commands | Description |
|---|---|
Manage applications observability features |
chef-automate applications show-svcs
Display a list of the habitat services stored in the applications database.
Usagechef-automate applications show-svcs [flags]
FlagsFlags 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
Related Commands
chef-automate applications show-svcs [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 |
Related Commands
| Commands | Description |
|---|---|
Manage applications observability features |
chef-automate backup
Usagechef-automate backup COMMAND [flags]
FlagsFlags Description --gcs-credentials-path The path to the GCP service account json file -h, --help help for backup (default: false) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup COMMAND [flags]| Flags | Description |
|---|---|
--gcs-credentials-path | The path to the GCP service account json file |
-h, --help | help for backup (default: false) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
cancel the running backup operation | |
create a backup of Chef Automate | |
delete backups of Chef Automate | |
Ensure the hab user has the required permissions on the given path | |
Chef Automate shared object integrity | |
list all Chef Automate backups | |
restore a Chef Automate backup | |
show the Chef Automate backup details | |
show the Chef Automate backup runner status | |
Stream the Chef Automate backup runner status |
chef-automate backup cancel
Cancel the currently running backup create, delete, or restore operation
Usagechef-automate backup cancel [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup cancel [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-automate backup create
Create a backup of Chef Automate
Usagechef-automate backup create [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup create [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-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]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup delete ID [ID2 IDN...] [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-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]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup fix-repo-permissions PATH [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-automate backup integrity
Usagechef-automate backup integrity COMMAND [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup integrity COMMAND [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup | |
show the shared object integrity metadata | |
validate the shared object integrity |
chef-automate backup integrity show
Show the shared object integrity metadata
Usagechef-automate backup integrity show [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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)
Related Commands
chef-automate backup integrity show [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) |
--no-progress | Don't follow operation progress (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) |
Related Commands
| Commands | Description |
|---|---|
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
Usagechef-automate backup integrity validate [ID IDN] [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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)
Related Commands
chef-automate backup integrity validate [ID IDN] [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) |
--no-progress | Don't follow operation progress (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) |
Related Commands
| Commands | Description |
|---|---|
Chef Automate shared object integrity |
chef-automate backup list
List all Chef Automate backups
Usagechef-automate backup list [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup list [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
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.
Usagechef-automate backup restore [ID_OR_PATH] [flags]
FlagsFlags 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) -u, --upgrade Upgrade to the latest package versions when restoring backups
(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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup restore [ID_OR_PATH] [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) |
-u, --upgrade | Upgrade to the latest package versions when restoring backups
(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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-automate backup show
Show the details of a Chef Automate backup
Usagechef-automate backup show ID [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup show ID [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-automate backup status
Show the Chef Automate backup runner status
Usagechef-automate backup status [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup status [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-automate backup stream-status
Stream the Chef Automate backup runner status
Usagechef-automate backup stream-status [flags]
FlagsFlags 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) --no-progress Don't follow operation progress (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
Related Commands
chef-automate backup stream-status [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) |
--no-progress | Don't follow operation progress (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate backup |
chef-automate config
Usagechef-automate config COMMAND [flags]
FlagsFlags Description -y, --auto-approve Do not prompt for confirmation; accept defaults and continue (default: false) -h, --help help for config (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
Related Commands
chef-automate config COMMAND [flags]| Flags | Description |
|---|---|
-y, --auto-approve | Do not prompt for confirmation; accept defaults and continue (default: false) |
-h, --help | help for config (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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
patch the Chef Automate configuration | |
set the Chef Automate configuration | |
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.
Usagechef-automate config patch path/to/config.toml [flags]
FlagsFlags Description -h, --help help for patch (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 -t, --timeout Request timeout in seconds (default: 10)
Related Commands
chef-automate config patch path/to/config.toml [flags]| Flags | Description |
|---|---|
-h, --help | help for patch (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 |
-t, --timeout | Request timeout in seconds (default: 10) |
Related Commands
| Commands | Description |
|---|---|
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.
Usagechef-automate config set path/to/config.toml [flags]
FlagsFlags Description -h, --help help for set (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 -t, --timeout Request timeout in seconds (default: 10)
Related Commands
chef-automate config set path/to/config.toml [flags]| Flags | Description |
|---|---|
-h, --help | help for set (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 |
-t, --timeout | Request timeout in seconds (default: 10) |
Related Commands
| Commands | Description |
|---|---|
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
Usagechef-automate config show [/path/to/write/config.toml] [flags]
FlagsFlags Description -h, --help help for show (default: false) -O, --overwrite Overwrite existing config.toml [Standalone] (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 -t, --timeout Request timeout in seconds (default: 10)
Related Commands
chef-automate config show [/path/to/write/config.toml] [flags]
| Flags | Description |
|---|---|
-h, --help | help for show (default: false) |
-O, --overwrite | Overwrite existing config.toml [Standalone] (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 |
-t, --timeout | Request timeout in seconds (default: 10) |
Related Commands
| Commands | Description |
|---|---|
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
Usagechef-automate deploy [/path/to/config.toml] [flags]
FlagsFlags 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 --certificate The path to a certificate that should be used for external TLS connections (web and API). --channel Release channel to deploy all services from --fqdn The fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine) -h, --help help for deploy (default: false) --private-key The path to a private key corresponding to the TLS certificate. --product Product to deploy (default: []) --skip-preflight Deploy regardless of pre-flight conditions (default: false) --upgrade-strategy Upgrade strategy to use for this deployment. (default: at-once) -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
Related Commands
chef-automate deploy [/path/to/config.toml] [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 |
--certificate | The path to a certificate that should be used for external TLS connections (web and API). |
--channel | Release channel to deploy all services from |
--fqdn | The fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine) |
-h, --help | help for deploy (default: false) |
--private-key | The path to a private key corresponding to the TLS certificate. |
--product | Product to deploy (default: []) |
--skip-preflight | Deploy regardless of pre-flight conditions (default: false) |
--upgrade-strategy | Upgrade strategy to use for this deployment. (default: at-once) |
-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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate external-cert
Manage Chef Automate's external certificate authority. Used for establishing TLS/SSL communication with automate.
Usagechef-automate external-cert COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate external-cert COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Show 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]
FlagsFlags 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
Related Commands
chef-automate external-cert show [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 |
Related Commands
| Commands | Description |
|---|---|
Manage Chef Automate's external certificate |
chef-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]
FlagsFlags 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
Related Commands
chef-automate gather-logs [/path/to/log/bundle.tar.gz] [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate iam
Usagechef-automate iam COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate iam COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Manage and restore default admin access | |
Manage tokens | |
Retrieve IAM version in use |
chef-automate iam admin-access
Usagechef-automate iam admin-access COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate iam admin-access COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate iam commands | |
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
Usagechef-automate iam admin-access restore PASSWORD [flags]
FlagsFlags 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
Related Commands
chef-automate iam admin-access restore PASSWORD [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 |
Related Commands
| Commands | Description |
|---|---|
Manage and restore default admin access |
chef-automate iam token
Usagechef-automate iam token COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate iam token COMMAND [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 |
Related Commands
chef-automate iam token create
Usagechef-automate iam token create NAME [flags]
FlagsFlags 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
Related Commands
chef-automate iam token create NAME [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 |
Related Commands
| Commands | Description |
|---|---|
Manage tokens |
chef-automate iam version
Usagechef-automate iam version [flags]
FlagsFlags 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
Related Commands
chef-automate iam version [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate iam commands |
chef-automate infrastructure
Commands for automation infrastructure management, for data related to chef-client runs and chef-server actions.
Usagechef-automate infrastructure COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate infrastructure COMMAND [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 |
Related Commands
chef-automate infrastructure node-delete
Usagechef-automate infrastructure node-delete [uuid] [flags]
FlagsFlags 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
Related Commands
chef-automate infrastructure node-delete [uuid] [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate infrastructure |
chef-automate init-config
Initialize default configuration and save it to a file.
Usagechef-automate init-config [flags]
FlagsFlags Description --certificate The path to a certificate that should be used for external TLS connections (web and API). --channel Release channel to deploy all services from (default: current) --es-mem The amount of system memory to allocate to Elasticsearch's heap. (default: 25% of system memory) --file File path to write the config (default: config.toml) --fqdn The fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine) -h, --help help for init-config (default: false) --os-mem The amount of system memory to allocate to Opensearch's heap. (default: 25% of system memory) --private-key The path to a private key corresponding to the TLS certificate. --upgrade-strategy Upgrade strategy to use for this deployment. (default: at-once) -d, --debug Enable debug output (default: false) --no-check-version Disable version check (default: false) --result-json Write command result as JSON to PATH
Related Commands
chef-automate init-config [flags]| Flags | Description |
|---|---|
--certificate | The path to a certificate that should be used for external TLS connections (web and API). |
--channel | Release channel to deploy all services from (default: current) |
--es-mem | The amount of system memory to allocate to Elasticsearch's heap. (default: 25% of system memory) |
--file | File path to write the config (default: config.toml) |
--fqdn | The fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine) |
-h, --help | help for init-config (default: false) |
--os-mem | The amount of system memory to allocate to Opensearch's heap. (default: 25% of system memory) |
--private-key | The path to a private key corresponding to the TLS certificate. |
--upgrade-strategy | Upgrade strategy to use for this deployment. (default: at-once) |
-d, --debug | Enable debug output (default: false) |
--no-check-version | Disable version check (default: false) |
--result-json | Write command result as JSON to PATH |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate internal-ca
Manage Chef Automate's internal certificate authority. Used for inter-service encryption and authentication.
Usagechef-automate internal-ca COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate internal-ca COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Print information the root certificate for the internal certificate authority | |
Commands to regenerate certificates issued by the internal certificate authority |
chef-automate internal-ca info
Usagechef-automate internal-ca info [flags]
FlagsFlags 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
Related Commands
chef-automate internal-ca info [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 |
Related Commands
| Commands | Description |
|---|---|
Manage Chef Automate's internal certificate authority |
chef-automate internal-ca regenerate
Usagechef-automate internal-ca regenerate [flags]
FlagsFlags 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
Related Commands
chef-automate internal-ca regenerate [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 |
Related Commands
| Commands | Description |
|---|---|
Manage Chef Automate's internal certificate authority | |
Regenerate the root certificate for the internal certificate authority |
chef-automate internal-ca regenerate root
Usagechef-automate internal-ca regenerate root [flags]
FlagsFlags 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
Related Commands
chef-automate internal-ca regenerate root [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 |
Related Commands
| Commands | Description |
|---|---|
Commands to regenerate certificates issued by the internal certificate authority |
chef-automate license
Usagechef-automate license COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate license COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Apply Chef Automate license | |
Generates the unique count of reported Compliance scans on hourly basis between the time duration | |
Generates daily Compliance scan reports for a span of time duration | |
Generates daily Infra Client Run reports for a span of time duration | |
Retrieve Chef Automate license status | |
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
Usagechef-automate license apply LICENSE [flags]
FlagsFlags 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
Related Commands
chef-automate license apply LICENSE [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate license management |
chef-automate license complianceResourceRunCount
Usagechef-automate license complianceResourceRunCount [flags]
FlagsFlags 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
Related Commands
chef-automate license complianceResourceRunCount [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate license management |
chef-automate license complianceResourceRunReport
Usagechef-automate license complianceResourceRunReport [flags]
FlagsFlags 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
Related Commands
chef-automate license complianceResourceRunReport [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate license management |
chef-automate license nodeRunReport
Usagechef-automate license nodeRunReport [flags]
FlagsFlags 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
Related Commands
chef-automate license nodeRunReport [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate license management |
chef-automate license status
Usagechef-automate license status [flags]
FlagsFlags 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
Related Commands
chef-automate license status [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate license management |
chef-automate license uniqNodeRunReport
Usagechef-automate license uniqNodeRunReport [flags]
FlagsFlags 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
Related Commands
chef-automate license uniqNodeRunReport [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 |
Related Commands
| Commands | Description |
|---|---|
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.
Usagechef-automate maintenance [on|off] [flags]
FlagsFlags 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
Related Commands
chef-automate maintenance [on|off] [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-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]
FlagsFlags Description --airgap-bundle Path to an airgap install bundle --channel Optional channel to use when installing packages from the depot --chef-server-running Path to chef-server-running.json (default: /etc/opscode/chef-server-running.json) -c, --config Path to an automate-deploy.toml -r, --delivery-running Path to delivery-running.json (default: /etc/delivery/delivery-running.json) -s, --delivery-secrets Path to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json) --enable-chef-server Enable integrated Chef Server migration and deployment; only valid for all-in-one topology
(default: false) --file-move-timeout Optional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
(default: 0) -h, --help help for migrate-from-v1 (default: false) --postgres-dump-wait-seconds Optional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
(default: 0) --postgres-restore-wait-seconds Optional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
(default: 0) --skip-backup Optionally skip backup of your Chef Automate v1 installation (default = false)
(default: false) --skip-backup-check Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false) --skip-disaster-recovery-check Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false) --skip-external-es-check Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false) --skip-fips-check Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false) --skip-preflight Deploy regardless of pre-flight conditions (default: false) --skip-saml-check Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false) --skip-workflow-check Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false) --upgrade-strategy Optional upgrade strategy to use when configuring the deployment service -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
Related Commands
chef-automate migrate-from-v1 [/path/to/automate-deploy.toml] [flags]
| Flags | Description |
|---|---|
--airgap-bundle | Path to an airgap install bundle |
--channel | Optional channel to use when installing packages from the depot |
--chef-server-running | Path to chef-server-running.json (default: /etc/opscode/chef-server-running.json) |
-c, --config | Path to an automate-deploy.toml |
-r, --delivery-running | Path to delivery-running.json (default: /etc/delivery/delivery-running.json) |
-s, --delivery-secrets | Path to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json) |
--enable-chef-server | Enable integrated Chef Server migration and deployment; only valid for all-in-one topology
(default: false) |
--file-move-timeout | Optional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
(default: 0) |
-h, --help | help for migrate-from-v1 (default: false) |
--postgres-dump-wait-seconds | Optional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
(default: 0) |
--postgres-restore-wait-seconds | Optional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
(default: 0) |
--skip-backup | Optionally skip backup of your Chef Automate v1 installation (default = false)
(default: false) |
--skip-backup-check | Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false) |
--skip-disaster-recovery-check | Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false) |
--skip-external-es-check | Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false) |
--skip-fips-check | Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false) |
--skip-preflight | Deploy regardless of pre-flight conditions (default: false) |
--skip-saml-check | Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false) |
--skip-workflow-check | Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false) |
--upgrade-strategy | Optional upgrade strategy to use when configuring the deployment service |
-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 |
Related Commands
chef-automate migrate-from-v1-status
Usagechef-automate migrate-from-v1-status [flags]
FlagsFlags Description -h, --help help for migrate-from-v1-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
Related Commands
chef-automate migrate-from-v1-status [flags]| Flags | Description |
|---|---|
-h, --help | help for migrate-from-v1-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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-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]
FlagsFlags Description -h, --help help for gen-config (default: false) -o, --out Output file (default: ./automate-migrate.toml) --airgap-bundle Path to an airgap install bundle --channel Optional channel to use when installing packages from the depot --chef-server-running Path to chef-server-running.json (default: /etc/opscode/chef-server-running.json) -c, --config Path to an automate-deploy.toml -d, --debug Enable debug output (default: false) -r, --delivery-running Path to delivery-running.json (default: /etc/delivery/delivery-running.json) -s, --delivery-secrets Path to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json) --enable-chef-server Enable integrated Chef Server migration and deployment; only valid for all-in-one topology
(default: false) --file-move-timeout Optional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
(default: 0) --no-check-version Disable version check (default: false) --postgres-dump-wait-seconds Optional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
(default: 0) --postgres-restore-wait-seconds Optional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
(default: 0) --result-json Write command result as JSON to PATH --skip-backup Optionally skip backup of your Chef Automate v1 installation (default = false)
(default: false) --skip-backup-check Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false) --skip-disaster-recovery-check Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false) --skip-external-es-check Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false) --skip-fips-check Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false) --skip-preflight Deploy regardless of pre-flight conditions (default: false) --skip-saml-check Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false) --skip-workflow-check Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false) --upgrade-strategy Optional upgrade strategy to use when configuring the deployment service -y, --yes Do not prompt for confirmation; accept defaults and continue (default: false)
Related Commands
chef-automate migrate-from-v1 gen-config [flags]| Flags | Description |
|---|---|
-h, --help | help for gen-config (default: false) |
-o, --out | Output file (default: ./automate-migrate.toml) |
--airgap-bundle | Path to an airgap install bundle |
--channel | Optional channel to use when installing packages from the depot |
--chef-server-running | Path to chef-server-running.json (default: /etc/opscode/chef-server-running.json) |
-c, --config | Path to an automate-deploy.toml |
-d, --debug | Enable debug output (default: false) |
-r, --delivery-running | Path to delivery-running.json (default: /etc/delivery/delivery-running.json) |
-s, --delivery-secrets | Path to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json) |
--enable-chef-server | Enable integrated Chef Server migration and deployment; only valid for all-in-one topology
(default: false) |
--file-move-timeout | Optional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
(default: 0) |
--no-check-version | Disable version check (default: false) |
--postgres-dump-wait-seconds | Optional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
(default: 0) |
--postgres-restore-wait-seconds | Optional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
(default: 0) |
--result-json | Write command result as JSON to PATH |
--skip-backup | Optionally skip backup of your Chef Automate v1 installation (default = false)
(default: false) |
--skip-backup-check | Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false) |
--skip-disaster-recovery-check | Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false) |
--skip-external-es-check | Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false) |
--skip-fips-check | Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false) |
--skip-preflight | Deploy regardless of pre-flight conditions (default: false) |
--skip-saml-check | Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false) |
--skip-workflow-check | Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false) |
--upgrade-strategy | Optional upgrade strategy to use when configuring the deployment service |
-y, --yes | Do not prompt for confirmation; accept defaults and continue (default: false) |
Related Commands
| Commands | Description |
|---|---|
Migrate from Chef Automate v1 |
chef-automate post-major-upgrade
Usagechef-automate post-major-upgrade COMMAND [flags]
FlagsFlags Description -h, --help help for post-major-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
Related Commands
chef-automate post-major-upgrade COMMAND [flags]| Flags | Description |
|---|---|
-h, --help | help for post-major-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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Chef Automate post-major-upgrade clear-data | |
Chef Automate post-major-upgrade migrate |
chef-automate post-major-upgrade clear-data
Chef Automate post-major-upgrade to clear old pg data
Usagechef-automate post-major-upgrade clear-data [flags]
FlagsFlags Description -y, -- auto-accept (default: false) --data data -f, --force fore-execute (default: false) -h, --help help for clear-data (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
Related Commands
chef-automate post-major-upgrade clear-data [flags]| Flags | Description |
|---|---|
-y, -- | auto-accept (default: false) |
--data | data |
-f, --force | fore-execute (default: false) |
-h, --help | help for clear-data (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 |
Related Commands
| Commands | Description |
|---|---|
Utilities for post-major-upgrade |
chef-automate post-major-upgrade migrate
Chef Automate migrate. migrate can be used to migrate pg or migrate es
Usagechef-automate post-major-upgrade migrate [flags]
FlagsFlags Description -y, -- auto-accept (default: false) --check check (default: false) --data data -f, --force force-execute (default: false) -h, --help help for migrate (default: false) --skip-migration permanently skiping migration (default: false) -s, --skip-storage-check skip storage check (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
Related Commands
chef-automate post-major-upgrade migrate [flags]| Flags | Description |
|---|---|
-y, -- | auto-accept (default: false) |
--check | check (default: false) |
--data | data |
-f, --force | force-execute (default: false) |
-h, --help | help for migrate (default: false) |
--skip-migration | permanently skiping migration (default: false) |
-s, --skip-storage-check | skip storage check (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 |
Related Commands
| Commands | Description |
|---|---|
Utilities for post-major-upgrade |
chef-automate preflight-check
Perform preflight check to verify host meets installation criteria.
Usagechef-automate preflight-check [flags]
FlagsFlags 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
Related Commands
chef-automate preflight-check [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Run preflight checks specific to migrating from Chef Automate v1 |
chef-automate preflight-check migrate-from-v1
Usagechef-automate preflight-check migrate-from-v1 [flags]
FlagsFlags Description -r, --delivery-running Path to delivery-running.json (default: /etc/delivery/delivery-running.json) -s, --delivery-secrets Path to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json) -h, --help help for migrate-from-v1 (default: false) --skip-backup-check Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false) --skip-disaster-recovery-check Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false) --skip-external-es-check Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false) --skip-fips-check Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false) --skip-saml-check Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false) --skip-workflow-check Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false) --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) -d, --debug Enable debug output (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) --no-check-version Disable version check (default: false) --node Pass this flag to run pre-flight check on a perticular node node(HA) --result-json Write command result as JSON to PATH
Related Commands
chef-automate preflight-check migrate-from-v1 [flags]| Flags | Description |
|---|---|
-r, --delivery-running | Path to delivery-running.json (default: /etc/delivery/delivery-running.json) |
-s, --delivery-secrets | Path to delivery-secrets.json (default: /etc/delivery/delivery-secrets.json) |
-h, --help | help for migrate-from-v1 (default: false) |
--skip-backup-check | Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
(default: false) |
--skip-disaster-recovery-check | Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
(default: false) |
--skip-external-es-check | Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
(default: false) |
--skip-fips-check | Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
(default: false) |
--skip-saml-check | Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
(default: false) |
--skip-workflow-check | Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
(default: false) |
--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) |
-d, --debug | Enable debug output (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) |
--no-check-version | Disable version check (default: false) |
--node | Pass this flag to run pre-flight check on a perticular node node(HA) |
--result-json | Write command result as JSON to PATH |
Related Commands
| Commands | Description |
|---|---|
Perform preflight check |
chef-automate restart-services
Restart services for a deployment
Usagechef-automate restart-services [flags]
FlagsFlags Description --a2 restart chef automate service on automate nodes[DUPLICATE] (default: false) --cs restart chef automate service on chef-server nodes[DUPLICATE]
(default: false) -h, --help help for restart-services (default: false) --os restart hab-sup service on opensearch nodes[DUPLICATE] (default: false) -p, --postgresql restart 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
Related Commands
chef-automate restart-services [flags]| Flags | Description |
|---|---|
--a2 | restart chef automate service on automate nodes[DUPLICATE] (default: false) |
--cs | restart chef automate service on chef-server nodes[DUPLICATE]
(default: false) |
-h, --help | help for restart-services (default: false) |
--os | restart hab-sup service on opensearch nodes[DUPLICATE] (default: false) |
-p, --postgresql | restart 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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate service-versions
Retrieve the versions of the individual Chef Automate services
Usagechef-automate service-versions [flags]
FlagsFlags 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
Related Commands
chef-automate service-versions [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate start
Usagechef-automate start [flags]
FlagsFlags 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
Related Commands
chef-automate start [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate status
Retrieve Chef Automate status. Includes status of Automate services.
Usagechef-automate status [flags]
FlagsFlags Description -h, --help help for status (default: false) -w, --wait-for-healthy Wait until the status response is healthy or the timeout is reached
(default: false) -r, --wait-refresh-interval How many seconds to wait between polling for status updates (default: 2) -t, --wait-timeout How many seconds to wait for the status to be healthy before returning an error
(default: 600) -d, --debug Enable debug output (default: false) --no-check-version Disable version check (default: false) --result-json Write command result as JSON to PATH
Related Commands
chef-automate status [flags]| Flags | Description |
|---|---|
-h, --help | help for status (default: false) |
-w, --wait-for-healthy | Wait until the status response is healthy or the timeout is reached
(default: false) |
-r, --wait-refresh-interval | How many seconds to wait between polling for status updates (default: 2) |
-t, --wait-timeout | How many seconds to wait for the status to be healthy before returning an error
(default: 600) |
-d, --debug | Enable debug output (default: false) |
--no-check-version | Disable version check (default: false) |
--result-json | Write command result as JSON to PATH |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Retrieve Chef Automate status-summary |
chef-automate status summary
Retrieve Chef Automate status node summary for HA deployment
Usagechef-automate status summary [flags]
FlagsFlags Description -h, --help help for summary (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
Related Commands
chef-automate status summary [flags]| Flags | Description |
|---|---|
-h, --help | help for summary (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 |
Related Commands
| Commands | Description |
|---|---|
Retrieve Chef Automate status |
chef-automate stop
Stop a running deployment of Automate.
Usagechef-automate stop [flags]
FlagsFlags 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
Related Commands
chef-automate stop [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate system-logs
Start streaming logs from the Chef Automate server. Ctrl + c to stop.
Usagechef-automate system-logs [flags]
FlagsFlags 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
Related Commands
chef-automate system-logs [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate uninstall
Uninstall Chef Automate, deleting all data and configuration
Usagechef-automate uninstall [flags]
FlagsFlags Description -h, --help help for uninstall (default: false) --preserve-package-cache Preserve Habitat package cache (useful for faster reinstall) (default: false) --yes Uninstall Chef Automate and destroy data without 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
Related Commands
chef-automate uninstall [flags]| Flags | Description |
|---|---|
-h, --help | help for uninstall (default: false) |
--preserve-package-cache | Preserve Habitat package cache (useful for faster reinstall) (default: false) |
--yes | Uninstall Chef Automate and destroy data without 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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI |
chef-automate upgrade
Usagechef-automate upgrade COMMAND [flags]
FlagsFlags 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
Related Commands
chef-automate upgrade COMMAND [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 |
Related Commands
| Commands | Description |
|---|---|
Chef Automate CLI | |
Run an upgrade of Chef Automate | |
Get upgrade status of Chef Automate |
chef-automate upgrade run
Run an upgrade of Chef Automate
Usagechef-automate upgrade run [flags]
FlagsFlags Description --airgap-bundle Path to an airgap install bundle -h, --help help for run (default: false) --major This flag is only needed for major version upgrades (default: false) --os-dest-data-dir Flag for providing custom os destination data directory --skip-storage-check Flag for skipping disk space check during upgrade (default: false) --version The exact Chef Automate version to install -d, --debug Enable debug output (default: false) --no-check-version Disable version check (default: false) --result-json Write command result as JSON to PATH
Related Commands
chef-automate upgrade run [flags]| Flags | Description |
|---|---|
--airgap-bundle | Path to an airgap install bundle |
-h, --help | help for run (default: false) |
--major | This flag is only needed for major version upgrades (default: false) |
--os-dest-data-dir | Flag for providing custom os destination data directory |
--skip-storage-check | Flag for skipping disk space check during upgrade (default: false) |
--version | The exact Chef Automate version to install |
-d, --debug | Enable debug output (default: false) |
--no-check-version | Disable version check (default: false) |
--result-json | Write command result as JSON to PATH |
Related Commands
| Commands | Description |
|---|---|
upgrade automate to the latest version |
chef-automate upgrade status
Get upgrade status of Chef Automate
Usagechef-automate upgrade status [flags]
FlagsFlags 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
Related Commands
chef-automate upgrade status [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 |
Related Commands
| Commands | Description |
|---|---|
upgrade automate to the latest version |
chef-automate version
Show the CLI version.
Usagechef-automate version [flags]
FlagsFlags Description --a2 Get only automate Status (default: false) --cs Get only chef server Status (default: false) -h, --help help for version (default: false) --os Get only opensearch Status (default: false) --pg Get only postgresql Status (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
Related Commands
chef-automate version [flags]| Flags | Description |
|---|---|
--a2 | Get only automate Status (default: false) |
--cs | Get only chef server Status (default: false) |
-h, --help | help for version (default: false) |
--os | Get only opensearch Status (default: false) |
--pg | Get only postgresql Status (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 |
Related Commands
| Commands | Description |
|---|---|
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:
| 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 |
| 124 | ConfigVerifyError | Config Verification failed |
| 125 | VerifyChecksError | Verify Checks failed |