vmrConfigSSH: Configure ssh

View source: R/vmr-methods.R

vmrConfigSSHR Documentation

Configure ssh

Description

Configure ssh credential.

Usage

vmrConfigSSH(
  vmr,
  ssh_user = "vagrant",
  ssh_pwd = "vagrant",
  port = "",
  ssh_private_key_path = ""
)

Arguments

vmr

a vmr object

ssh_user

the ssh user (default 'vagrant')

ssh_pwd

the ssh pwd if any (default 'vagrant')

port

the ssh port (default empty)

ssh_private_key_path

path to the private ssh key to use (default empty, use insecure vagrant key)

Details

by default vmr use vagrant as user/password and insecure key for ssh connection. This behavior can be change here, by setting an another user and/or ssh keys. Calling with no arguments will disable this option. Be careful, ssh using only password may result of vmr functions bugs.

Value

an updated vmr object

Examples

## Not run: 
vmr <- vmrConfigSSH(ssh_user = "John", ssh_pwd = "d0e", port = "22")
vmr <- vmrConfigSSH(ssh_user = "John", private_key_path = "/path/to/private/key/")

## End(Not run)

vmr documentation built on March 31, 2023, 8:31 p.m.