mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-11-26 23:00:36 +00:00
71 lines
3.0 KiB
Python
71 lines
3.0 KiB
Python
|
# this is a virtual module that is entirely implemented server side
|
||
|
|
# Copyright: Ansible Project
|
||
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
|
|
||
|
|
from __future__ import absolute_import, division, print_function
|
||
|
|
__metaclass__ = type
|
||
|
|
|
||
|
|
|
||
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||
|
|
'status': ['stableinterface'],
|
||
|
|
'supported_by': 'core'}
|
||
|
|
|
||
|
|
|
||
|
|
DOCUMENTATION = '''
|
||
|
|
---
|
||
|
|
module: raw
|
||
|
|
short_description: Executes a low-down and dirty SSH command
|
||
|
|
version_added: historical
|
||
|
|
options:
|
||
|
|
free_form:
|
||
|
|
description:
|
||
|
|
- the raw module takes a free form command to run. There is no parameter actually named 'free form'; see the examples!
|
||
|
|
required: true
|
||
|
|
executable:
|
||
|
|
description:
|
||
|
|
- 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.
|
||
|
|
required: false
|
||
|
|
version_added: "1.0"
|
||
|
|
description:
|
||
|
|
- 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.
|
||
|
|
notes:
|
||
|
|
- "If using raw from a playbook, you may need to disable fact gathering
|
||
|
|
using C(gather_facts: no) if you're using C(raw) to bootstrap python
|
||
|
|
onto the machine."
|
||
|
|
- If you want to execute a command securely and predictably, it may be
|
||
|
|
better to use the M(command) or M(shell) modules instead.
|
||
|
|
- the C(environment) keyword does not work with raw normally, it requires a shell
|
||
|
|
which means it only works if C(executable) is set or using the module
|
||
|
|
with privilege escalation (C(become)).
|
||
|
|
- This module is also supported for Windows targets.
|
||
|
|
author:
|
||
|
|
- Ansible Core Team
|
||
|
|
- Michael DeHaan
|
||
|
|
'''
|
||
|
|
|
||
|
|
EXAMPLES = '''
|
||
|
|
- name: Bootstrap a host without python2 installed
|
||
|
|
raw: dnf install -y python2 python2-dnf libselinux-python
|
||
|
|
|
||
|
|
- name: Run a command that uses non-posix shell-isms (in this example /bin/sh doesn't handle redirection and wildcards together but bash does)
|
||
|
|
raw: cat < /tmp/*txt
|
||
|
|
args:
|
||
|
|
executable: /bin/bash
|
||
|
|
|
||
|
|
- name: safely use templated variables. Always use quote filter to avoid injection issues.
|
||
|
|
raw: "{{package_mgr|quote}} {{pkg_flags|quote}} install {{python|quote}}"
|
||
|
|
'''
|