Chapter 5. Browsing collections with Automation content navigator

Procedure

1. Start Automation content navigator

   $ ansible-navigator

   Copy to Clipboard Toggle word wrap

2. Browse the collection. Alternately, you can type ansible-navigator collections to directly browse the collections.

   $ :collections

   Copy to Clipboard Toggle word wrap
   

   View larger image

   

3. Type the number of the collection you want to explore.

   :4

   Copy to Clipboard Toggle word wrap
   

   View larger image

   

4. Type the number corresponding to the module you want to delve into.

   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...>

   Copy to Clipboard Toggle word wrap

5. Optional: jump to the documentation examples for this module.

   :{{ 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│

   Copy to Clipboard Toggle word wrap

6. Optional: open the example in your editor to copy it into a playbook.

   :open

   Copy to Clipboard Toggle word wrap
   

   View larger image

   

Procedure

1. Start Automation content navigator

   $ ansible-navigator

   Copy to Clipboard Toggle word wrap

2. Review the module you are interested in. Alternately, you can type ansible-navigator doc to access the documentation.

   :doc ansible.utils.ip_address

   Copy to Clipboard Toggle word wrap

   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...>

   Copy to Clipboard Toggle word wrap

3. Jump to the documentation examples for this module.

   :{{ 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│

   Copy to Clipboard Toggle word wrap

4. Optional: open the example in your editor to copy it into a playbook.

   :open

   Copy to Clipboard Toggle word wrap
   

   View larger image

   

   See Section 8.2, “Automation content navigator general settings” for details on how to set up your editor.