create_ssh_command: A function to build an ssh command

Description Usage Arguments Details Value Author(s) See Also Examples

Description

Create an ssh command string to access the oliver replica database on AWS via reverse tunnel to a linux box administered by POC. This command string can then be interactively pasted into a terminal to set a connection to the oliver replica on your localhost.

Usage

1
2
3
4
5
create_ssh_command(private_key_path = NA, target_port = 5431,
  local_port_for_forward = 5432,
  forward_target_host = "oliver-replica.criploulbgnu.us-west-2.rds.amazonaws.com",
  forward_target_port = 5432, reverse_tunnel_target_user = NA,
  reverse_tunnel_target = "52.90.57.218")

Arguments

private_key_path

A locally accesible path to your previously registered private key.

target_port

The target port number. Defaults to 5431.

local_port_for_forward

The local port to be forwarded. Defaults to 5432.

forward_target_host

The actual location of the oliver replica. Defaults to oliver-replica.criploulbgnu.us-west-2.rds.amazonaws.com.

forward_target_port

The targeted port on the target host. Defaults to 5432.

reverse_tunnel_target_user

A valid username on the reverse tunnel target.

reverse_tunnel_target

The name of the reverse tunnel target. Defaults to 52.90.57.218.

Details

The following dependencies are required in order to create a valid string:

Access to the oliver replica requires two-factor authentication. Authy (https://www.authy.com/) is used for this purpose. Authy account information should be forwarded to mattbro@uw.edu prior to trying to establish a connection to the replica with the command string or access will be denied.

Value

None (invisible NULL).

Author(s)

Joe Mienko, mienkoja@uw.edu

See Also

create_flat_files

Examples

1
2
create_ssh_command(private_key_path = '/Users/mienkoja/.ssh/id_rsa'
                   ,reverse_tunnel_target_user = 'mienkoja')

pocdata/oliveR documentation built on May 25, 2019, 10:23 a.m.