Skip to main content

Chef Automate CLI

chef-automate CLI Commands

chef-automate

A helpful utility to deploy and manage Chef Automate.

Docs: https://docs.chef.io/automate/cli_chef_automate/ Patents: https://www.chef.io/patents

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
-h
--help
help for chef-automate
Default value: false
--no-check-version
Disable version check
Default value: false
--result-json
Write command result as JSON to PATH

chef-automate airgap

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate airgap COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
-h
--help
help for airgap
Default value: false
--no-check-version
Disable version check
Default value: false
--result-json
Write command result as JSON to PATH

Related Commands

chef-automate airgap bundle

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate airgap bundle COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
-h
--help
help for bundle
Default value: false
--no-check-version
Disable version check
Default value: false
--result-json
Write command result as JSON to PATH

Related Commands

chef-automate airgap bundle create

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

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

Flags

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

Related Commands

chef-automate airgap bundle info

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

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

Flags

-d
--debug
Enable debug output
Default value: false
-h
--help
help for info
Default value: false
--no-check-version
Disable version check
Default value: false
--result-json
Write command result as JSON to PATH
--verbose
Output full AIB metadata
Default value: false

Related Commands

chef-automate applications

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate applications COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
-h
--help
help for applications
Default value: false
--no-check-version
Disable version check
Default value: false
--result-json
Write command result as JSON to PATH

Related Commands

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.

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate applications remove-svcs [flags]

Flags

--all
Delete all services in the database. This flag must be given if no other filter is given.
Default value: 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
--debug
Enable debug output
Default value: false
-D
--disconnected
Select only services that are disconnected
Default value: 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 value: false
--no-check-version
Disable version check
Default value: false
-o
--origin
Select only services where the origin matches the given pattern
--result-json
Write command result as JSON to PATH
-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 value: false

Related Commands

chef-automate applications show-svcs

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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate applications show-svcs [flags]

Flags

-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
--debug
Enable debug output
Default value: false
-D
--disconnected
Select only services that are disconnected
Default value: 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 value: false
--no-check-version
Disable version check
Default value: false
-o
--origin
Select only services where the origin matches the given pattern
--result-json
Write command result as JSON to PATH
-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

Related Commands

