5.3. 查看自动化内容导航器中的文档

流程

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

   

   有关如何设置编辑器的详情，请查看 第 8.2 节 “自动化内容导航器常规设置”。