Sha256: 37067f00fb1394639e032b2857bb47a772e53118fc321007c5eeb7913b436787

Contents?: true

Size: 1.62 KB

Versions: 115

Compression:

Stored size: 1.62 KB

Contents

Beaker commands are executed through an ssh connection to each individual SUT.  Various options are supported during command execution that control how the commands themselves are executed, what output is generated and how results are interpreted.

## :acceptable_exit_codes

Provide either a single or an array of acceptable/passing exit codes for the provided command.  Defaults to the single exit code `0`.

    on host, puppet( 'agent -t' ), :acceptable_exit_codes => [0,1,2]

## :accept_all_exit_codes

Consider any exit codes returned by the command to be acceptable/passing.  Defaults to `nil`/`false`.

    on host, puppet( 'agent -t' ), :accept_all_exit_codes => true

## :expect_connection_failure

Assume that this command will cause a connection failure.  Used for `host.reboot` so that Beaker can handle the broken ssh connection.

    on host, "reboot", {:expect_connection_failure => true}

## :dry_run

Do not actually execute this command on the SUT.  Defaults to `false`.

    on host, "don't do this crazy thing", {:dry_run => true}

## :pty

Should this command be executed in a pseudoterminal?  Defaults to `false`.

    on host, "sudo su -c \"service ssh restart\"", {:pty => true})

## :silent

Do not output any logging for this command.  Defaults to `false`.

    on host, "echo hello", {:silent => true}

## :stdin

Specifies standard input to be provided to the command post execution.  Defaults to `nil`.

    on host, "this command takes input", {:stdin => "hiya"}

## [:run_in_parallel](../how_to/run_in_parallel.md)

Execute the command against all hosts in parallel

    on hosts, puppet( 'agent -t' ), :run_in_parallel => true

Version data entries

115 entries across 115 versions & 1 rubygems

Version Path
beaker-6.4.1 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-6.4.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-6.3.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-6.2.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-6.1.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.8.1 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-4.42.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.8.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.7.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-4.41.2 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-4.41.1 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.6.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-4.41.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.5.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.4.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.3.1 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-4.40.2 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.3.0 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-4.40.1 docs/concepts/shared_options_for_executing_beaker_commands.md
beaker-5.2.0 docs/concepts/shared_options_for_executing_beaker_commands.md