Class: Ansible::Ruby::Modules::Win_shell

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_shell.rb

Overview

The C(win_shell) module takes the command name followed by a list of space-delimited arguments. It is similar to the M(win_command) module, but runs the command via a shell (defaults to PowerShell) on the target host. For non-Windows targets, use the M(shell) module instead.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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 Set the specified path as the current working directory before executing a command.

Returns:

  • (String, nil) —

    Set the specified path as the current working directory before executing a command



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shell.rb', line 25

attribute :chdir

#creates ⇒ String?

Returns A path or path filter pattern; when the referenced path exists on the target host, the task will be skipped.

Returns:

  • (String, nil) —

    A path or path filter pattern; when the referenced path exists on the target host, the task will be skipped.



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shell.rb', line 17

attribute :creates

#executable ⇒ String?

Returns Change the shell used to execute the command (eg, C(cmd)).,The target shell must accept a C(/c) parameter followed by the raw command line to be executed.

Returns:

  • (String, nil) —

    Change the shell used to execute the command (eg, C(cmd)).,The target shell must accept a C(/c) parameter followed by the raw command line to be executed.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shell.rb', line 29

attribute :executable

#free_form ⇒ Object

Returns The C(win_shell) module takes a free form command to run.,There is no parameter actually named ‘free form’. See the examples!.

Returns:

  • (Object) —

    The C(win_shell) module takes a free form command to run.,There is no parameter actually named ‘free form’. See the examples!



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shell.rb', line 13

attribute :free_form

#removes ⇒ String?

Returns A path or path filter pattern; when the referenced path B(does not) exist on the target host, the task will be skipped.

Returns:

  • (String, nil) —

    A path or path filter pattern; when the referenced path B(does not) exist on the target host, the task will be skipped.



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shell.rb', line 21

attribute :removes

#stdin ⇒ String?

Returns Set the stdin of the command directly to the specified value.

Returns:

  • (String, nil) —

    Set the stdin of the command directly to the specified value.



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shell.rb', line 33

attribute :stdin