Class: Ansible::Ruby::Modules::Win_command

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

Overview

The C(win_command) module takes the command name followed by a list of space-delimited arguments. The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like C($env:HOME) and operations like C(“<”), C(“>”), C(“|”), and C(“;”) will not work (use the M(win_shell) module if you need these features). For non-Windows targets, use the M(command) 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.



26
 
# File 'lib/ansible/ruby/modules/generated/windows/win_command.rb', line 26

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.



18
 
# File 'lib/ansible/ruby/modules/generated/windows/win_command.rb', line 18

attribute :creates

#free_form ⇒ Object

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

Returns:

  • (Object) —

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



14
 
# File 'lib/ansible/ruby/modules/generated/windows/win_command.rb', line 14

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.



22
 
# File 'lib/ansible/ruby/modules/generated/windows/win_command.rb', line 22

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.



30
 
# File 'lib/ansible/ruby/modules/generated/windows/win_command.rb', line 30

attribute :stdin