ansible-doc
プラグインドキュメントツール
概要
usage: ansible-doc [-h] [--version] [-v] [-M MODULE_PATH]
[--playbook-dir BASEDIR]
[-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,role,keyword}]
[-j] [-r ROLES_PATH]
[-F | -l | -s | --metadata-dump | -e ENTRY_POINT]
[plugin ...]
説明
Ansible ライブラリーにインストールされているモジュールに関する情報を表示します。プラグインとその簡単な説明を表示し、DOCUMENTATION 文字列を出力します。これにより、Playbook に簡単に張り付けることができる短い「スニペット」を作成できます。
共通オプション
- --metadata-dump
内部テストのみ すべてのプラグインの json メタデータをダンプする。
- --playbook-dir <BASEDIR>
このツールは Playbook を使用しないため、代替の Playbook ディレクトリーとして使用します。これにより、roles/ group_vars/ などの多くの機能の相対パスが設定されます。
- --version
プログラムバージョン番号、設定ファイルの場所、設定したモジュール検索パス、モジュールの場所、実行可能な場所、および終了を表示します。
- -F, --list_files
要約なしでプラグイン名およびソースファイルを表示します (implmaries --list)。指定した引数は、名前空間または完全なコレクション名になります。
- -M, --module-path
モジュールライブラリーへのコロン区切りパス (デフォルトは ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules) を先頭に追加します。
- -e <ENTRY_POINT>, --entry-point <ENTRY_POINT>
ロールのエントリーポイントを選択します。
- -h, --help
ヘルプメッセージを表示して終了します。
- -j, --json
出力を json 形式に変更します。
- -l, --list
利用可能なプラグインを一覧表示します。指定された引数はフィルタリングに使用され、名前空間または完全コレクション名になります。
- -r, --roles-path
ロールを含むディレクトリーへのパス。
- -s, --snippet
指定されたプラグインの Playbook スニペットを表示します
- -t <TYPE>, --type <TYPE>
プラグインの種類 (デフォルトは「module」) を選択します。利用可能なプラグインの種類は :(「become」、「cache」、「callback」、「cliconf」、「connection」、「httpapi」、「inventory」、「lookup」、「netconf」、「shell」、「vars」、「module」、「strategy」、「role」、「keyword」) です。
- -v, --verbose
詳細モード (-vvv の場合はより詳細になる。-vvvv の場合は接続のデバッグを有効にする)
環境
以下の環境変数を指定できます。
ANSIBLE_CONFIG -- デフォルトの Ansible 設定ファイルを上書きします
ansible.cfg のほとんどのオプションで、さらに多くのものが利用できます。