Class: Ansible::Ruby::Modules::Raw
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Raw
- Includes:
- FreeForm
- Defined in:
- lib/ansible/ruby/modules/generated/commands/raw.rb,
lib/ansible/ruby/modules/custom/commands/raw.rb
Overview
Executes a low-down and dirty SSH command, not going through the module subsystem. This is useful and should only be done in a few cases. A common case is installing C(python) on a system without python installed by default. Another is speaking to any devices such as routers that do not have any Python installed. In any other case, using the M(shell) or M(command) module is much more appropriate. Arguments given to C(raw) are run directly through the configured remote shell. Standard output, error output and return code are returned when available. There is no change handler support for this module. This module does not require python on the remote system, much like the M(script) module. This module is also supported for Windows targets.
Instance Method Summary collapse
-
#executable ⇒ String?
Change the shell used to execute the command.
-
#free_form ⇒ Object
The raw module takes a free form command to run.
Methods included from FreeForm
Methods inherited from Base
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
#executable ⇒ String?
Returns change the shell used to execute the command. Should be an absolute path to the executable.,when using privilege escalation (C(become)), a default shell will be assigned if one is not provided as privilege escalation requires a shell.
18 |
# File 'lib/ansible/ruby/modules/generated/commands/raw.rb', line 18 attribute :executable |
#free_form ⇒ Object
Returns the raw 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/commands/raw.rb', line 14 attribute :free_form |