NAME

  IPC::ShellCmd::SSH - Chain ssh-ing to a host before running the command

SYNOPSIS

    $cmd_obj->chain_prog(
        IPC::ShellCmd::SSH->new(
                User => 'cpanbuild',
            Host => '10.0.0.1'
        )
    );

DESCRIPTION

IPC::ShellCmd::SSH->new(Host => $host, [$opt => $val, ...])

The only external method for this is the constructor. This sets up the various arguments that are going to be used to generate the command-line.

Other methods on this are used by IPC::ShellCmd, but it should only ever be used inside of the chain_prog method on a IPC::ShellCmd object.

The only required argument is the host.

Host REQUIRED

Specifies the host to ssh to. Since this is done by invoking the command-line ssh client, this can be a short host name that is part of the local ssh config.

User

Specifies the user name on the remote host.

Port

Specifies the port to connect to on the remote host.

ForwardAgent

If specified, then if true will enable agent forwarding (say for dealing with a bastion host), and if false will explicitly disable it. If not specified it will be the ssh default.

ForwardX11

If specified, then if true will enable X11 forwarding, and if false will disable it. If not specified, this will be the ssh default.

AllocateTty

If specified, then if true will force allocation of a tty, and if false will disable it. If not specified, this will be the ssh default.

IdentityFile

Specifies the ssh private key to use.

BUGS

I don't know of any, but that doesn't mean they're not there.

AUTHORS

See IPC::ShellCmd for authors.

LICENSE

See IPC::ShellCmd for the license.