Class: Ansible::Ruby::Modules::Shell

Inherits:
Base show all
Includes:
FreeForm
Defined in:
lib/ansible/ruby/modules/generated/core/commands/shell.rb,
lib/ansible/ruby/modules/custom/commands/shell.rb

Overview

The M(shell) module takes the command name followed by a list of space-delimited arguments. It is almost exactly like the M(command) module but runs the command through a shell (C(/bin/sh)) on the remote node.

Instance Method Summary collapse

Methods included from FreeForm

included, #to_h

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#chdir ⇒ String?

Returns cd into this directory before running the command.

Returns:

  • (String, nil) —

    cd into this directory before running the command



22
 
# File 'lib/ansible/ruby/modules/generated/core/commands/shell.rb', line 22

attribute :chdir

#creates ⇒ String?

Returns a filename, when it already exists, this step will B(not) be run.

Returns:

  • (String, nil) —

    a filename, when it already exists, this step will B(not) be run.



15
 
# File 'lib/ansible/ruby/modules/generated/core/commands/shell.rb', line 15

attribute :creates

#executable ⇒ String?

Returns change the shell used to execute the command. Should be an absolute path to the executable.

Returns:

  • (String, nil) —

    change the shell used to execute the command. Should be an absolute path to the executable.



26
 
# File 'lib/ansible/ruby/modules/generated/core/commands/shell.rb', line 26

attribute :executable

#free_form ⇒ Object

Returns The shell module takes a free form command to run, as a string. There’s not an actual option named “free form”. See the examples!.

Returns:

  • (Object) —

    The shell module takes a free form command to run, as a string. There’s not an actual option named “free form”. See the examples!



11
 
# File 'lib/ansible/ruby/modules/generated/core/commands/shell.rb', line 11

attribute :free_form

#removes ⇒ Object?

Returns a filename, when it does not exist, this step will B(not) be run.

Returns:

  • (Object, nil) —

    a filename, when it does not exist, this step will B(not) be run.



19
 
# File 'lib/ansible/ruby/modules/generated/core/commands/shell.rb', line 19

attribute :removes

#warn ⇒ Boolean?

Returns if command warnings are on in ansible.cfg, do not warn about this particular line if set to no/false.

Returns:

  • (Boolean, nil) —

    if command warnings are on in ansible.cfg, do not warn about this particular line if set to no/false.



30
 
# File 'lib/ansible/ruby/modules/generated/core/commands/shell.rb', line 30

attribute :warn