ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-28 03:00:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Slight cleanup to adhoc chapter.

Browse source
This commit is contained in:
Michael DeHaan 2013-10-02 21:41:46 -04:00
parent a8ff828593
commit e0af80946b
1 changed files with 25 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

37
docsite/latest/rst/intro_adhoc.rst
View file

@ -5,28 +5,41 @@ Introduction To Ad-Hoc Commands
.. highlight:: bash .. highlight:: bash
The following examples show how to use `/usr/bin/ansible` for running The following examples show how to use `/usr/bin/ansible` for running
ad hoc tasks. ad hoc tasks.
What's an ad-hoc command?
An ad-hoc command is something that you might type in to do something really
quick, but don't want to save for later.
This is a good place to start to understand the basics of what ansible can do This is a good place to start to understand the basics of what ansible can do
prior to learning the playbooks language, but ad-hoc commands can also be used prior to learning the playbooks language -- ad-hoc commands can also be used
to do quick things that you might not neccessarily want to write a full playbook to do quick things that you might not neccessarily want to write a full playbook
for. for.
Generally speaking, the true power of Ansible lies in playbooks.
Why would you use ad-hoc tasks versus playbooks? Why would you use ad-hoc tasks versus playbooks?
For instance, if you wanted to power off all of your lab for Christmas vacation, For instance, if you wanted to power off all of your lab for Christmas vacation,
you could execute a quick one-liner in Ansible without writing a playbook. you could execute a quick one-liner in Ansible without writing a playbook.
For configuration management and deployments, though you'll want to pick up on For configuration management and deployments, though, you'll want to pick up on
using '/usr/bin/ansible-playbook' -- the concepts port over directly. using '/usr/bin/ansible-playbook' -- the concepts you will learn here will
port over directly to the playbook language.
(See :doc:`playbooks` for more information about those) (See :doc:`playbooks` for more information about those)
If you haven't read `intro_inventroy` already, please look that over a bit first
and then we'll get going.
.. contents:: .. contents::
:depth: 2 :depth: 2
Parallelism and Shell Commands Parallelism and Shell Commands
`````````````````````````````` ``````````````````````````````
Arbitrary example.
Let's use ansible's command line tool to reboot all web servers in Atlanta, 10 at a time. First, let's Let's use ansible's command line tool to reboot all web servers in Atlanta, 10 at a time. First, let's
set up SSH-agent so it can remember our credentials:: set up SSH-agent so it can remember our credentials::
@ -43,13 +56,11 @@ Now to run the command on all servers in a group, in this case,
$ ansible atlanta -a "/sbin/reboot" -f 10 $ ansible atlanta -a "/sbin/reboot" -f 10
/usr/bin/ansible will default to running from your user account. If you do not like this /usr/bin/ansible will default to running from your user account. If you do not like this
behavior, pass in "-u username". behavior, pass in "-u username". If you want to run commands as a different user, it looks like this::
If you want to run commands as a different user, it looks like this::
$ ansible atlanta -a "/usr/bin/foo" -u username $ ansible atlanta -a "/usr/bin/foo" -u username
If you want to run commands through sudo:: Often you'll not want to just do things from your user account. If you want to run commands through sudo::
$ ansible atlanta -a "/usr/bin/foo" -u username --sudo [--ask-sudo-pass] $ ansible atlanta -a "/usr/bin/foo" -u username --sudo [--ask-sudo-pass]
@ -66,9 +77,12 @@ It is also possible to sudo to a user other than root using
Ok, so those are basics. If you didn't read about patterns and groups yet, go back and read :doc:`intro_patterns`. Ok, so those are basics. If you didn't read about patterns and groups yet, go back and read :doc:`intro_patterns`.
The ``-f 10`` in the above specifies the usage of 10 simultaneous The ``-f 10`` in the above specifies the usage of 10 simultaneous
processes to use. You can also set this in `intro_config` to avoid setting it again. processes to use. You can also set this in `intro_config` to avoid setting it again. The default is actually 5, which
is really small and conservative. You are probably going to want to talk to a lot more simultaneous hosts so feel free
to crank this up. If you have more hosts than the value set for the fork count, Ansible will talk to them, but it will
take a little longer. Feel free to push this value as high as your system can handle it!
Normally commands also take a ``-m`` for module name, but You can also select what ansible "module" you want to urn. Normally commands also take a ``-m`` for module name, but
the default module name is 'command', so we didn't need to the default module name is 'command', so we didn't need to
specify that all of the time. We'll use ``-m`` in later examples to specify that all of the time. We'll use ``-m`` in later examples to
run some other :doc:`modules`. run some other :doc:`modules`.
@ -229,12 +243,11 @@ system. These can be used to implement conditional execution of tasks but also
Its also possible to filter this output to just export certain facts, see the "setup" module documentation for details. Its also possible to filter this output to just export certain facts, see the "setup" module documentation for details.
Read more about facts at `playbooks_variables` once you're ready to read up on `playbooks`.
Limiting Selected Hosts Limiting Selected Hosts
``````````````````````` ```````````````````````
.. versionadded:: 0.7
What hosts you select to manage can be additionally constrained by using the '--limit' parameter or What hosts you select to manage can be additionally constrained by using the '--limit' parameter or
by using 'batch' (or 'range') selectors. by using 'batch' (or 'range') selectors.