1. Scripting Reference for Oracle Essbase
  2. Essbase Command-Line Interface (CLI)
  3. CLI Command Reference
  4. Login/Logout: CLI Authentication

Login/Logout: CLI Authentication

The login CLI command for Essbase authenticates you to Essbase so you can use the CLI.

Before you can issue any other CLI commands to Essbase, you must log in. If a secure connection is required, then the URL must begin with https.

You can authenticate in the following ways using CLI:

  • Use setpassword once to have the password stored for your client/user combination. In subsequent sessions, you can use the login command without being prompted to enter a password.
  • Use the -user and -password options with the login command (Caution: the password appears in the shell window as cleartext).
  • Use only the -user option with the login command. You are prompted to enter the password, which is hidden.

If you’re a federated SSO user in Oracle Identity Cloud Service, logging in using MaxL or CLI is not supported. Federated SSO login requires a browser window. Create a native Identity Cloud Service user, and use that instead to log in using MaxL or CLI.

Syntax (login)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Option Abbreviation Description
-verbose -v Show extended descriptions
-essbaseurl -url Address of an instance of Essbase
-user -u User name
-password -p Optional. Password for user. Alternatively, set the password using setpassword.

If issuing the the login command from a script, and the password contains special characters, enclose it in double quotation marks (for example, "aNb3^5%9$!").

Use of $ (dollar sign) character within the Essbase password is not supported for logins in a Linux environment.

Example 1 (login)

esscs login -url https://myEssbase-test-myDomain.analytics.us2.example.com/essbase -u smith

Example 2 (login)

In the following example, the user logging in, admin1@example.com is an Identity Cloud Service administrator who was set as the initial Essbase administrator during Essbase stack deployment on Oracle Cloud Infrastructure. As the password is not entered in this example, the administrator will be prompted to provide it next. The URL is the essbase_url from the job outputs resulting from the stack deployment. 

esscs login -u admin1@example.com -url https://192.0.2.1/essbase

Syntax (logout)

logout

Example (logout)

esscs logout