Explore Compliance Docs Blog Pricing

Sign in Create account

Create account Sign in

@ Puppet 2022. All rights reserved.

Source

Execute SSH commands on a remote server

step

Executes a series of SSH commands directly on a remote server.

Specification

connection

Required

A Relay SSH connection to useConnection docs

${connections.ssh.my-ssh-connection}

username

Required

string

Username to use

port

Optional

number

Port to use

knownHosts

Optional

string

An 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

Example step configuration

1name: ssh
2image: relaysh/ssh-step-exec
3spec:
4  connection: ${connections.ssh.my-ssh-connection}
5  username: ${parameters.username}
6  port: 22
7  knownHosts: >
8    ${secrets.knownHosts}
9  on:
10  - ${parameters.hostname}
11  input:
12  - ${parameters.command}
13

Join our community

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.

Ready to get started?

With Relay you can create event-based workflows that are fully automated.

Start automating

Simple workflow example

Documentation

Blog

Privacy policy

Terms of Use

Pricing

Join us on Slack

Privacy policy

Terms of Use

© Puppet 2022, All rights reserved.