8.2. Automation content navigator general settings

ansible-runner-artifact-dir

The directory path to store artifacts generated by ansible-runner.

Default: No default value set

CLI: --rad or --ansible-runner-artifact-dir

ENV: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_ARTIFACT_DIR

Settings file:

ansible-navigator:
  ansible-runner:
    artifact-dir:

ansible-runner-rotate-artifacts-count

Keep ansible-runner artifact directories, for last n runs. If set to 0, artifact directories are not deleted.

Default: No default value set

CLI: --rac or --ansible-runner-rotate-artifacts-count

ENV: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_ROTATE_ARTIFACTS_COUNT

Settings file:

ansible-navigator:
  ansible-runner:
    rotate-artifacts-count:

ansible-runner-timeout

The timeout value after which ansible-runner force stops the execution.

Default: No default value set

CLI: --rt or --ansible-runner-timeout

ENV: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_TIMEOUT

Settings file:

ansible-navigator:
  ansible-runner:
    timeout:

app

Entry point for Automation content navigator.

Choices: collections, config, doc, images, inventory, replay, run or welcome

Default: welcome

CLI example: ansible-navigator collections

ENV: ANSIBLE_NAVIGATOR_APP

Settings file:

ansible-navigator:
  app:

cmdline

Extra parameters passed to the corresponding command.

Default: No default value

CLI: positional

ENV: ANSIBLE_NAVIGATOR_CMDLINE

Settings file:

ansible-navigator:
  ansible:
    cmdline:

collection-doc-cache-path

The path to the collection doc cache.

Default: $HOME/.cache/ansible-navigator/collection_doc_cache.db

CLI: --cdcp or --collection-doc-cache-path

ENV: ANSIBLE_NAVIGATOR_COLLECTION_DOC_CACHE_PATH

Settings file:

ansible-navigator:
  collection-doc-cache-path:

container-engine

Specify the container engine (auto=podman then docker).

Choices: auto, podman or docker

Default: auto

CLI: --ce or --container-engine

ENV: ANSIBLE_NAVIGATOR_CONTAINER_ENGINE

Settings file:

ansible-navigator:
  execution-environment:
    container-engine:

display-color

Enable the use of color in the display.

Choices: True or False

Default: True

CLI: --dc or --display-color

ENV: NO_COLOR

Settings file:

ansible-navigator:
  color:
    enable:

editor-command

Specify the editor used by Automation content navigator

Default:* vi +{line_number} {filename}

CLI: --ecmd or --editor-command

ENV: ANSIBLE_NAVIGATOR_EDITOR_COMMAND

Settings file:

ansible-navigator:
  editor:
    command:

editor-console

Specify if the editor is console based.

Choices: True or False

Default: True

CLI: --econ or --editor-console

ENV: ANSIBLE_NAVIGATOR_EDITOR_CONSOLE

Settings file:

ansible-navigator:
  editor:
    console:

execution-environment

Enable or disable the use of an automation execution environments.

Choices: True or False

Default: True

CLI: --ee or --execution-environment

ENV:* ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT

Settings file:

ansible-navigator:
  execution-environment:
    enabled:

execution-environment-image

Specify the name of theautomation execution environments image.

Default: quay.io/ansible/ansible-runner:devel

CLI: --eei or --execution-environment-image

ENV: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT_IMAGE

Settings file:

ansible-navigator:
  execution-environment:
    image:

execution-environment-volume-mounts

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

Default: No default value set

CLI: --eev or --execution-environment-volume-mounts

ENV: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT_VOLUME_MOUNTS

Settings file:

ansible-navigator:
  execution-environment:
    volume-mounts:

log-append

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

Choices: True or False

Default: True

CLI: --la or --log-append

ENV: ANSIBLE_NAVIGATOR_LOG_APPEND

Settings file:

ansible-navigator:
  logging:
    append:

log-file

Specify the full path for the Automation content navigator log file.

Default: $PWD/ansible-navigator.log

CLI: --lf or --log-file

ENV: ANSIBLE_NAVIGATOR_LOG_FILE

Settings file:

ansible-navigator:
  logging:
    file:

log-level

Specify the Automation content navigator log level.

Choices: debug, info, warning, error or critical

Default: warning

CLI: --ll or --log-level

ENV: ANSIBLE_NAVIGATOR_LOG_LEVEL

Settings file:

ansible-navigator:
  logging:
    level:

mode

Specify the user-interface mode.

Choices: stdout or interactive

Default: interactive

CLI: -m or --mode

ENV: ANSIBLE_NAVIGATOR_MODE

Settings file:

ansible-navigator:
  mode:

osc4

Enable or disable terminal color changing support with OSC 4.

Choices: True or False

Default: True

CLI: --osc4 or --osc4

ENV: ANSIBLE_NAVIGATOR_OSC4

Settings file:

ansible-navigator:
  color:
    osc4:

pass-environment-variable

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

Default: No default value set

CLI: --penv or --pass-environment-variable

ENV: ANSIBLE_NAVIGATOR_PASS_ENVIRONMENT_VARIABLES

Settings file:

ansible-navigator:
  execution-environment:
    environment-variables:
      pass:

pull-policy

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

Choices: always, missing, never, or tag

Default: tag

CLI: --pp or --pull-policy

ENV: ANSIBLE_NAVIGATOR_PULL_POLICY

Settings file:

ansible-navigator:
  execution-environment:
    pull-policy:

set-environment-variable

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

Default: No default value set

CLI: --senv or --set-environment-variable

ENV: ANSIBLE_NAVIGATOR_SET_ENVIRONMENT_VARIABLES

Settings file:

ansible-navigator:
  execution-environment:
    environment-variables:
      set: