datalad.api.sshrun

datalad.api.sshrun(login, cmd, *, port=None, ipv4=False, ipv6=False, options=None, no_stdin=False)

Run command on remote machines via SSH.

This is a replacement for a small part of the functionality of SSH. In addition to SSH alone, this command can make use of datalad’s SSH connection management. Its primary use case is to be used with Git as ‘core.sshCommand’ or via “GIT_SSH_COMMAND”.

Configure datalad.ssh.identityfile to pass a file to the ssh’s -i option.

Parameters:

• login – [user@]hostname.

• cmd – command for remote execution.

• port – port to connect to on the remote host. [Default: None]

• ipv4 (bool, optional) – use IPv4 addresses only. [Default: False]

• ipv6 (bool, optional) – use IPv6 addresses only. [Default: False]

• options – configuration option passed to SSH. [Default: None]

• no_stdin (bool, optional) – Do not connect stdin to the process. [Default: False]