net::cli::interact::transport::ssh(3pm) [debian man page]
Net::CLI::Interact::Transport::SSH(3pm) User Contributed Perl Documentation Net::CLI::Interact::Transport::SSH(3pm) NAME
Net::CLI::Interact::Transport::SSH - SSH based CLI connection VERSION
version 1.121640 DECRIPTION
This module provides a wrapped instance of an SSH client for use by Net::CLI::Interact. INTERFACE
app On Windows platforms you must download the "plink.exe" program, and pass its location to the library in this parameter. On other platforms, this defaults to "ssh" (openssh). runtime_options Based on the "connect_options" hash provided to Net::CLI::Interact on construction, selects and formats parameters to provide to "app" on the command line. Supported attributes: host (required) Host name or IP address of the host to which the SSH application is to connect. Alternatively you can pass a value of the form "user@host", but it's probably better to use the separate "username" parameter instead. username Optionally pass in the username for the SSH connection, otherwise the SSH client defaults to the current user's username. When using this option, you should obviously only pass the host name to "host". ignore_host_checks Under normal interactive use "openssh" tracks the identity of connected hosts and verifies these identities upon each connection. In automation this behaviour can be irritating because it is interactive. This option, enabled by default, causes "openssh" to skip or ignore this host identity verification. This means the default setting is less secure, but also less likely to trip you up. It is equivalent to the following: StrictHostKeyChecking=no UserKnownHostsFile=/dev/null CheckHostIP=no Pass a false value to this option to disable the above and return "openssh" to its default configured settings. opts If you want to pass any other options to openssh on its command line, then use this option, which should be an array reference. Each item in the list will be passed to "openssh", separated by a single space character. For example: $s->new({ # ...other parameters to new()... connect_options => { opts => [ '-p', '222', # connect to non-standard port on remote host '-o', 'CheckHostIP=no', # don't check host IP in known_hosts file ], }, }); reap Only used on Unix platforms, this installs a signal handler which attempts to reap the "ssh" child process. Pass a true value to enable this feature only if you notice zombie processes are being left behind after use. COMPOSITION
See the following for further interface details: o Net::CLI::Interact::Transport AUTHOR
Oliver Gorwits <oliver@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Oliver Gorwits. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.14.2 2012-06-12 Net::CLI::Interact::Transport::SSH(3pm)
Check Out this Related Man Page
Net::CLI::Interact::Action(3pm) User Contributed Perl Documentation Net::CLI::Interact::Action(3pm) NAME
Net::CLI::Interact::Action - Sent data or matched response from connected device VERSION
version 1.121640 DESCRIPTION
This class is used internally by Net::CLI::Interact and it's unlikely that an end-user will need to make use of Action objects directly. The interface is documented here as a matter of record. An Action object represents either some kind of text or command to send to a connected device, or a regular expression matching the response from a connected device. Such Actions are built up into ActionSets which describe a conversation with the connected device. If the Action is a "send" type, then after execution it can be cloned and augmented with the response text of the command. If the response is likely to be paged, then the Action may also store instruction in how to trigger and consume the pages. INTERFACE
type Denotes the kind of Action, which may be "send" or "match". value In the case of "send", a String command to send to the device. In the case of "match", a regular expression reference to match response from the device. In special circumstances an array reference of regular expression references is also valid, and each will be checked for a match against the device response. no_ors Only applies to the "send" kind. Whether to skip appending the output record separator (newline) to the "send" command when sent to the connected device. continuation Only applies to the "send" kind. When response output is likely to be paged, this stores an ActionSet that contains two Actions: one for the "match" which indicates output has paused at the end of a page, and one for the "send" command which triggers printing of the next page. params Only applies to the "send" kind, and contains a list of parameters which are substituted into the "value" using Perl's "sprintf" function. Insufficient parameters causes "sprintf" to die. num_params Only applies to the "send" kind, and returns the number of parameters which are required for the current "value". Used for error checking when setting "params". response A stash for the returned prompt which matched and triggered the end of this action. response_stash A stash for the returned output following a "send" command, but not including the matched prompt which ended the action. This slot is used by the "match" action as it slurps output, but the content is then transferred over to the partner "send" in the ActionSet. prompt_hit When a command is successfully issued, the response is terminated by a prompt. However that prompt can be one of a list, defined in the Action. This slot records the regular expression from that list which was actually matched. clone Returns a new Action, which is a shallow clone of the existing one. All the reference based slots will share data, but you can add (for example) a "response" without affecting the original Action. Used when preparing to execute an Action which has been retrieved from the Phrasebook. AUTHOR
Oliver Gorwits <oliver@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Oliver Gorwits. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.14.2 2012-06-12 Net::CLI::Interact::Action(3pm)