Run Remote Command
What does Run Remote Command do?
The Run Remote Command directive will run a terminal command within a SSH session on a remote server for you.
Note that you must have access to the target server on which you want to run the command. You must be able to login with either a SSH key or password.
If the server has blocked your access, this directive will fail to run.
How do I use the Run Remote Command directive?
In order to use this directive, you must specify:
- Target server IP address
- Target server port
- Username to SSH login to server
- Password or SSH key to login to server
![Display Text directive settings](https://docs-assets.proggy.io/directive-run-remote-command-ssh-settings.webp)
Finally, you must specify the command you wish to execute on the remote server once logged in.
![Display Text directive settings](https://docs-assets.proggy.io/directive-run-remote-command.webp)
Behaviour of the Run Remote Command directive
- You must already have access to the server. If Proggy cannot connect to the server, your Prog command will exit.
- If any of the commands being executed fail to run, your Prog will fail and exit.
- All of the output will be captured and saved as
step[prefix].raw
for that particular step directive.
Example use cases for the Run Remote Command directive
- Devops tasks, such as server provisioning, updating configuration files, downloading files, etc.