chef-automate backup

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for backup
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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

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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup cancel [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for cancel
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup create

Create a backup of Chef Automate

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup create [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for create
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 43200

Related Commands

chef-automate backup delete

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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

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

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for delete
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 43200
--yes
Agree to all prompts
Default value: false

Related Commands

chef-automate backup fix-repo-permissions

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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

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

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for fix-repo-permissions
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup integrity COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for integrity
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup integrity show

Show the shared object integrity metadata

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup integrity show [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for show
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup integrity validate

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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

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

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for validate
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup list

List all Chef Automate backups

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup list [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for list
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup restore

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

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup restore [ID_OR_PATH] [flags]

Flags

--airgap-bundle
The artifact to use for an air-gapped installation
-b
--backup-dir
Directory used for backups
Default value: /var/opt/chef-automate/backups
-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for restore
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
--patch-config
Path to patch config if required
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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
--sha256
The SHA256 checksum of the backup
--skip-preflight
Skip preflight checks when restoring a backup
Default value: false
-u
--upgrade
Upgrade to the latest package versions when restoring backups
Flag only available on standalone Chef Automate deployments.
Default value: false
-t
--wait-timeout
How long to wait for a operation to complete before raising an error
Default value: 43200
--yes
Agree to all prompts
Default value: false

Related Commands

chef-automate backup show

Show the details of a Chef Automate backup

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup show ID [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for show
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup status

Show the Chef Automate backup runner status

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate backup status [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for status
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 value: 60

Related Commands

chef-automate backup stream-status

Stream the Chef Automate backup runner status

Supported on

Command available on standalone and high availability Chef Automate deployments.

In high availability Chef Automate deployments, this command is only supported on Chef Automate nodes.

Usage

chef-automate backup stream-status [flags]

Flags

-d
--debug
Enable debug output
Default value: false
--gcs-credentials-path
The path to the GCP service account json file
-h
--help
help for stream-status
Default value: false
--no-check-version
Disable version check
Default value: false
--no-progress
Don't follow operation progress
Flag only available on standalone Chef Automate deployments.
Default value: false
-r
--request-timeout
API request timeout for deployment-service in seconds
Default value: 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 cert

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

Supported on

Command available on Chef Automate high availability deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate cert COMMAND [flags]

Flags

-d
--debug
Enable debug output
Default value: false
-h
--help
help for cert
Default value: false
--no-check-version
Disable version check
Default value: false
--result-json
Write command result as JSON to PATH

Related Commands

chef-automate cert-rotate

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

Supported on

Command available on Chef Automate high availability deployments.

In high availability Chef Automate deployments, this command is supported on the bastion host.

Usage

chef-automate cert-rotate [flags]

Flags

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

Related Commands

    chef-automate cert show

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

    Supported on

    Command available on Chef Automate high availability deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

    chef-automate cert show [flags]

    Flags

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

    Related Commands

    chef-automate config

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

    chef-automate config COMMAND [flags]

    Flags

    -y
    --auto-approve
    Do not prompt for confirmation; accept defaults and continue
    Default value: false
    -d
    --debug
    Enable debug output
    Default value: false
    -h
    --help
    help for config
    Default value: false
    --no-check-version
    Disable version check
    Default value: false
    --result-json
    Write command result as JSON to PATH
    -t
    --timeout
    Request timeout in seconds
    Flag only available on standalone Chef Automate deployments.
    Default value: 10

    Related Commands

    chef-automate config gen

    Prompt based Config Generation command. It will output the config in the provided file, if file path is not provided then it will print on STDOUT.

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

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

    Flags

    -y
    --auto-approve
    Do not prompt for confirmation; accept defaults and continue
    Default value: false
    -d
    --debug
    Enable debug output
    Default value: false
    -h
    --help
    help for gen
    Default value: false
    --no-check-version
    Disable version check
    Default value: false
    -O
    --overwrite
    Overwrite existing config.toml
    Default value: false
    --result-json
    Write command result as JSON to PATH
    -t
    --timeout
    Request timeout in seconds
    Flag only available on standalone Chef Automate deployments.
    Default value: 10

    Related Commands

    chef-automate config oc-id-show-app

    Get the details of the oauth applications registered with OC-ID

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

    chef-automate config oc-id-show-app [flags]

    Flags

    -y
    --auto-approve
    Do not prompt for confirmation; accept defaults and continue
    Default value: false
    -d
    --debug
    Enable debug output
    Default value: false
    -h
    --help
    help for oc-id-show-app
    Default value: false
    --no-check-version
    Disable version check
    Default value: false
    --result-json
    Write command result as JSON to PATH
    -t
    --timeout
    Request timeout in seconds
    Flag only available on standalone Chef Automate deployments.
    Default value: 10
    --wait-timeout
    This flag sets the operation timeout duration (in seconds) for each individual node during the config oc-id-show-app process
    Flag only available on standalone Chef Automate deployments.
    Default value: 180

    Related Commands

    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.

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

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

    Flags

    --a2
    Patch toml configuration to the automate node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -y
    --auto-approve
    Do not prompt for confirmation; accept defaults and continue
    Default value: false
    -a
    --automate
    Patch toml configuration to the automate node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -c
    --chef_server
    Patch toml configuration to the chef_server node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --cs
    Patch toml configuration to the chef_server node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -d
    --debug
    Enable debug output
    Default value: false
    --fe
    Patch toml configuration to the all frontend nodes[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -f
    --frontend
    Patch toml configuration to the all frontend nodes
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -h
    --help
    help for patch
    Default value: false
    --no-check-version
    Disable version check
    Default value: false
    -o
    --opensearch
    Patch toml configuration to the opensearch node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --os
    Patch toml configuration to the opensearch node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --pg
    Patch toml configuration to the postgresql node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -p
    --postgresql
    Patch toml configuration to the postgresql node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --result-json
    Write command result as JSON to PATH
    -t
    --timeout
    Request timeout in seconds
    Flag only available on standalone Chef Automate deployments.
    Default value: 10
    --wait-timeout
    This flag sets the operation timeout duration (in seconds) for each individual node during the config patch process
    Flag only available on high availability Chef Automate deployments.
    Default value: 180

    Related Commands

    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.

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

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

    Flags

    --a2
    Set toml configuration to the automate node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -y
    --auto-approve
    Do not prompt for confirmation; accept defaults and continue
    Default value: false
    -a
    --automate
    Set toml configuration to the automate node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -c
    --chef_server
    Set toml configuration to the chef_server node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --cs
    Set toml configuration to the chef_server node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -d
    --debug
    Enable debug output
    Default value: false
    -h
    --help
    help for set
    Default value: false
    --no-check-version
    Disable version check
    Default value: false
    -o
    --opensearch
    Set toml configuration to the opensearch node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --os
    Set toml configuration to the opensearch node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --pg
    Set toml configuration to the postgresql node[DUPLICATE]
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    -p
    --postgresql
    Set toml configuration to the postgresql node
    Flag only available on high availability Chef Automate deployments.
    Default value: false
    --result-json
    Write command result as JSON to PATH
    -t
    --timeout
    Request timeout in seconds
    Flag only available on standalone Chef Automate deployments.
    Default value: 10

    Related Commands

    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

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

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

    Flags

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

    Related Commands

    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

    Supported on

    Command available on standalone and high availability Chef Automate deployments.

    In high availability Chef Automate deployments, this command is supported on the bastion host.

    Usage

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

    Flags

    --accept-terms-and-mlsa
    Agree to the Chef Software Terms of Service and the Master License and Services Agreement
    Default value: 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).
    Flag only available on standalone Chef Automate deployments.
    --channel
    Release channel to deploy all services from
    Flag only available on standalone Chef Automate deployments.
    -d
    --debug
    Enable debug output
    Default value: false
    --fqdn
    The fully-qualified domain name that Chef Automate can be accessed at. (default: hostname of this machine)
    Flag only available on standalone Chef Automate deployments.
    -h
    --help
    help for deploy
    Default value: false
    --no-check-version
    Disable version check
    Default value: false
    --private-key
    The path to a private key corresponding to the TLS certificate.
    Flag only available on standalone Chef Automate deployments.
    --product
    Product to deploy
    Flag only available on standalone Chef Automate deployments.
    Default value: []
    --result-json
    Write command result as JSON to PATH
    --skip-preflight
    Deploy regardless of pre-flight conditions
    Flag only available on standalone Chef Automate deployments.
    Default value: false
    --skip-verify
    Flag for skipping config verification check
    Default value: false
    --upgrade-strategy
    Upgrade strategy to use for this deployment.
    Flag only available on standalone Chef Automate deployments.
    Default value: at-once
    -y
    --yes
    Do not prompt for confirmation; accept defaults and continue
    Default value: false

    Related Commands

      chef-automate external-cert

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

      Supported on

      Command available on standalone and high availability Chef Automate deployments.

      In high availability Chef Automate deployments, this command is only supported on Chef Automate and Chef Infra Server frontend nodes.

      Usage

      chef-automate external-cert COMMAND [flags]

      Flags

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

      Related Commands

      chef-automate external-cert show

      Supported on

      Command available on standalone and high availability Chef Automate deployments.

      In high availability Chef Automate deployments, this command is only supported on Chef Automate and Chef Infra Server frontend nodes.

      Usage

      chef-automate external-cert show [flags]

      Flags

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

      Related Commands

      chef-automate gather-logs

      Collect system diagnostics and logs from Chef Automate and other services

      Supported on

      Command available on standalone and high availability Chef Automate deployments.

      In high availability Chef Automate deployments, this command is supported on the bastion host.

      Usage

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

      Flags

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

      Related Commands

        chef-automate iam

        Supported on

        Command available on standalone and high availability Chef Automate deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

        chef-automate iam COMMAND [flags]

        Flags

        -d
        --debug
        Enable debug output
        Default value: false
        -h
        --help
        help for iam
        Default value: false
        --no-check-version
        Disable version check
        Default value: false
        --result-json
        Write command result as JSON to PATH

        Related Commands

        chef-automate iam admin-access

        Supported on

        Command available on standalone and high availability Chef Automate deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

        chef-automate iam admin-access COMMAND [flags]

        Flags

        -d
        --debug
        Enable debug output
        Default value: false
        -h
        --help
        help for admin-access
        Default value: false
        --no-check-version
        Disable version check
        Default value: false
        --result-json
        Write command result as JSON to PATH

        Related Commands

        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

        Supported on

        Command available on standalone and high availability Chef Automate deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

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

        Flags

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

        Related Commands

        chef-automate iam token

        Supported on

        Command available on standalone and high availability Chef Automate deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

        chef-automate iam token COMMAND [flags]

        Flags

        -d
        --debug
        Enable debug output
        Default value: false
        -h
        --help
        help for token
        Default value: false
        --no-check-version
        Disable version check
        Default value: false
        --result-json
        Write command result as JSON to PATH

        Related Commands

        chef-automate iam token create

        Supported on

        Command available on standalone and high availability Chef Automate deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

        chef-automate iam token create NAME [flags]

        Flags

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

        Related Commands

        chef-automate iam version

        Supported on

        Command available on standalone and high availability Chef Automate deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

        chef-automate iam version [flags]

        Flags

        -d
        --debug
        Enable debug output
        Default value: false
        -h
        --help
        help for version
        Default value: false
        --no-check-version
        Disable version check
        Default value: false
        --result-json
        Write command result as JSON to PATH

        Related Commands

        chef-automate info

        Info for Automate HA cluster

        Supported on

        Command available on Chef Automate high availability deployments.

        In high availability Chef Automate deployments, this command is supported on the bastion host.

        Usage

        chef-automate info [flags]

        Flags

        -d
        --debug
        Enable debug output
        Default value: false
        -h
        --help
        help for info
        Default value: false
        --no-check-version
        Disable version check
        Default value: false
        --result-json
        Write command result as JSON to PATH

        Related Commands

          chef-automate infrastructure

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

          Supported on

          Command available on standalone and high availability Chef Automate deployments.

          In high availability Chef Automate deployments, this command is supported on the bastion host.

          Usage

          chef-automate infrastructure COMMAND [flags]

          Flags

          -d
          --debug
          Enable debug output
          Default value: false
          -h
          --help
          help for infrastructure
          Default value: false
          --no-check-version
          Disable version check
          Default value: false
          --result-json
          Write command result as JSON to PATH

          Related Commands

          chef-automate infrastructure node-delete

          Supported on

          Command available on standalone and high availability Chef Automate deployments.

          In high availability Chef Automate deployments, this command is supported on the bastion host.

          Usage

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

          Flags

          -d
          --debug
          Enable debug output
          Default value: false
          -h
          --help
          help for node-delete
          Default value: false
          --no-check-version
          Disable version check
          Default value: false
          --result-json
          Write command result as JSON to PATH

          Related Commands

          chef-automate init-config

          Initialize default configuration and save it to a file.

          Supported on

          Command available on standalone Chef Automate deployments.

          Usage

          chef-automate init-config [flags]

          Flags

          --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
          Flag only available on standalone Chef Automate deployments.
          Default value: current
          -d
          --debug
          Enable debug output
          Default value: false
          --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
          Flag only available on standalone Chef Automate deployments.
          Default value: 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 value: false
          --no-check-version
          Disable version check
          Default value: 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.
          --result-json
          Write command result as JSON to PATH
          --upgrade-strategy
          Upgrade strategy to use for this deployment.
          Default value: at-once

          Related Commands

            chef-automate init-config-ha

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

            Supported on

            Command available on Chef Automate high availability deployments.

            In high availability Chef Automate deployments, this command is supported on the bastion host.

            Usage

            chef-automate init-config-ha [flags]

            Flags

            -d
            --debug
            Enable debug output
            Default value: false
            --file
            File path to write the config
            Default value: config.toml
            -h
            --help
            help for init-config-ha
            Default value: false
            --no-check-version
            Disable version check
            Default value: false
            --path
            a2ha hab workspace dir path
            Flag only available on high availability Chef Automate deployments.
            Default value: /hab/a2_deploy_workspace/
            --result-json
            Write command result as JSON to PATH

            Related Commands

              chef-automate internal-ca

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

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate internal-ca COMMAND [flags]

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for internal-ca
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate internal-ca info

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate internal-ca info [flags]

              Flags

              --a2
              Print information of the root certificate of automate nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              -a
              --automate
              Print information of the root certificate of automate nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              -c
              --chef_server
              Print information of the root certificate of chef_server nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              --cs
              Print information of the root certificate of chef_server nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for info
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --node
              Node Ip address
              Flag only available on high availability Chef Automate deployments.
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate internal-ca regenerate

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate internal-ca regenerate [flags]

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for regenerate
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate internal-ca regenerate root

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate internal-ca regenerate root [flags]

              Flags

              --a2
              Regenerate the root certificate for automate nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              -a
              --automate
              Regenerate the root certificate for automate nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              -c
              --chef_server
              Regenerate the root certificate for chef_server nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              --cs
              Regenerate the root certificate for chef_server nodes
              Flag only available on high availability Chef Automate deployments.
              Default value: false
              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for root
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --node
              Node Ip address
              Flag only available on high availability Chef Automate deployments.
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate license

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license COMMAND [flags]

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for license
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate license apply

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

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license apply LICENSE [flags]

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -f
              --force
              Force set license
              Default value: false
              -h
              --help
              help for apply
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate license complianceResourceRunCount

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license complianceResourceRunCount [flags]

              Flags

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

              Related Commands

              chef-automate license complianceResourceRunReport

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license complianceResourceRunReport [flags]

              Flags

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

              Related Commands

              chef-automate license nodeRunReport

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license nodeRunReport [flags]

              Flags

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

              Related Commands

              chef-automate license status

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license status [flags]

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for status
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --result-json
              Write command result as JSON to PATH

              Related Commands

              chef-automate license uniqNodeRunReport

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is supported on the bastion host.

              Usage

              chef-automate license uniqNodeRunReport [flags]

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -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 value: false
              --no-check-version
              Disable version check
              Default value: false
              -n
              --os_hostname
              hostname of the OpenSource host
              Default value: localhost
              -P
              --os_password
              password of the OpenSource host
              Default value: admin
              -p
              --os_port
              port of the OpenSource host
              Default value: 10168
              -u
              --os_username
              username of the OpenSource host
              Default value: admin
              --result-json
              Write command result as JSON to PATH
              -s
              --start_time
              start time of the report in yyyy-mm-dd format

              Related Commands

              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.

              Supported on

              Command available on standalone and high availability Chef Automate deployments.

              In high availability Chef Automate deployments, this command is only supported on Chef Automate and Chef Infra Server frontend nodes.

              Usage

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

              Flags

              -d
              --debug
              Enable debug output
              Default value: false
              -h
              --help
              help for maintenance
              Default value: false
              --no-check-version
              Disable version check
              Default value: false
              --result-json
              Write command result as JSON to PATH
              -t
              --timeout
              Request timeout in seconds
              Default value: 10

              Related Commands

                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

                Supported on

                Command available on standalone Chef Automate deployments.

                Usage

                chef-automate migrate-from-v1 [/path/to/automate-deploy.toml] [flags]

                Flags

                --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 value: /etc/opscode/chef-server-running.json
                -c
                --config
                Path to an automate-deploy.toml
                -d
                --debug
                Enable debug output
                Default value: false
                -r
                --delivery-running
                Path to delivery-running.json
                Default value: /etc/delivery/delivery-running.json
                -s
                --delivery-secrets
                Path to delivery-secrets.json
                Default value: /etc/delivery/delivery-secrets.json
                --enable-chef-server
                Enable integrated Chef Server migration and deployment; only valid for all-in-one topology
                Default value: false
                --file-move-timeout
                Optional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
                Default value: 0
                -h
                --help
                help for migrate-from-v1
                Default value: false
                --no-check-version
                Disable version check
                Default value: false
                --postgres-dump-wait-seconds
                Optional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
                Default value: 0
                --postgres-restore-wait-seconds
                Optional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
                Default value: 0
                --result-json
                Write command result as JSON to PATH
                --skip-backup
                Optionally skip backup of your Chef Automate v1 installation (default = false)
                Default value: false
                --skip-backup-check
                Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
                Default value: false
                --skip-disaster-recovery-check
                Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
                Default value: false
                --skip-external-es-check
                Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
                Default value: false
                --skip-fips-check
                Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
                Default value: false
                --skip-preflight
                Deploy regardless of pre-flight conditions
                Default value: false
                --skip-saml-check
                Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
                Default value: false
                --skip-workflow-check
                Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
                Default value: 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 value: false

                Related Commands

                chef-automate migrate-from-v1-status

                Supported on

                Command available on standalone Chef Automate deployments.

                Usage

                chef-automate migrate-from-v1-status [flags]

                Flags

                -d
                --debug
                Enable debug output
                Default value: false
                -h
                --help
                help for migrate-from-v1-status
                Default value: false
                --no-check-version
                Disable version check
                Default value: false
                --result-json
                Write command result as JSON to PATH

                Related Commands

                  chef-automate migrate-from-v1 gen-config

                  Generate a Chef Automate v2 configuration file from Chef Automate v1

                  Supported on

                  Command available on standalone Chef Automate deployments.

                  Usage

                  chef-automate migrate-from-v1 gen-config [flags]

                  Flags

                  --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 value: /etc/opscode/chef-server-running.json
                  -c
                  --config
                  Path to an automate-deploy.toml
                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  -r
                  --delivery-running
                  Path to delivery-running.json
                  Default value: /etc/delivery/delivery-running.json
                  -s
                  --delivery-secrets
                  Path to delivery-secrets.json
                  Default value: /etc/delivery/delivery-secrets.json
                  --enable-chef-server
                  Enable integrated Chef Server migration and deployment; only valid for all-in-one topology
                  Default value: false
                  --file-move-timeout
                  Optional timeout for moving elasticsearch, compliance, and notifications files during Chef Automate v1 migration (0 to disable timeout)
                  Default value: 0
                  -h
                  --help
                  help for gen-config
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: false
                  -o
                  --out
                  Output file
                  Default value: ./automate-migrate.toml
                  --postgres-dump-wait-seconds
                  Optional timeout for Chef Automate v1 PostgreSQL dump (0 to disable timeout)
                  Default value: 0
                  --postgres-restore-wait-seconds
                  Optional timeout for Chef Automate v1 PostgreSQL restore (0 to disable timeout)
                  Default value: 0
                  --result-json
                  Write command result as JSON to PATH
                  --skip-backup
                  Optionally skip backup of your Chef Automate v1 installation (default = false)
                  Default value: false
                  --skip-backup-check
                  Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
                  Default value: false
                  --skip-disaster-recovery-check
                  Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
                  Default value: false
                  --skip-external-es-check
                  Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
                  Default value: false
                  --skip-fips-check
                  Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
                  Default value: false
                  --skip-preflight
                  Deploy regardless of pre-flight conditions
                  Default value: false
                  --skip-saml-check
                  Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
                  Default value: false
                  --skip-workflow-check
                  Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
                  Default value: 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 value: false

                  Related Commands

                  chef-automate node

                  Supported on

                  Command available on Chef Automate high availability deployments.

                  In high availability Chef Automate deployments, this command is supported on the bastion host.

                  Usage

                  chef-automate node COMMAND [flags]

                  Flags

                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  -h
                  --help
                  help for node
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: false
                  --result-json
                  Write command result as JSON to PATH

                  Related Commands

                  chef-automate node add

                  Add new node in HA

                  Supported on

                  Command available on Chef Automate high availability deployments.

                  In high availability Chef Automate deployments, this command is supported on the bastion host.

                  Usage

                  chef-automate node add [flags]

                  Flags

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

                  Related Commands

                  chef-automate node remove

                  remove existing node in HA

                  Supported on

                  Command available on Chef Automate high availability deployments.

                  In high availability Chef Automate deployments, this command is supported on the bastion host.

                  Usage

                  chef-automate node remove [flags]

                  Flags

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

                  Related Commands

                  chef-automate post-major-upgrade

                  Supported on

                  Command available on standalone Chef Automate deployments.

                  Usage

                  chef-automate post-major-upgrade COMMAND [flags]

                  Flags

                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  -h
                  --help
                  help for post-major-upgrade
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: false
                  --result-json
                  Write command result as JSON to PATH

                  Related Commands

                  chef-automate post-major-upgrade clear-data

                  Chef Automate post-major-upgrade to clear old pg data

                  Supported on

                  Command available on standalone Chef Automate deployments.

                  Usage

                  chef-automate post-major-upgrade clear-data [flags]

                  Flags

                  -y
                  --
                  auto-accept
                  Default value: false
                  --data
                  data
                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  -f
                  --force
                  fore-execute
                  Default value: false
                  -h
                  --help
                  help for clear-data
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: false
                  --result-json
                  Write command result as JSON to PATH

                  Related Commands

                  chef-automate post-major-upgrade migrate

                  Chef Automate migrate. migrate can be used to migrate pg or migrate es

                  Supported on

                  Command available on standalone Chef Automate deployments.

                  Usage

                  chef-automate post-major-upgrade migrate [flags]

                  Flags

                  -y
                  --
                  auto-accept
                  Default value: false
                  --check
                  check
                  Default value: false
                  --data
                  data
                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  -f
                  --force
                  force-execute
                  Default value: false
                  -h
                  --help
                  help for migrate
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: false
                  --result-json
                  Write command result as JSON to PATH
                  --skip-migration
                  permanently skiping migration
                  Default value: false
                  -s
                  --skip-storage-check
                  skip storage check
                  Default value: false

                  Related Commands

                  chef-automate preflight-check

                  Perform preflight check to verify host meets installation criteria.

                  Supported on

                  Command available on standalone and high availability Chef Automate deployments.

                  In high availability Chef Automate deployments, this command is supported on the bastion host.

                  Usage

                  chef-automate preflight-check [flags]

                  Flags

                  --a2
                  Pass this flag to run pre-flight check on automate node(HA)
                  Default value: false
                  --airgap
                  Pass this flag when the environment is airgapped
                  Default value: false
                  -a
                  --automate
                  Pass this flag to run pre-flight check on automate node(HA)
                  Default value: false
                  -c
                  --chef_server
                  Pass this flag to run pre-flight check on chef-server node(HA)
                  Default value: false
                  --config
                  Optional config file to use
                  --cs
                  Pass this flag to run pre-flight check on chef-server node(HA)
                  Default value: false
                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  --fe
                  Pass this flag to run pre-flight check on all Frontend nodes
                  Default value: false
                  -f
                  --frontend
                  Pass this flag to run pre-flight check on all Frontend nodes
                  Default value: false
                  --ha-deployment-config
                  Pass this flag to run pre-flight check on automate-HA
                  Default value: false
                  -h
                  --help
                  help for preflight-check
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: 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

                  Supported on

                  Command available on standalone Chef Automate deployments.

                  Usage

                  chef-automate preflight-check migrate-from-v1 [flags]

                  Flags

                  --a2
                  Pass this flag to run pre-flight check on automate node(HA)
                  Default value: false
                  --airgap
                  Pass this flag when the environment is airgapped
                  Default value: false
                  -a
                  --automate
                  Pass this flag to run pre-flight check on automate node(HA)
                  Default value: false
                  -c
                  --chef_server
                  Pass this flag to run pre-flight check on chef-server node(HA)
                  Default value: false
                  --config
                  Optional config file to use
                  --cs
                  Pass this flag to run pre-flight check on chef-server node(HA)
                  Default value: false
                  -d
                  --debug
                  Enable debug output
                  Default value: false
                  -r
                  --delivery-running
                  Path to delivery-running.json
                  Default value: /etc/delivery/delivery-running.json
                  -s
                  --delivery-secrets
                  Path to delivery-secrets.json
                  Default value: /etc/delivery/delivery-secrets.json
                  --fe
                  Pass this flag to run pre-flight check on all Frontend nodes
                  Default value: false
                  -f
                  --frontend
                  Pass this flag to run pre-flight check on all Frontend nodes
                  Default value: false
                  --ha-deployment-config
                  Pass this flag to run pre-flight check on automate-HA
                  Default value: false
                  -h
                  --help
                  help for migrate-from-v1
                  Default value: false
                  --no-check-version
                  Disable version check
                  Default value: 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
                  --skip-backup-check
                  Optionally do not check if your Chef Automate v1 installation has backups configured (default = false)
                  Default value: false
                  --skip-disaster-recovery-check
                  Optionally do not check if your Chef Automate v1 installation has disaster recovery configured (default = false)
                  Default value: false
                  --skip-external-es-check
                  Optionally do not check if your Chef Automate v1 installation has external Elasticsearch configured (default = false)
                  Default value: false
                  --skip-fips-check
                  Optionally do not check if your Chef Automate v1 installation has FIPS configured (default = false)
                  Default value: false
                  --skip-saml-check
                  Optionally do not check if your Chef Automate v1 installation has SAML configured (default = false)
                  Default value: false
                  --skip-workflow-check
                  Optionally do not check if your Chef Automate v1 installation has workflow configured (default = false)
                  Default value: false

                  Related Commands

                  chef-automate provision-infra

                  Provision infra for Automate HA deployment.

                  Supported on

                  Command available on Chef Automate high availability deployments.

                  In high availability Chef Automate deployments, this command is supported on the bastion host.

                  Usage

                  chef-automate provision-infra [flags]

                  Flags

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

                  Related Commands

                    chef-automate restart-services

                    Restart services for a deployment

                    Supported on

                    Command available on standalone and high availability Chef Automate deployments.

                    In high availability Chef Automate deployments, this command is supported on the bastion host.

                    Usage

                    chef-automate restart-services [flags]

                    Flags

                    --a2
                    restart chef automate service on automate nodes[DUPLICATE]
                    Default value: false
                    -a
                    --automate
                    restart chef automate service on automate nodes
                    Flag only available on high availability Chef Automate deployments.
                    Default value: false
                    -c
                    --chef_server
                    restart chef automate service on chef-server nodes
                    Flag only available on high availability Chef Automate deployments.
                    Default value: false
                    --cs
                    restart chef automate service on chef-server nodes[DUPLICATE]
                    Default value: false
                    -d
                    --debug
                    Enable debug output
                    Default value: false
                    -h
                    --help
                    help for restart-services
                    Default value: false
                    --no-check-version
                    Disable version check
                    Default value: false
                    --node
                    Node Ip address
                    Flag only available on high availability Chef Automate deployments.
                    -o
                    --opensearch
                    restart hab-sup service on opensearch nodes
                    Flag only available on high availability Chef Automate deployments.
                    Default value: false
                    --os
                    restart hab-sup service on opensearch nodes[DUPLICATE]
                    Default value: false
                    --pg
                    restart hab-sup service on postgresql nodes[DUPLICATE]
                    Flag only available on high availability Chef Automate deployments.
                    Default value: false
                    -p
                    --postgresql
                    restart hab-sup service on postgresql nodes
                    Default value: false
                    --result-json
                    Write command result as JSON to PATH
                    --wait-timeout
                    This flag sets the operation timeout duration (in seconds) for each individual node during the restart services
                    Flag only available on high availability Chef Automate deployments.
                    Default value: 1200

                    Related Commands

                      chef-automate secrets

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

                      Supported on

                      Command available on Chef Automate high availability deployments.

                      In high availability Chef Automate deployments, this command is supported on the bastion host.

                      Usage

                      chef-automate secrets [flags]

                      Flags

                      -d
                      --debug
                      Enable debug output
                      Default value: false
                      -h
                      --help
                      help for secrets
                      Default value: false
                      --no-check-version
                      Disable version check
                      Default value: false
                      --result-json
                      Write command result as JSON to PATH

                      Related Commands

                        chef-automate service-versions

                        Retrieve the versions of the individual Chef Automate services

                        Supported on

                        Command available on standalone and high availability Chef Automate deployments.

                        In high availability Chef Automate deployments, this command is supported on the bastion host.

                        Usage

                        chef-automate service-versions [flags]

                        Flags

                        --a2
                        Shows service-versions for Automate nodes[DUPLICATE]
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        -a
                        --automate
                        Shows service-versions for Automate nodes
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        -c
                        --chef_server
                        Shows service-versions for Chef-server nodes
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        --cs
                        Shows service-versions for Chef-server nodes[DUPLICATE]
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        -d
                        --debug
                        Enable debug output
                        Default value: false
                        -h
                        --help
                        help for service-versions
                        Default value: false
                        --no-check-version
                        Disable version check
                        Default value: false
                        --node
                        Pass this flag to check service-versions of particular node in the cluster
                        Flag only available on high availability Chef Automate deployments.
                        -o
                        --opensearch
                        Shows service-versions for OpenSearch nodes
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        --os
                        Shows service-versions for OpenSearch nodes[DUPLICATE]
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        --pg
                        Shows service-versions for PostgresQL nodes[DUPLICATE]
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        -p
                        --postgresql
                        Shows service-versions for PostgresQL nodes
                        Flag only available on high availability Chef Automate deployments.
                        Default value: false
                        --result-json
                        Write command result as JSON to PATH

                        Related Commands

                          chef-automate ssh

                          SSH into Automate HA servers

                          Supported on

                          Command available on Chef Automate high availability deployments.

                          In high availability Chef Automate deployments, this command is supported on the bastion host.

                          Usage

                          chef-automate ssh [flags]

                          Flags

                          -d
                          --debug
                          Enable debug output
                          Default value: false
                          -h
                          --help
                          help for ssh
                          Default value: false
                          -H
                          --hostname
                          Automate ha server name to ssh
                          --no-check-version
                          Disable version check
                          Default value: false
                          --result-json
                          Write command result as JSON to PATH

                          Related Commands

                            chef-automate start

                            Supported on

                            Command available on standalone and high availability Chef Automate deployments.

                            In high availability Chef Automate deployments, this command is supported on the bastion host.

                            Usage

                            chef-automate start [flags]

                            Flags

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

                            Related Commands

                              chef-automate status

                              Retrieve Chef Automate status. Includes status of Automate services.

                              Supported on

                              Command available on standalone and high availability Chef Automate deployments.

                              In high availability Chef Automate deployments, this command is supported on the bastion host.

                              Usage

                              chef-automate status [flags]

                              Flags

                              --a2
                              Shows status from Automate nodes[DUPLICATE]
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -a
                              --automate
                              Shows status from Automate nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -c
                              --chef_server
                              Shows status from Chef-server nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --cs
                              Shows status from Chef-server nodes[DUPLICATE]
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -d
                              --debug
                              Enable debug output
                              Default value: false
                              -h
                              --help
                              help for status
                              Default value: false
                              --no-check-version
                              Disable version check
                              Default value: false
                              --node
                              Pass this flag to check status of perticular node in the cluster
                              Flag only available on high availability Chef Automate deployments.
                              -o
                              --opensearch
                              Shows status from OpenSearch nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --os
                              Shows status from OpenSearch nodes[DUPLICATE]
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --pg
                              Shows status from PostgresQL nodes[DUPLICATE]
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -p
                              --postgresql
                              Shows status from PostgresQL nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --result-json
                              Write command result as JSON to PATH
                              -w
                              --wait-for-healthy
                              Wait until the status response is healthy or the timeout is reached
                              Default value: false
                              -r
                              --wait-refresh-interval
                              How many seconds to wait between polling for status updates
                              Default value: 2
                              -t
                              --wait-timeout
                              How many seconds to wait for the status to be healthy before returning an error
                              Default value: 600

                              Related Commands

                              chef-automate status summary

                              Retrieve Chef Automate status node summary for HA deployment

                              Supported on

                              Command available on standalone and high availability Chef Automate deployments.

                              In high availability Chef Automate deployments, this command is supported on the bastion host.

                              Usage

                              chef-automate status summary [flags]

                              Flags

                              -a
                              --automate
                              Get only automate Status
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -c
                              --chef-server
                              Get only chef server Status
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -d
                              --debug
                              Enable debug output
                              Default value: false
                              -h
                              --help
                              help for summary
                              Default value: false
                              --no-check-version
                              Disable version check
                              Default value: false
                              --node
                              Node Ip address
                              Flag only available on high availability Chef Automate deployments.
                              -o
                              --opensearch
                              Get only opensearch Status
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -p
                              --postgresql
                              Get only postgresql Status
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --result-json
                              Write command result as JSON to PATH

                              Related Commands

                              chef-automate stop

                              Stop a running deployment of Automate.

                              Supported on

                              Command available on standalone and high availability Chef Automate deployments.

                              In high availability Chef Automate deployments, this command is supported on the bastion host.

                              Usage

                              chef-automate stop [flags]

                              Flags

                              --a2
                              Stop chef automate services of automate nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -a
                              --automate
                              Stop chef automate services of automate nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -c
                              --chef_server
                              Stop chef automate services of chef_server nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --cs
                              Stop chef automate services of chef_server nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -d
                              --debug
                              Enable debug output
                              Default value: false
                              -h
                              --help
                              help for stop
                              Default value: false
                              --no-check-version
                              Disable version check
                              Default value: false
                              --node
                              Node Ip address
                              Flag only available on high availability Chef Automate deployments.
                              -o
                              --opensearch
                              Stop hab-sup service of opensearch nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --os
                              Stop hab-sup service of opensearch nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --pg
                              Stop hab-sup service of postgresql nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              -p
                              --postgresql
                              Stop hab-sup service of postgresql nodes
                              Flag only available on high availability Chef Automate deployments.
                              Default value: false
                              --result-json
                              Write command result as JSON to PATH

                              Related Commands

                                chef-automate system-logs

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

                                Supported on

                                Command available on standalone and high availability Chef Automate deployments.

                                In high availability Chef Automate deployments, this command is only supported on Chef Automate and Chef Infra Server frontend nodes.

                                Usage

                                chef-automate system-logs [flags]

                                Flags

                                -d
                                --debug
                                Enable debug output
                                Default value: false
                                -h
                                --help
                                help for system-logs
                                Default value: false
                                --no-check-version
                                Disable version check
                                Default value: false
                                --result-json
                                Write command result as JSON to PATH

                                Related Commands

                                  chef-automate test

                                  Run smoke test for Automate HA services.

                                  Supported on

                                  Command available on Chef Automate high availability deployments.

                                  In high availability Chef Automate deployments, this command is supported on the bastion host.

                                  Usage

                                  chef-automate test [flags]

                                  Flags

                                  -d
                                  --debug
                                  Enable debug output
                                  Default value: false
                                  --full
                                  Automate ha cluster test full
                                  Default value: false
                                  -h
                                  --help
                                  help for test
                                  Default value: false
                                  --no-check-version
                                  Disable version check
                                  Default value: false
                                  --result-json
                                  Write command result as JSON to PATH

                                  Related Commands

                                    chef-automate uninstall

                                    Uninstall Chef Automate, deleting all data and configuration

                                    Supported on

                                    Command available on standalone Chef Automate deployments.

                                    Usage

                                    chef-automate uninstall [flags]

                                    Flags

                                    -d
                                    --debug
                                    Enable debug output
                                    Default value: false
                                    -h
                                    --help
                                    help for uninstall
                                    Default value: false
                                    --no-check-version
                                    Disable version check
                                    Default value: false
                                    --preserve-package-cache
                                    Preserve Habitat package cache (useful for faster reinstall)
                                    Default value: false
                                    --result-json
                                    Write command result as JSON to PATH
                                    --yes
                                    Uninstall Chef Automate and destroy data without confirmation prompt
                                    Default value: false

                                    Related Commands

                                      chef-automate upgrade

                                      Supported on

                                      Command available on standalone and high availability Chef Automate deployments.

                                      In high availability Chef Automate deployments, this command is supported on the bastion host.

                                      Usage

                                      chef-automate upgrade COMMAND [flags]

                                      Flags

                                      -d
                                      --debug
                                      Enable debug output
                                      Default value: false
                                      -h
                                      --help
                                      help for upgrade
                                      Default value: false
                                      --no-check-version
                                      Disable version check
                                      Default value: false
                                      --result-json
                                      Write command result as JSON to PATH

                                      Related Commands

                                      chef-automate upgrade run

                                      Run an upgrade of Chef Automate

                                      Supported on

                                      Command available on standalone and high availability Chef Automate deployments.

                                      In high availability Chef Automate deployments, this command is supported on the bastion host.

                                      Usage

                                      chef-automate upgrade run [flags]

                                      Flags

                                      --airgap-bundle
                                      Path to an airgap install bundle
                                      -y
                                      --auto-approve
                                      Do not prompt for confirmation; accept defaults and continue
                                      Flag only available on high availability Chef Automate deployments.
                                      Default value: false
                                      -d
                                      --debug
                                      Enable debug output
                                      Default value: false
                                      -h
                                      --help
                                      help for run
                                      Default value: false
                                      --major
                                      This flag is only needed for major version upgrades
                                      Flag only available on standalone Chef Automate deployments.
                                      Default value: false
                                      --no-check-version
                                      Disable version check
                                      Default value: false
                                      --os-dest-data-dir
                                      Flag for providing custom os destination data directory
                                      Flag only available on standalone Chef Automate deployments.
                                      --result-json
                                      Write command result as JSON to PATH
                                      --saas
                                      Flag for saas setup
                                      Flag only available on high availability Chef Automate deployments.
                                      Default value: false
                                      --skip-deploy
                                      will only upgrade and not deploy the bundle
                                      Flag only available on high availability Chef Automate deployments.
                                      Default value: false
                                      --skip-storage-check
                                      Flag for skipping disk space check during upgrade
                                      Flag only available on standalone Chef Automate deployments.
                                      Default value: false
                                      --skip-verify
                                      Flag for skipping config verification check
                                      Default value: false
                                      --upgrade-airgap-bundles
                                      Update Chef Automate both frontend and backend version to install
                                      Flag only available on high availability Chef Automate deployments.
                                      Default value: false
                                      --upgrade-backends
                                      Update Chef Automate backends version to install
                                      Flag only available on high availability Chef Automate deployments.
                                      Default value: false
                                      --upgrade-frontends
                                      upgrade Chef Automate HA frontends version to install
                                      Flag only available on high availability Chef Automate deployments.
                                      Default value: false
                                      --version
                                      The exact Chef Automate version to install
                                      Flag only available on standalone Chef Automate deployments.
                                      -w
                                      --workspace-upgrade
                                      Do not prompt for confirmation to accept workspace upgrade
                                      Flag only available on high availability Chef Automate deployments.

                                      Related Commands

                                      chef-automate upgrade status

                                      Get upgrade status of Chef Automate

                                      Supported on

                                      Command available on standalone and high availability Chef Automate deployments.

                                      In high availability Chef Automate deployments, this command is only supported on Chef Automate and Chef Infra Server frontend nodes.

                                      Usage

                                      chef-automate upgrade status [flags]

                                      Flags

                                      -d
                                      --debug
                                      Enable debug output
                                      Default value: false
                                      -h
                                      --help
                                      help for status
                                      Default value: false
                                      --no-check-version
                                      Disable version check
                                      Default value: false
                                      --result-json
                                      Write command result as JSON to PATH

                                      Related Commands

                                      chef-automate version

                                      Show the CLI version.

                                      Supported on

                                      Command available on standalone and high availability Chef Automate deployments.

                                      In high availability Chef Automate deployments, this command is supported on the bastion host.

                                      Usage

                                      chef-automate version [flags]

                                      Flags

                                      --a2
                                      Get only automate Status
                                      Default value: false
                                      --cs
                                      Get only chef server Status
                                      Default value: false
                                      -d
                                      --debug
                                      Enable debug output
                                      Default value: false
                                      -h
                                      --help
                                      help for version
                                      Default value: false
                                      --no-check-version
                                      Disable version check
                                      Default value: false
                                      --node
                                      Node Ip address. While using this flag, pass the node type as well. Example : chef-automate version --node 192.0.0.1 --cs
                                      Flag only available on high availability Chef Automate deployments.
                                      --os
                                      Get only opensearch Status
                                      Default value: false
                                      --pg
                                      Get only postgresql Status
                                      Default value: false
                                      --result-json
                                      Write command result as JSON to PATH
                                      -v
                                      --verbose
                                      Show additional version information
                                      Default value: false

                                      Related Commands

                                        chef-automate workspace

                                        Set up Automate HA cluster workspace.

                                        Supported on

                                        Command available on Chef Automate high availability deployments.

                                        In high availability Chef Automate deployments, this command is supported on the bastion host.

                                        Usage

                                        chef-automate workspace [flags]

                                        Flags

                                        -d
                                        --debug
                                        Enable debug output
                                        Default value: false
                                        -h
                                        --help
                                        help for workspace
                                        Default value: false
                                        --no-check-version
                                        Disable version check
                                        Default value: false
                                        --result-json
                                        Write command result as JSON to PATH

                                        Related Commands

                                          Error Codes

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

                                          Chef Automate CLI Status Error Codes
                                          Exit CodeNameDescription
                                          68HabUserAccessErrorUnable to access file or directory with the hab user
                                          69SnapshotChecksumMismatchErrorA file in the snapshot did not have the expected checksum
                                          70DatabaseErrorAn issue occurred with the database
                                          71CommandExecutionErrorAn issue occurred when running an executable command
                                          72TraceErrorAn issue occurred when attempting to trace the request
                                          73ProfileErrorAn issue occurred when attempting to profile the request
                                          74HabCommandErrorAn issue occurred when running a hab command
                                          75HabAPIErrorAn issue occurred when attempting to query the Habitat API
                                          76GatherLogsErrorUnable to complete log gathering
                                          77PackageInstallErrorUnable to install the habitat package
                                          78TimedOutErrorTimed out waiting for the operation to complete
                                          79BackupRestoreErrorUnable to restore backup
                                          80ServiceUnloadErrorUnable to unload the habitat service
                                          81ServiceStartErrorUnable to start the habitat service
                                          82AirgapUnpackInstallBundleErrorAn issue occurred when attempting to unpack the airgap install bundle
                                          83AirgapCreateInstallBundleErrorAn issue occurred when attempting to create the airgap install bundle
                                          84DownloadErrorAn issue occurred when attempting to perform a file download
                                          85UninstallErrorAn issue occurred when attempting to uninstall Chef Automate
                                          86BackupErrorAn issue occurred when creating or restoring a backup
                                          87UpgradeErrorAn issue occurred during the upgrade
                                          88MarshalErrorUnable to convert or deconvert a textual representation of an internal object
                                          89LicenseErrorThe license is invalid, expired or incomplete
                                          90FileAccessErrorUnable to access the file or directory
                                          91DiagnosticsErrorOne or more diagnostics checks failed
                                          92MustBeRootErrorThe command must be run as the root user
                                          93ConfigErrorThe configuration is invalid
                                          94DeployErrorUnable to install, configure and start the service
                                          95PreflightErrorOne or more preflight checks failed
                                          96InvalidCommandArgsErrorThe arguments provided are invalid
                                          97UnhealthyStatusErrorSystem status is unhealthy
                                          98DeploymentServiceCallErrorA request to the deployment-service failed
                                          99DeploymentServiceUnreachableErrorUnable to make a request to the deployment-service
                                          100APIErrorAn API error occurred during execution
                                          112UpdateExecErrorAn issue occurred when trying to run an auto-updated CLI executable
                                          113UnknownErrorAn unknown issue occurred during execution
                                          114APIUnreachableErrorCould not connect to Automate API
                                          115UnknownErrorFailed to upgrade IAM to v2
                                          116UnknownErrorFailed to reset IAM state to v1
                                          117DeploymentServiceErrorFailed to restart Deployment Service
                                          118InappropriateSettingErrorSettings are not appropriate
                                          119AvailableSpaceErrorError in getting available space
                                          120CalESDirSizeErrorError in calculating ES directory size
                                          121CalDestDirSizeErrorError in calculating Dest directory size
                                          122InsufficientSpaceErrorInsufficient disk space
                                          124ConfigVerifyErrorConfig Verification failed
                                          125VerifyChecksErrorVerify Checks failed
                                          126PromptFailedPrompt failed and exited with error
                                          127FailedToGenConfigFailed to Generate config with given inputs
                                          128HardwareCalErrorHardware Calculator failed to provide Hardware Estimates
                                          Edit this page on GitHub

                                          Thank you for your feedback!

                                          ×









                                          Search Results