vagrant/website/source/docs/cli/ssh.html.md

52 lines
2.0 KiB
Markdown
Raw Normal View History

---
layout: "docs"
page_title: "vagrant ssh - Command-Line Interface"
sidebar_current: "cli-ssh"
description: |-
The "vagrant ssh" command is used to establish an SSH session into a running
virtual machine to give you shell access.
---
# SSH
2016-04-12 11:45:10 +00:00
**Command: `vagrant ssh [name|id] [-- extra_ssh_args]`**
This will SSH into a running Vagrant machine and give you access to a shell.
If a `--` (two hyphens) are found on the command line, any arguments after
this are passed directly into the `ssh` executable. This allows you to pass
2013-12-19 12:23:18 +00:00
any arbitrary commands to do things such as reverse tunneling down into the
`ssh` program.
## Options
* `-c COMMAND` or `--command COMMAND` - This executes a single SSH command, prints
2015-04-26 00:22:10 +00:00
out the stdout and stderr, and exits.
* `-p` or `--plain` - This does an SSH without authentication, leaving
authentication up to the user.
## SSH client usage
Vagrant will attempt to use the local SSH client installed on the host machine. On
POSIX machines, an SSH client must be installed and available on the PATH.
For Windows installations, an SSH client is provided within the installer
image. If no SSH client is found on the current PATH, Vagrant will use the
SSH client it provided. Depending on the local environment used for running
Vagrant, the installer provided SSH client may not work correctly. For example,
when using a cygwin or msys2 shell the SSH client will fail to work as expected
when run interactively. Installing the SSH package built for the current working
environment will resolve this issue.
## Background Execution
If the command you specify runs in the background (such as appending a `&` to
a shell command), it will be terminated almost immediately. This is because
when Vagrant executes the command, it executes it within the context of a
shell, and when the shell exits, all of the child processes also exit.
To avoid this, you will need to detach the process from the shell. Please
Google to learn how to do this for your shell. One method of doing this is
the `nohup` command.