5.3. 自動化コンテンツナビゲーターのドキュメントの確認

対話モードで自動化コンテンツナビゲーターのテキストベースのユーザーインターフェイスを使用して、コレクションおよびプラグインの Ansible ドキュメントを確認できます。自動化コンテンツナビゲーターは、現在のプロジェクトディレクトリー内のコレクションと自動化実行環境で利用可能なコレクションを表示します。

前提条件

  • ローカルでアクセス可能なコレクションまたはインストールされた自動化実行環境。

手順

  1. 自動化コンテンツナビゲーターを起動します。 

    $ ansible-navigator

  2. 対象のモジュールを確認します。または、ansible-navigator doc と入力してドキュメントにアクセスすることもできます。 

    :doc ansible.utils.ip_address
    ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address
 0│---
 1│additional_information: {}
 2│collection_info:
 3│  authors:
 4│  - Ansible Community
 5│  dependencies: {}
 6│  description: Ansible Collection with utilities to ease the management, manipulation,
 7│    and validation of data within a playbook
 8│  documentation: null
 9│  homepage: null
10│  issues: null
11│  license: []
12│  license_file: LICENSE
13│  name: ansible.utils
14│  namespace: ansible
15│  path:/usr/share/ansible/collections/ansible_collections/ansible/utils/
16│  readme: README.md
<... output truncated...>

  3. このモジュールのドキュメント例に移動します。 

    :{{ examples }}

0│
1│
2│#### Simple examples
3│
4│- name: Check if 10.1.1.1 is a valid IP address
5│  ansible.builtin.set_fact:
6│    data: "{{ '10.1.1.1' is ansible.utils.ip_address }}"
7│
8│# TASK [Check if 10.1.1.1 is a valid IP address] *********************
9│# ok: [localhost] => {
10│#     "ansible_facts": {
11│#         "data": true
12│#     },
13│#     "changed": false
14│# }
15│

  4. オプション: エディターでサンプルを開き、それを Playbook にコピーします。 

    :open
    Documentation example in editor

    エディターの設定方法の詳細は 「自動化コンテンツナビゲーターの一般設定」 を参照してください。

関連情報