かべぎわブログ

技術的なことについてかけたらいいな…

ansible-docをつかってコンソールからmoduleの詳細を確認する

みなさんしってるかもしれませんが自分は知らなかったので展開します。

ansible-docsというコマンドがあります。
これを利用することでコンソールからコマンドで各moduleの詳細を確認することができます。
manみたいなかんじです。

実際にやってみる

たとえば以下のような感じです。
copyについて調べてみようと思います。

以下を実行すると…

$ ansible-doc copy

こんなかんじでcopymoduleの詳細を確認することができます。

> COPY    (/usr/lib/python2.7/site-packages/ansible/modules/files/copy.py)

        The `copy' module copies a file from the local or remote machine to a location on the remote machine. Use the [fetch] module to copy
        files from remote locations to the local box. If you need variable interpolation in copied files, use the [template] module. For Windows
        targets, use the [win_copy] module instead.

  * note: This module has a corresponding action plugin.

OPTIONS (= is mandatory):

- attributes
        Attributes the file or directory should have. To get supported flags look at the man page for `chattr' on the target system. This string
        should contain the attributes in the same order as the one displayed by `lsattr'.
        (Aliases: attr)[Default: None]
        version_added: 2.3

- backup
        Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
        [Default: no]
        type: bool
        version_added: 0.7

- content
        When used instead of `src', sets the contents of a file directly to the specified value. For anything advanced or with formatting also
        look at the template module.
        [Default: (null)]
        version_added: 1.1
~~~省略~~~

おわりに

ブラウザで公式ドキュメントを開く必要がなくなりますね!
おためしあれ!!!

入門Ansible

入門Ansible