remote-exec cookbook

This cookbook implements remote_execute resource. As its name implies, the resource
executes a command on a remote server using ssh.

Requirements

Tested only with Chef 12. The cookbook uses Net:SSH Ruby module, which is expected
to be installed. I think, it is usually the case, if you have chef-client.

Resources

remote_execute 'i wanna do something' do
  command 'ls -l'
  address '127.0.0.1'
  user 'root'
  password 'dontknow'
end

Syntax:

remote_execute 'name' do
  address   String          #
  command   String          # defaults to name
  returns   Integer, Array  #
  password  String          #
  user      String          #

  not_if_remote   String    #
  only_if_remote  String    #

  action    Symbol          # defaults to :run
end

Actions

The resource has the following actions:

:nothing
Prevent a command from running. Does nothing ;-)

:run
Default. Run a command.

Properties

The resource has the following properties:

command
The name of the command to be executed. Default value: the name of the resource block

returns
The return value for a command. This may be an array of accepted values. An exception is raised when the return value(s) do not match. Default value: 0.

address
The address of the remote server.

user
The username used to connect to the remote server.

password
The password for the user to connect to the remote server. If not specified, Net:SSH tries to connect using SSH keys, and if it doesn't help, asks for a password.

Guards

There are 2 additional guards, implemented in the resource:

not_if_remote
It prevents a resource from executing, if the specified condition (command) returns on the remote server true (0).

only_if_remote
It allows a resource to execute, only if the specified condition (command) returns on the remote server true (0).

Example

remote_execute 'create a file' do
  command 'touch /tmp/tempfile'
  address '192.168.0.1'
  user 'root'
  password 'dontknow'
  only_if_remote 'ls /dev/null'
end