Ansible Navigator Configuration

Ansible Navigator Configuration

Type object
File match .ansible-navigator.json .ansible-navigator.yaml .ansible-navigator.yml ansible-navigator.json ansible-navigator.yaml ansible-navigator.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ansible-navigator-configuration/latest.json
Source https://raw.githubusercontent.com/ansible/ansible-navigator/main/src/ansible_navigator/data/ansible-navigator.json

Validate with Lintel

npx @lintel/lintel check
Type: object

See https://ansible.readthedocs.io/projects/navigator/settings/

Properties

ansible-navigator object required
19 nested properties
ansible object
5 nested properties
cmdline string

Extra parameters passed to the underlying ansible command (e.g. ansible-playbook, ansible-doc, etc)

config object
2 nested properties
help boolean

Help options for ansible-config command in stdout mode

Default: false
Values: true false
path string

Specify the path to the ansible configuration file

doc object
2 nested properties
help boolean

Help options for ansible-doc command in stdout mode

Default: false
Values: true false
plugin object
inventory object
2 nested properties
entries string[]

Specify an inventory file path or comma separated host list

help boolean

Help options for ansible-inventory command in stdout mode

Default: false
Values: true false
playbook object
2 nested properties
help boolean

Help options for ansible-playbook command in stdout mode

Default: false
Values: true false
path string

Specify the playbook name

ansible-builder object
2 nested properties
help boolean

Help options for ansible-builder command in stdout mode

Default: false
Values: true false
workdir string

Specify the path that contains ansible-builder manifest files

Default: "."
ansible-lint object
2 nested properties
config string

Specify the path to the ansible-lint configuration file

lintables string

Path to files on which to run ansible-lint

ansible-runner object
4 nested properties
artifact-dir string

The directory path to store artifacts generated by ansible-runner

job-events boolean

Write ansible-runner job_events in the artifact directory

Default: false
Values: true false
rotate-artifacts-count integer

Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted

timeout integer

The timeout value after which ansible-runner will forcefully stop the execution

app string

Subcommands

Default: "welcome"
Values: "builder" "collections" "config" "doc" "exec" "images" "inventory" "lint" "replay" "run" "settings" "welcome"
collection-doc-cache-path string

The path to collection doc cache

Default: "~/.cache/ansible-navigator/collection_doc_cache.db"
color object
2 nested properties
enable boolean

Enable the use of color for mode interactive and stdout

Default: true
Values: true false
osc4 boolean

Enable or disable terminal color changing support with OSC 4

Default: true
Values: true false
editor object
2 nested properties
command string

Specify the editor command

Default: "vi +{line_number} {filename}"
console boolean

Specify if the editor is console based

Default: true
Values: true false
enable-prompts boolean

Enable prompts for password and in playbooks. This will set mode to stdout and disable playbook artifact creation

Default: false
Values: true false
exec object
2 nested properties
command string

Specify the command to run within the execution environment

Default: "/bin/bash"
shell boolean

Specify the exec command should be run in a shell

Default: true
Values: true false
execution-environment object
7 nested properties
container-engine string

Specify the container engine (auto=podman then docker)

Default: "auto"
Values: "auto" "podman" "docker"
container-options string[]

Extra parameters passed to the container engine command

enabled boolean

Enable or disable the use of an execution environment

Default: true
Values: true false
environment-variables object
2 nested properties
pass string[]

Specify an existing environment variable to be passed through to and set within the execution environment (--penv MY_VAR)

set object

Specify an environment variable and a value to be set within the execution environment (--senv MY_VAR=42)

image string

Specify the name of the execution environment image

pull object
2 nested properties
arguments string[]

Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. --pa='--tls-verify=false'

policy string

Specify the image pull policy always:Always pull the image, missing:Pull if not locally available, never:Never pull the image, tag:if the image tag is 'latest', always pull the image, otherwise pull if not locally available

Default: "tag"
Values: "always" "missing" "never" "tag"
volume-mounts object[]

Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)

format string

Specify the format for stdout output.

Default: "yaml"
Values: "json" "yaml"
images object
1 nested properties
details string[]

Provide detailed information about the selected execution environment image

Default:
[
  "everything"
]
inventory-columns string[]

Specify a host attribute to show in the inventory view

logging object
3 nested properties
append boolean

Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session

Default: true
Values: true false
file string

Specify the full path for the ansible-navigator log file

Default: "./ansible-navigator.log"
level string

Specify the ansible-navigator log level

Default: "warning"
Values: "debug" "info" "warning" "error" "critical"
mode string

Specify the user-interface mode

Default: "interactive"
Values: "stdout" "interactive"
playbook-artifact object
3 nested properties
enable boolean

Enable or disable the creation of artifacts for completed playbooks. Note: not compatible with '--mode stdout' when playbooks require user input

Default: true
Values: true false
replay string

Specify the path for the playbook artifact to replay

save-as string

Specify the name for artifacts created from completed playbooks. The following placeholders are available: {playbook_dir}, {playbook_name}, {playbook_status}, and {time_stamp}

Default: "{playbook_dir}/{playbook_name}-artifact-{time_stamp}.json"
settings object
4 nested properties
effective boolean

Show the effective settings. Defaults, CLI parameters, environment variables, and the settings file will be combined

Default: false
sample boolean

Generate a sample settings file

Default: false
schema string

Generate a schema for the settings file ('json'= draft-07 JSON Schema)

Default: "json"
Values: "json"
sources boolean

Show the source of each current settings entry

Default: false
time-zone string

Specify the IANA time zone to use or 'local' to use the system time zone

Default: "UTC"