Skip to content

Latest commit

 

History

History
60 lines (52 loc) · 2.95 KB

README.md

File metadata and controls

60 lines (52 loc) · 2.95 KB
Raw

← back to Commands

om curl

The curl command will help you make arbitrary API calls against the Ops Manager VM.

Command Usage

Usage:
  om [OPTIONS] curl [curl-OPTIONS]

This command issues an authenticated API request as defined in the arguments

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

[curl command options]
      -p, --path=              path to api endpoint
      -x, --request=           http verb (defaults to GET, POST when 'data'
                               specified
      -d, --data=              api request payload
      -s, --silent             only write response headers to stderr if
                               response status is 4XX or 5XX
      -H, --header=            used to specify custom headers with your command
                               (default: Content-Type: application/json)