Struct PdshCli 

pub struct PdshCli {
    pub hosts: Option<String>,
    pub exclude: Option<String>,
    pub fanout: usize,
    pub user: Option<String>,
    pub connect_timeout: Option<u64>,
    pub command_timeout: Option<u64>,
    pub no_prefix: bool,
    pub batch: bool,
    pub fail_fast: bool,
    pub query: bool,
    pub any_failure: bool,
    pub command: Vec<String>,
}

pdsh-compatible CLI parser

This struct captures pdsh command-line arguments and can be converted to the standard bssh Cli structure.

Fields

hosts: Option<String>

Target hosts (comma-separated or host[range] notation)

Accepts comma-separated hostnames or pdsh-style ranges like host[1-5].

exclude: Option<String>

Exclude hosts from target list (comma-separated)

fanout: usize

Fanout (number of parallel connections)

Sets the maximum number of concurrent SSH connections. Default is 32 to match pdsh default.

user: Option<String>

Remote username

connect_timeout: Option<u64>

Connect timeout in seconds

command_timeout: Option<u64>

Command timeout in seconds

no_prefix: bool

Disable hostname prefix in output

batch: bool

Batch mode (single Ctrl+C terminates)

fail_fast: bool

Fail fast (stop on first failure)

When enabled, cancels remaining commands if any host fails.

query: bool

Query mode - show target hosts and exit

Lists all hosts that would be targeted without executing any command.

any_failure: bool

Return exit status of any failing node

When enabled, returns the largest exit code from any node.

command: Vec<String>

Command to execute (trailing arguments)

Implementations

impl PdshCli

pub fn parse_args() -> Self

Parse pdsh-style arguments from command line.

Returns

Parsed PdshCli instance

pub fn parse_from_args<I, T>(args: I) -> Self

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

Parse pdsh-style arguments from a specific argument list.

Arguments

• args - Iterator over command-line arguments

Returns

Parsed PdshCli instance

pub fn is_query_mode(&self) -> bool

Returns whether this is a query-only request (show hosts and exit).

pub fn has_command(&self) -> bool

Returns whether a command was specified.

pub fn get_command(&self) -> String

Gets the command as a single string.

pub fn to_bssh_cli(&self) -> Cli

Converts pdsh CLI options to bssh CLI options.

This method creates a bssh Cli instance with all options mapped from their pdsh equivalents.

Returns

A Cli instance with options mapped from pdsh arguments

Trait Implementations

impl Args for PdshCli

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 Clone for PdshCli

fn clone(&self) -> PdshCli

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for PdshCli

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 PdshCli

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

Formats the value using the given formatter.

impl FromArgMatches for PdshCli

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 PdshCli

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.