• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Documentation
Ansible Navigator
latest

Installation

  • Installing ansible-navigator with execution environment support
    • Linux
      • Requirements
      • Install the desired container engine for execution environment support
      • Install ansible-navigator
    • macOS
      • Requirements
      • Install the desired container engine for execution environment support
      • Install ansible-navigator
    • Windows with WSL2
      • Requirements
      • Setup Windows Subsystem for Linux 2 with Ubuntu
      • Install the desired container engine for execution environment support
      • Install ansible-navigator

Configuration

  • ansible-navigator settings
    • The ansible-navigator settings file

Usage

  • ansible-navigator subcommands
    • ansible-navigator subcommand overview
    • Mapping ansible-navigator commands to ansible commands
  • Frequently asked questions
    • The ansible.cfg file
      • Where should the ansible.cfg file go when using an execution environment?
      • Where should the ansible.cfg file go when not using an execution environment?
    • Placement of ansible collections
      • Where should ansible collections be placed when using an execution environment?
      • Where should ansible collections be placed when not using an execution environment?
    • ansible-navigator settings
      • What is the order in which configuration settings are applied?
      • Why does ansible-navigator change the terminal colors or look terrible?
      • How can I change the colors used by ansible-navigator
      • What’s with all these site-artifact-2021-06-02T16:02:33.911259+00:00.json files in the playbook directory?
      • Why does vi open when I use :open?
      • How do I define volume mounts using an environment variable?
      • How can tls-verify be disabled when an execution environment image is being pulled?
    • SSH keys
      • How do I use my SSH keys with an execution environment?
    • Compatibility with ansible-* utilities
      • Why does the playbook hang when vars_prompt, pause/prompt or --ask-pass is used?
      • How can I use ansible-test without having it locally installed?
      • How do I use ansible-playbook parameters like --forks 15?
      • How can I use a vault password with ansible-navigator?
    • Other
      • How can complex commands be run inside an execution-environment?
      • Why did I get an error about /dev/mqueue missing?
      • Something didn’t work, how can I troubleshoot it?
  • Changelog
    • v2.1.1.dev7+g5c64235.d20220629, as of June 29, 2022 /UNRELEASED DRAFT/
      • Bugfixes
      • Features
      • Backward incompatible changes
      • Miscellaneous
      • Contributor-facing changes

Contributions

  • Code Of Conduct
  • Security Policy
    • Supported Versions
    • Reporting a Vulnerability
  • Contributing to Ansible Navigator
  • Contributing docs
    • Adding change notes with your PRs
    • Alright! So how do I add a news fragment?
    • Examples for changelog entries adding to your Pull Requests
  • Private unsupported (dev) API autodoc
    • ansible_navigator package
      • Subpackages
      • Submodules
      • Module contents
Ansible Navigator
  • »
  • Ansible Navigator Documentation
  • Edit on GitHub

Ansible Navigator Documentation

ansible-navigator is a command based tool for creating, reviewing, and troubleshooting Ansible content, including inventories, playbooks, and collections.

A text-based user interface (TUI) for the Red Hat Ansible Automation Platform.

A demo of the interface can be found on youtube.

Installation

  • Installing ansible-navigator with execution environment support
    • Linux
    • macOS
    • Windows with WSL2

Configuration

  • ansible-navigator settings
    • The ansible-navigator settings file

Usage

  • ansible-navigator subcommands
    • ansible-navigator subcommand overview
    • Mapping ansible-navigator commands to ansible commands
  • Frequently asked questions
    • The ansible.cfg file
    • Placement of ansible collections
    • ansible-navigator settings
    • SSH keys
    • Compatibility with ansible-* utilities
    • Other
  • Changelog
    • v2.1.1.dev7+g5c64235.d20220629, as of June 29, 2022 /UNRELEASED DRAFT/
      • Bugfixes
      • Features
      • Backward incompatible changes
      • Miscellaneous
      • Contributor-facing changes
Next

© Copyright Ansible Navigator project contributors. Revision 5c64235e. Last updated on Jun 29, 2022.

Built with Sphinx using a Sphinx Ansible Theme that is based on the Read the Docs theme and is maintained by the Ansible Community.