Access Oracle Essbase Using SSH

Use Secure Shell (SSH) client software to connect to the Essbase instance deployed on Oracle Cloud Infrastructure to perform administrative tasks.

Note:

Added for version 19.3.0.3.4:

To access the private compute node, it depends on your environment. If you haven’t deployed a bastion host, you can do so later (see Oracle Support for white paper on post-deployment bastion host setup). If your network configuration uses FastConnection or VPN with IPSec, you must provide the network setup that allows you to SSH to the private compute node.

You can log in securely to your Essbase instance from a remote host by using a secure shell (SSH) connection.

Before creating the Essbase instance on Oracle Cloud Infrastructure, generate at least one SSH key pair, and ensure that the private key is available on each host that you’ll use to access Essbase instances.

To connect to Essbase using SSH, you use the SSH private key, which is part of the key pair created as a prerequisite to deploying the stack. After you've created the stack, you have a few different IP addresses, depending on the network topology.

You can use any SSL utility, for example openSSL, to generate SSH keys and to log in to your Essbase instance.

If the Essbase compute node has an essbase_node_public_ip address, you can access it directly with ssh using the following:

$ ssh -i <path_to_private_key> opc@<essbase_public_ip>

For some SSH client implementations, <path_to_private_key> the only valid valid file permissions are: 400, 600 or 700.

If you deployed a private subnet, the Essbase compute node has a private IP, but no public IP. In this case, you must use the public IP of the bastion host to access the Essbase compute node by proxy. Examples are provided in this topic. SSH syntax may vary, depending on your SSH client and operating system.

ssh -i <path_to_private_key> -o ProxyCommand='ssh -i <path_to_private_key> -A opc@<bastion_public_ip> -W %h:%p' opc@<essbase_private_ip>

See also Connecting to an Instance in Oracle Cloud Infrastructure documentation.

Bastion Host SSH Tips

Essbase doesn't have a public IP address when you deploy a private subnet using a bastion host. Use these guidelines to help you configure your system for SSH access to the Essbase compute node on Oracle Cloud Infrastructure. These examples utilize a bash shell. Bash commands you enter are in bold.

  1. Change to the hidden directory, .ssh, usually located in your user directory (check the documentation for your specific SSH client).

    cd ~/.ssh
  2. Modify (or create) the config file in the .ssh directory. Though the following example invokes the UNIX vi editor, you can use any text editor.

    vi config
  3. In the config file, enter HostName and IdentityFile details for the bastion host. For HostName, provide the IP address of the bastion host, and for IdentityFile, provide the location of the private key that matches the public key you provided to Resource Manager during the Essbase deployment. Format:

    Host bastion
    	HostName <bastion_host_public_ip>
    	IdentityFile <path_to_private_key>
  4. Add to the config file an additional host entry for the private Essbase subnet. For HostName, provide the essbase_node_private_ip, and for IdentityFile, provide the location of the private key that matches the public key you provided to Resource Manager during the Essbase deployment. For ProxyCommand, set up SSH access for the opc user to access the bastion host by proxy. Example:

    Host essbase
    	HostName <essbase_node_private_ip>
    	IdentityFile <path_to_private_key>
    	ProxyCommand ssh opc@bastion -W %h:%p

    Here is an example of a completed config file.

    Host bastion
    	HostName 192.0.2.111
    	IdentityFile C:/temp/ids/my_key
    
    Host essbase
    	HostName 10.0.1.2
    	IdentityFile C:/temp/ids/my_key
    	ProxyCommand ssh opc@bastion -W %h:%p
    
  5. Save the config file and exit the editor.

  6. In your command window, log in over SSH to Essbase, by proxy of the bastion host, as the opc user.

    ssh opc@essbase
  7. Switch to user oracle to explore the Essbase compute and complete any administrative tasks.

    sudo su oracle
  8. Change to the home directory of the Essbase compute node on Oracle Cloud Infrastructure.

    cd /
  9. View the directories.

    ls
    bin  boot  dev  etc  home  lib  lib64  media  mnt  opt  proc  root  run  sbin  srv  tmp  u01  usr  var
  10. Explore the Essbase directories. The applications are in the app directory, and the file catalog is in the catalog directory.

    cd /u01/data/essbase
    ls
    app  catalog  hybrid  jagentId.id