Skip to content

Latest commit

 

History

History
97 lines (87 loc) · 5.78 KB

File metadata and controls

97 lines (87 loc) · 5.78 KB

back to Commands

om configure-saml-authentication

The configure-saml-authentication command will allow you to setup your user account on the Ops Manager with SAML authentication.

To set up your Ops Manager with internal authentication instead, use configure-authentication.

Command Usage

Usage:
  om [OPTIONS] configure-saml-authentication [configure-saml-authentication-OPTIONS]

This unauthenticated command helps setup the authentication mechanism for your
Ops Manager with SAML.

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

[configure-saml-authentication command options]
      -d, --decryption-passphrase=         passphrase used to encrypt the
                                           installation
          --http-proxy-url=                proxy for outbound HTTP network
                                           traffic
          --https-proxy-url=               proxy for outbound HTTPS network
                                           traffic
          --no-proxy=                      comma-separated list of hosts that
                                           do not go through the proxy
          --saml-idp-metadata=             XML, or URL to XML, for the IDP that
                                           Ops Manager should use
          --saml-bosh-idp-metadata=        XML, or URL to XML, for the IDP that
                                           BOSH should use
          --saml-rbac-admin-group=         If SAML is specified, please provide
                                           the admin group for your SAML
          --saml-rbac-groups-attribute=    If SAML is specified, please provide
                                           the groups attribute for your SAML
          --skip-create-bosh-admin-client  create a UAA client on the Bosh
                                           Director, whose credentials can be
                                           passed to the BOSH CLI to execute
                                           BOSH commands. Default is false.
          --precreated-client-secret=      create a UAA client on the Ops
                                           Manager vm, whose secret will be the
                                           value provided to this option

    config file interpolation:
      -c, --config=                        path to yml file for configuration
                                           (keys must match the following
                                           command line flags)
          --vars-env=                      load variables from environment
                                           variables matching the provided
                                           prefix (e.g.: 'MY' to load
                                           MY_var=value) [$OM_VARS_ENV]
      -l, --vars-file=                     load variables from a YAML file
      -v, --var=                           load variable from the command line.
                                           Format: VAR=VAL

The --saml-idp-metadata and --saml-bosh-idp-metadata can be the same.