Commit graph

176 commits

Author SHA1 Message Date
Brian Coca 18a7a1ec31 added docs to CLI docstringsadded
removed 'now intermediate build files' from repo
adjusted gitignore
2017-03-24 15:52:36 -04:00
Brian Coca 6b8347ec60 updated doc man page 2017-03-23 01:27:19 -04:00
Harlan Lieberman-Berg e24ddb4980 Add manpage for ansible-console. (Closes: #16244) (#16245)
* Add manpage for ansible-console. (Closes: #16244)

* Mark host as an optional field in ansible-console.1
2017-03-08 11:04:35 -05:00
Chris Houseknecht d20d528dbd Adds --role-skeleton to ansible-galaxy man page (#22199) 2017-03-02 12:10:38 -05:00
Carlos E. Garcia 0b8011436d minor spelling changes 2016-12-13 13:51:13 -05:00
Samuel Boucher b17149f3bf Update ansible.1.asciidoc.in (#18464)
* Update ansible.1.asciidoc.in

fix typo to match ansible --help
--su-user and not --se-user

* Update ansible.1.asciidoc.in
2016-11-11 08:58:19 -05:00
Chris Houseknecht dceb2a0393 Remove extra display statements and add docs (#18229)
* Add docs for ansible-galaxy import --role-name option.

* Add docs for ansible-galaxy init --container-enabled option.
2016-10-28 00:38:39 -04:00
Brian Coca db8c952ee3 added new ksu method to man page
removed runas refrences, because it was never implemented
2016-09-13 14:40:41 -04:00
Adrian Likins 6fdd8c4a98 Fix the doctype attribute in man page asciidocs (#16696)
The asciidoc.in sources had an attribute like:

:doctype:manpage

That attribute was not being correctly rendered in a2x
resulting in the 'doctype:manpage' showing up in a spurious
additional AUTHOR section at the end of the generated man pages like:

AUTHOR
       :doctype:manpage

Fix with correct formatting of 'doctype' attribute.
2016-07-29 15:59:35 -04:00
Andrew Gaffney 4fd87f2dc6 Fix typo on -K/--ask-become-pass option in 'ansible' man page (#16667) 2016-07-11 00:15:05 +02:00
Shota 47f715fb37 Fix some typos (#16498) 2016-06-29 14:31:25 -04:00
Brian Coca dae0b833f5 updated man page with new pull options 2016-06-23 09:14:55 -04:00
Scott Radvan 72ca3b2b5b add very minor punctuation fixes (#15763) 2016-05-09 10:12:24 -04:00
Brian Coca e0573d3099 make vi the default editor if no EDITOR
fixes #15577
2016-05-03 09:39:19 -04:00
Tegan Snyder bf0da4aa3c add centrify dzdo escalation (#15219)
add dzdo context, and test
2016-04-25 11:24:26 -04:00
Brian Coca 0cabef19ad updated man pages with imssing become option
also moved -K to become password to align with current code
fixes #15123
2016-03-23 09:30:48 -07:00
Abhijit Menon-Sen f82639e4a2 Fix the other typo from #15036 2016-03-18 21:08:41 +05:30
Brian Coca 95495a6b38 fixed typo
fixes #15036
2016-03-18 08:35:00 -07:00
yyoshiki41 64f445f3a1 Fixed docs typo 2016-03-03 03:19:46 +09:00
Maxim Burgerhout 275bd1b121 Fix a typo in man1/ansible 2016-02-18 08:29:58 +01:00
Aleksi Aalto aea8900abe document exit status for ansible-playbook 2016-02-15 01:54:52 +02:00
Denis 4e95c9f1eb Fix typos. 2016-01-15 21:01:05 +01:00
James Cammarata 76b4b9ed2c Merge pull request #13501 from chouseknecht/galaxy-2.0-update
Galaxy 2.0 update
2015-12-16 15:01:12 -05:00
Robin Roth 0c954bd142 add --full flag to ansible-pull man page
add --full flag that was added in #13502
2015-12-13 18:00:54 +01:00
chouseknecht 06dde0d332 Fixed documentation typos and bits that needed clarification. Fixed missing spaces in VALID_ACTIONS. 2015-12-13 05:23:04 -05:00
chouseknecht bc73920090 Updated ansible-galaxy man page. Removed -b option for import. 2015-12-13 05:23:04 -05:00
Brian Coca 9f148fc046 removed requirement of destination and set documented default 2015-10-29 16:28:46 -04:00
Brian Coca 2e05304f66 typo fix 2015-10-27 20:02:40 -04:00
Brian Coca 8eda94c591 normalized descriptions for most man pages
also removed the intermediate man page
added intermidieate manpages to gitignore
2015-10-26 11:03:50 -04:00
Abhijit Menon-Sen 3ad9b4cba6 Rework additional ssh argument handling
Now we have the following ways to set additional arguments:

1. [ssh_connection]ssh_args in ansible.cfg: global setting, prepended to
   every command line for ssh/scp/sftp. Overrides default ControlPersist
   settings.
2. ansible_ssh_common_args inventory variable. Appended to every command
   line for ssh/scp/sftp. Used in addition to ssh_args, if set above, or
   the default settings.
3. ansible_{sftp,scp,ssh}_extra_args inventory variables. Appended to
   every command line for the relevant binary only. Used in addition to
   #1 and #2, if set above, or the default settings.
3. Using the --ssh-common-args or --{sftp,scp,ssh}-extra-args command
   line options (which are overriden by #2 and #3 above).

This preserves backwards compatibility (for ssh_args in ansible.cfg),
but also permits global settings (e.g. ProxyCommand via _common_args) or
ssh-specific options (e.g. -R via ssh_extra_args).

Fixes #12576
2015-10-02 21:26:25 +05:30
James Cammarata 6650ba7654 Squashed commit of the following:
commit 9921bb9d20
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:19:44 2015 +0530

    Document --ssh-extra-args command-line option

commit 8b25595e7b
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Thu Aug 13 13:24:57 2015 +0530

    Don't disable GSSAPI/Pubkey authentication when using --ask-pass

    This commit is based on a bug report and PR by kolbyjack (#6846) which
    was subsequently closed and rebased as #11690. The original problem was:

        «The password on the delegated host is different from the one I
        provided on the command line, so it had to use the pubkey, and the
        main host doesn't have a pubkey on it yet, so it had to use the
        password.»

    (This commit is revised and included here because #11690 would conflict
    with the changes in #11908 otherwise.)

    Closes #11690

commit 119d032389
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Thu Aug 13 11:16:42 2015 +0530

    Be more explicit about why SSH arguments are added

    This adds vvvvv log messages that spell out in detail where each SSH
    command-line argument is obtained from.

    Unfortunately, we can't be sure if, say, self._play_context.remote_user
    is obtained from ANSIBLE_REMOTE_USER in the environment, remote_user in
    ansible.cfg, -u on the command line, or an ansible_ssh_user setting in
    the inventory or on a task or play. In some cases, e.g. timeout, we
    can't even be sure if it was set by the user or just a default.

    Nevertheless, on the theory that at five v's you can use all the hints
    available, I've mentioned the possible sources in the log messages.

    Note that this caveat applies only to the arguments that ssh.py adds by
    itself. In the case of ssh_args and ssh_extra_args, we know where they
    are from, and say so, though we can't say WHERE in the inventory they
    may be set (e.g. in host_vars or group_vars etc.).

commit b605c285ba
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Tue Aug 11 15:19:43 2015 +0530

    Add a FAQ entry about ansible_ssh_extra_args

commit 49f8edd035
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:48:50 2015 +0530

    Allow ansible_ssh_args to be set as an inventory variable

    Before this change, ssh_args could be set only in the [ssh_connection]
    section of ansible.cfg, and was applied to all hosts. Now it's possible
    to set ansible_ssh_args as an inventory variable (directly, or through
    group_vars or host_vars) to selectively override the global setting.

    Note that the default ControlPath settings are applied only if ssh_args
    is not set, and this is true of ansible_ssh_args as well. So if you want
    to override ssh_args but continue to set ControlPath, you'll need to
    repeat the appropriate options when setting ansible_ssh_args.

    (If you only need to add options to the default ssh_args, you may be
    able to use the ansible_ssh_extra_args inventory variable instead.)

commit 37c1a5b679
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 19:42:30 2015 +0530

    Allow overriding ansible_ssh_extra_args on the command-line

    This patch makes it possible to do:

        ansible somehost -m setup \
            --ssh-extra-args '-o ProxyCommand="ssh -W %h:%p -q user@bouncer.example.com"'

    This overrides the inventory setting, if any, of ansible_ssh_extra_args.

    Based on a patch originally by @Richard2ndQuadrant.

commit b023ace8a8
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 19:06:19 2015 +0530

    Add an ansible_ssh_extra_args inventory variable

    This can be used to configure a per-host or per-group ProxyCommand to
    connect to hosts through a jumphost, e.g.:

        inventory:
            [gatewayed]
            foo ansible_ssh_host=192.0.2.1

        group_vars/gatewayed.yml:
            ansible_ssh_extra_args: '-o ProxyCommand="ssh -W %h:%p -q bounceuser@gateway.example.com"'

    Note that this variable is used in addition to any ssh_args configured
    in the [ssh_connection] section of ansible.cfg (so you don't need to
    repeat the ControlPath settings in ansible_ssh_extra_args).
2015-09-03 11:26:56 -04:00
Abhijit Menon-Sen 4afe1cf422 Update ansible-vault manpage to describe new encrypt/decrypt behaviour 2015-08-27 22:04:18 +05:30
Richard Poole 3090a45891 add option to ansible-vault to read new password from file for rekey
The --new-vault-password-file option works the same as
--vault-password-file but applies only to rekeying (when
--vault-password-file sets the old password). Also update the manpage
to document these options more fully.
2015-08-25 21:14:49 +05:30
Damian Gerow 1c5611100e Add become support for OpenBSD doas 2015-08-17 21:31:18 -04:00
snetting 15669d98ca correct ansible-playbook man1 2015-07-23 08:39:01 +01:00
snetting 4693531851 update ansible man1 2015-07-22 09:56:50 +01:00
Till Maas f36a92f729 Re-Generate man pages 2015-05-05 16:55:09 +02:00
Till Maas 8ad2eac7e1 Mention ANSIBLE_INVENTORY
Support for ANSIBLE_HOSTS is faded out, see commit
c73254543a, therefore do not mention it in
the man pages.
2015-05-05 16:54:32 +02:00
Chris AtLee 1bf8f78b18 Add --list-hosts to man pages.
Fixes #9574
2015-02-27 08:38:45 -05:00
Brian Coca f734306c13 Merge pull request #9859 from autotune/devel
Added description for -S flag and --ask-su-pass #9846
2015-02-26 22:51:35 -05:00
Giovanni Tirloni bcbf819a8b Add how to load extra variables directly from a file (using @). 2015-02-12 21:31:56 -05:00
mixpix3ls 8866378e89 Fixing ticket 9845: man pages contain duplicate AUTHOR section 2015-02-08 22:04:18 -06:00
autotune d052bf8276 Added description for -S flag and --ask-su-pass 2014-12-18 16:42:57 -06:00
Toshio Kuratomi fa51e8f36d Document the --offline parameter to galaxy init
Fixes #9758
2014-12-09 10:50:10 -08:00
Michael Scherer 9c10a11aea Fix the synopsis in ansible-pull man page. 2014-10-22 15:40:41 -04:00
Michael DeHaan e43ae3c0f7 Update test strategies guide. 2014-05-26 08:12:39 -04:00
Cristian Ciupitu 7cb4b7ab89 Fix typos in ansible-playbook man page source
Note: the man page needs to be rebuilt.
2014-04-14 01:22:18 +03:00
James Tanner 33eec0dc55 Fixes #6398 Add missing parameters to ansible-playbook manpage 2014-03-31 16:49:09 -04:00
James Cammarata 12c812f030 Adding a man page for ansible-vault
Fixes #6471
2014-03-17 10:02:54 -05:00
James Cammarata ba4fbd2b66 Adding man page for ansible-galaxy
Partially resolves #6471
2014-03-16 14:00:50 -05:00