Struct Cli 

pub struct Cli {

    pub destination: Option<String>,
    pub command: Option<Commands>,
    pub hosts: Option<Vec<String>>,
    pub filter: Option<String>,
    pub exclude: Option<Vec<String>>,
    pub cluster: Option<String>,
    pub config: PathBuf,
    pub user: Option<String>,
    pub identity: Option<PathBuf>,
    pub use_agent: bool,
    pub password: bool,
    pub sudo_password: bool,
    pub batch: bool,
    pub jump_hosts: Option<String>,
    pub parallel: usize,
    pub port: Option<u16>,
    pub stream: bool,
    pub no_prefix: bool,
    pub output_dir: Option<PathBuf>,
    pub verbose: u8,
    pub strict_host_key_checking: String,
    pub timeout: Option<u64>,
    pub connect_timeout: u64,
    pub server_alive_interval: Option<u64>,
    pub server_alive_count_max: Option<usize>,
    pub require_all_success: bool,
    pub check_all_nodes: bool,
    pub fail_fast: bool,
    pub any_failure: bool,
    pub pdsh_compat: bool,
    pub command_args: Vec<String>,
    pub ssh_options: Vec<String>,
    pub ssh_config: Option<PathBuf>,
    pub quiet: bool,
    pub force_tty: bool,
    pub no_tty: bool,
    pub no_x11: bool,
    pub ipv4: bool,
    pub ipv6: bool,
    pub query: Option<String>,
    pub local_forwards: Vec<String>,
    pub remote_forwards: Vec<String>,
    pub dynamic_forwards: Vec<String>,
}

Fields

destination: Option<String>

SSH destination in format: [user@]hostname[:port] or ssh://[user@]hostname[:port] Used for SSH compatibility mode (single host connection)

command: Option<Commands>

hosts: Option<Vec<String>>

filter: Option<String>

exclude: Option<Vec<String>>

cluster: Option<String>

config: PathBuf

user: Option<String>

identity: Option<PathBuf>

use_agent: bool

password: bool

sudo_password: bool

batch: bool

jump_hosts: Option<String>

parallel: usize

port: Option<u16>

stream: bool

no_prefix: bool

output_dir: Option<PathBuf>

verbose: u8

strict_host_key_checking: String

timeout: Option<u64>

connect_timeout: u64

server_alive_interval: Option<u64>

server_alive_count_max: Option<usize>

require_all_success: bool

check_all_nodes: bool

fail_fast: bool

any_failure: bool

pdsh_compat: bool

command_args: Vec<String>

ssh_options: Vec<String>

ssh_config: Option<PathBuf>

quiet: bool

force_tty: bool

no_tty: bool

no_x11: bool

ipv4: bool

ipv6: bool

query: Option<String>

local_forwards: Vec<String>

remote_forwards: Vec<String>

dynamic_forwards: Vec<String>

Implementations

impl Cli

pub fn get_command(&self) -> String

pub fn is_known_subcommand(arg: &str) -> bool

Check if the first command arg is a known subcommand

pub fn should_auto_exec(&self) -> bool

Determine if we should auto-execute a command

pub fn is_ssh_mode(&self) -> bool

Check if running in SSH compatibility mode (single host)

pub fn is_multi_server_mode(&self) -> bool

Check if running in multi-server mode

pub fn get_host_filter(&self) -> Option<&str>

Get the host filter pattern if specified

pub fn get_exclude_patterns(&self) -> Option<&[String]>

Get the host exclusion patterns if specified

pub fn parse_destination(&self) -> Option<(Option<String>, String, Option<u16>)>

Parse destination string into components (user, host, port)

pub fn get_effective_user(&self) -> Option<String>

Get effective username (from -l option, destination, or environment)

pub fn get_effective_port(&self) -> Option<u16>

Get effective port (from -p option, destination, SSH options, or default)

pub fn parse_ssh_options(&self) -> HashMap<String, String>

Parse SSH options into a map

pub fn parse_port_forwards(&self) -> Result<Vec<ForwardingType>, Error>

Parse port forwarding specifications into ForwardingType instances

Returns a Result containing a vector of all parsed forwarding specifications or an error if any specification is invalid.

pub fn has_port_forwards(&self) -> bool

Check if any port forwarding options are specified

pub fn port_forward_count(&self) -> usize

Get count of total port forwarding specifications

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.