README.md

← back to Commands

om bosh-diff

This command displays the bosh manifest diff for the director and products (Note: secret values are replaced with double-paren variable names)

Command Usage

Usage:
  om [OPTIONS] bosh-diff [bosh-diff-OPTIONS]

This command displays the bosh manifest diff for the director and products
(Note: secret values are replaced with double-paren variable names)

Application Options:
      --ca-cert=               OpsManager CA certificate path or value
                               [$OM_CA_CERT]
  -c, --client-id=             Client ID for the Ops Manager VM (not required
                               for unauthenticated commands) [$OM_CLIENT_ID]
  -s, --client-secret=         Client Secret for the Ops Manager VM (not
                               required for unauthenticated commands)
                               [$OM_CLIENT_SECRET]
  -o, --connect-timeout=       timeout in seconds to make TCP connections
                               (default: 10) [$OM_CONNECT_TIMEOUT]
  -d, --decryption-passphrase= Passphrase to decrypt the installation if the
                               Ops Manager VM has been rebooted (optional for
                               most commands) [$OM_DECRYPTION_PASSPHRASE]
  -e, --env=                   env file with login credentials
  -p, --password=              admin password for the Ops Manager VM (not
                               required for unauthenticated commands)
                               [$OM_PASSWORD]
  -r, --request-timeout=       timeout in seconds for HTTP requests to Ops
                               Manager (default: 1800) [$OM_REQUEST_TIMEOUT]
  -k, --skip-ssl-validation    skip ssl certificate validation during http
                               requests [$OM_SKIP_SSL_VALIDATION]
  -t, --target=                location of the Ops Manager VM [$OM_TARGET]
      --trace                  prints HTTP requests and response payloads
                               [$OM_TRACE]
  -u, --username=              admin username for the Ops Manager VM (not
                               required for unauthenticated commands)
                               [$OM_USERNAME]
      --vars-env=              load vars from environment variables by
                               specifying a prefix (e.g.: 'MY' to load
                               MY_var=value) [$OM_VARS_ENV]
  -v, --version                prints the om release version

Help Options:
  -h, --help                   Show this help message

[bosh-diff command options]
      -p, --product-name=      Product to get diff for. Pass repeatedly for
                               multiple products. If excluded, all staged
                               non-director products will be shown.
      -d, --director           Include director diffs. Can be combined with
                               --product-name.
          --check              Exit 2 if there are any differences. Useful for
                               validating that Ops Manager is in a clean state.

Important Note

This command is useful for determining the scope of apply changes, but it has a limitation it's important to be aware of.

The runtime configurations returned by the Ops Manager API and presented by this command are those provided by the product. They are not those that impact the product.

For a concrete example, take p-antivirus. It provides runtime configs that put an add-on on every VM. If such a runtime config has been updated since the last time the PAS product, cf, was deployed, every VM in cf will be rolled, but no runtime config diffs will show if you just run om bosh-diff --product-name cf. To work around this, we recommend you include any add-on products in your diff command. For the above example, that would be:

om bosh-diff --product-name cf --product-name p-antivirus

But even this might not tell you what you need to know! If the p-antivirus changes have already been applied, they won't show a diff at all.