STEP

Execute SSH commands on a remote server

This step executes a series of SSH commands directly on a remote server.

Specification

connection

Required

A Relay SSH connection to useConnection docs
!Connection {type: ssh, name: my-ssh-connection}
username

Required

string
Username to use
port
Optional
number
Port to use
knownHosts
Optional
string
A SSH known_hosts file to use for host key checking
strictHostKeyChecking
Optional
boolean
Whether or not to check the host key against known_hosts
on[]

Required

array
An array of hosts to loop over and perform input commands on
input[]

Required

array
An array of commands to run on each host specified in \"on\"

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.