Class: Ansible::Ruby::Modules::Script

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Script

Includes:

FreeForm

Defined in:

lib/ansible/ruby/modules/generated/commands/script.rb,
lib/ansible/ruby/modules/custom/commands/script.rb

Overview

The C(script) module takes the script name followed by a list of space-delimited arguments. The local script at path will be transferred to the remote node and then executed. The given script will be processed through the shell environment on the remote node. This module does not require python on the remote system, much like the M(raw) module. This module is also supported for Windows targets.

Instance Method Summary

• #chdir ⇒ Object^?

  Change into this directory on the remote node before running the script.

• #creates ⇒ String^?

  A filename on the remote node, when it already exists, this step will B(not) be run.

• #executable ⇒ String^?

  Name or path of a executable to invoke the script with.

• #free_form ⇒ Object

  Path to the local script file followed by optional arguments.,There is no parameter actually named ‘free form’, see the examples!.

• #removes ⇒ String^?

  A filename on the remote node, when it does not exist, this step will B(not) be run.

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 ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/commands/script.rb', line 28

attribute :chdir

#creates ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/commands/script.rb', line 20

attribute :creates

#executable ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/commands/script.rb', line 31

attribute :executable

#free_form ⇒ Object

# File 'lib/ansible/ruby/modules/generated/commands/script.rb', line 16

attribute :free_form

#removes ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/commands/script.rb', line 24

attribute :removes