使用内容导航器

collections

探索可用的集合

ansible-navigator collections --help

config

探索当前的 Ansible 配置

ansible-navigator config --help

doc

查看模块或插件的文档

ansible-navigator doc --help

images

探索执行环境镜像

ansible-navigator images --help

清单（inventory）

探索清单

ansible-navigator inventory --help

replay

使用 playbook 工件浏览之前的运行

ansible-navigator replay --help

run

运行 playbook

ansible-navigator run --help

welcome

从欢迎页面开始

ansible-navigator welcome --help

ansible-navigator collections

ansible-galaxy collection

ansible-navigator config

ansible-config

ansible-navigator doc

ansible-doc

ansible-navigator inventory

ansible-inventory

ansible-navigator run

ansible-playbook

ansible-runner-artifact-dir

存储由 ansible-runner 生成工件的目录路径。

Default:没有设置默认值

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

ENV: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_ARTIFACT_DIR

Settings file:

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

ansible-runner-rotate-artifacts-count

为最后 n 个运行保留 ansible-runner 构件目录。如果设置为 0，则工件目录不会被删除。

Default:没有设置默认值

CLI: --rac 或 --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

ansible-runner 强制停止执行超时值。

Default:没有设置默认值

CLI: --rt 或 --ansible-runner-timeout

ENV: ANSIBLE_NAVIGATOR_ANSIBLE_RUNNER_TIMEOUT

Settings file:

ansible-navigator:
  ansible-runner:
    timeout:

app

自动化内容导航器的入口点。

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

传递给相应命令的额外参数。

Default: 没有默认值

CLI ：位置

ENV: ANSIBLE_NAVIGATOR_CMDLINE

Settings file:

ansible-navigator:
  ansible:
    cmdline:

collection-doc-cache-path

集合 doc 缓存的路径。

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

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

ENV: ANSIBLE_NAVIGATOR_COLLECTION_DOC_CACHE_PATH

Settings file:

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

container-engine

指定容器引擎（auto=podman then docker）。

Choices: auto, podman 或 docker

Default: auto

CLI: --ce 或 --container-engine

ENV: ANSIBLE_NAVIGATOR_CONTAINER_ENGINE

Settings file:

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

display-color

在显示中使用颜色。

Choices: True 或 False

Default: True

CLI: --dc 或 --display-color

ENV: NO_COLOR

Settings file:

ansible-navigator:
  color:
    enable:

editor-command

指定自动化内容导航器使用的编辑器

默认值：* vi +{line_number} {filename}

CLI: --ecmd 或 --editor-command

ENV: ANSIBLE_NAVIGATOR_EDITOR_COMMAND

Settings file:

ansible-navigator:
  editor:
    command:

editor-console

指定编辑器是否基于控制台.

Choices: True 或 False

Default: True

CLI: --econ 或 --editor-console

ENV: ANSIBLE_NAVIGATOR_EDITOR_CONSOLE

Settings file:

ansible-navigator:
  editor:
    console:

execute-environment

启用或禁用自动化执行环境的使用。

Choices: True 或 False

Default: True

CLI: --ee 或 --execution-environment

ENV:* ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT

Settings file:

ansible-navigator:
  execution-environment:
    enabled:

execution-environment-image

指定自动化执行环境镜像的名称。

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

CLI: --eei 或 --execution-environment-image

ENV: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT_IMAGE

Settings file:

ansible-navigator:
  execution-environment:
    image:

execution-environment-volume-mounts

指定要在自动化执行环境中绑定的卷（--eev /home/user/test:/home/user/test:Z）

Default:没有设置默认值

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

ENV: ANSIBLE_NAVIGATOR_EXECUTION_ENVIRONMENT_VOLUME_MOUNTS

Settings file:

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

log-append

指定是否应将日志消息附加到现有日志文件中，否则每个会话都会创建新的日志文件。

Choices: True 或 False

Default: True

CLI: --la 或 --log-append

ENV: ANSIBLE_NAVIGATOR_LOG_APPEND

Settings file:

ansible-navigator:
  logging:
    append:

log-file

指定自动化内容导航器日志文件的完整路径。

Default: $PWD/ansible-navigator.log

CLI: --lf 或 --log-file

ENV: ANSIBLE_NAVIGATOR_LOG_FILE

Settings file:

ansible-navigator:
  logging:
    file:

log-level

指定自动化内容导航器日志级别。

Choices: debug, info, warning, error 或 critical

Default: warning

CLI: --ll 或 --log-level

ENV: ANSIBLE_NAVIGATOR_LOG_LEVEL

Settings file:

ansible-navigator:
  logging:
    level:

模式

指定 user-interface 模式。

Choices: stdout 或 interactive

Default: interactive

CLI: -m 或 --mode

ENV: ANSIBLE_NAVIGATOR_MODE

Settings file:

ansible-navigator:
  mode:

osc4

启用或禁用 OSC 4 支持的终端颜色。

Choices: True 或 False

Default: True

CLI: --osc4 或 --osc4

ENV: ANSIBLE_NAVIGATOR_OSC4

Settings file:

ansible-navigator:
  color:
    osc4:

pass-environment-variable

指定要传递给的退出环境变量，并在自动化执行环境 (--penv MY_VAR) 内设置.

Default:没有设置默认值

CLI: --penv 或 --pass-environment-variable

ENV: ANSIBLE_NAVIGATOR_PASS_ENVIRONMENT_VARIABLES

Settings file:

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

pull-policy

指定镜像拉取策略。

always - 总拉取 (pull) 镜像

missing - 在本地没有时拉取

Never - 不拉取镜像

tag - 如果镜像标签为 latest 则总拉取镜像，否则在本地没有时进行拉取

Choices: always, missing, never, 或 tag

Default: tag

CLI: --pp 或 --pull-policy

ENV: ANSIBLE_NAVIGATOR_PULL_POLICY

Settings file:

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

set-environment-variable

指定要在自动化执行环境内设置的环境变量和值 (--senv MY_VAR=42)

Default:没有设置默认值

CLI: --senv 或 --set-environment-variable

ENV: ANSIBLE_NAVIGATOR_SET_ENVIRONMENT_VARIABLES

Settings file:

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

config

指定 Ansible 配置文件的路径。

Default:没有设置默认值

CLI: -c 或 --config

ENV: ANSIBLE_CONFIG

Settings file:

ansible-navigator:
  ansible:
    config:
      path:

help-config

以 stdout 模式显示 ansible-config 命令的帮助选项。

Choices:* True 或 False

Default: False

CLI: --hc 或 --help-config

ENV: ANSIBLE_NAVIGATOR_HELP_CONFIG

Settings file:

ansible-navigator:
  help-config:

help-doc

在 stdout 模式中显示 ansible-doc 命令的帮助选项。

Choices: True 或 False

Default: False

CLI: --hd 或 --help-doc

ENV: ANSIBLE_NAVIGATOR_HELP_DOC

Settings file:

ansible-navigator:
  help-doc:

plugin-name

指定插件名称。

Default:没有设置默认值

CLI：位置

ENV: ANSIBLE_NAVIGATOR_PLUGIN_NAME

Settings file:

ansible-navigator:
  documentation:
    plugin:
      name:

plugin-type

指定插件类型。

Choices: become, cache, callback, cliconf, connection, httpapi, inventory, lookup, module, netconf, shell, strategy, or vars

Default: module

CLI: -t 或 ----type

ENV: ANSIBLE_NAVIGATOR_PLUGIN_TYPE

Settings file:

ansible-navigator:
  documentation:
    plugin:
      type:

help-inventory

以 stdout 模式显示 ansible-inventory 命令的帮助选项。

Choices: True 或 False

Default: False

CLI: --hi 或 --help-inventory

ENV: ANSIBLE_NAVIGATOR_INVENTORY_DOC

Settings file:

ansible-navigator:
  help-inventory:

清单（inventory）

指定清单文件路径或逗号分隔的主机列表。

Default: 没有设置默认值

CLI: --i 或 --inventory

ENV: ANSIBLE_NAVIGATOR_INVENTORIES

Settings file:

ansible-navigator:
  inventories:

inventory-column

指定要在清单视图中显示的主机属性。

Default:没有设置默认值

CLI: --ic 或 --inventory-column

ENV:* ANSIBLE_NAVIGATOR_INVENTORY_COLUMNSSettings file:

ansible-navigator:
  inventory-columns:

playbook-artifact-replay

指定要重播的 playbook 构件的路径。

Default:没有设置默认值

CLI：位置

ENV: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_REPLAY

Settings file:

ansible-navigator:
  playbook-artifact:
    replay:

playbook-artifact-replay

指定要重播的 playbook 构件的路径。

Default:没有设置默认值

CLI：位置

ENV: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_REPLAY

Settings file:

ansible-navigator:
  playbook-artifact:
    replay:

help-playbook

以 stdout 模式显示 ansible-playbook 命令的帮助选项。

Choices: True 或 False

Default: False

CLI: --hp 或 --help-playbook

ENV: ANSIBLE_NAVIGATOR_HELP_PLAYBOOK

Settings file:

ansible-navigator:
  help-playbook:

清单（inventory）

指定清单文件路径或逗号分隔的主机列表。

Default: 没有设置默认值

CLI: --i 或 --inventory

ENV: ANSIBLE_NAVIGATOR_INVENTORIES

Settings file:

ansible-navigator:
  inventories:

inventory-column

指定要在清单视图中显示的主机属性。

Default:没有设置默认值

CLI: --ic 或 --inventory-column

ENV:* ANSIBLE_NAVIGATOR_INVENTORY_COLUMNSSettings file:

ansible-navigator:
  inventory-columns:

playbook

指定 playbook 名称。

Default:没有设置默认值

CLI：位置

ENV: ANSIBLE_NAVIGATOR_PLAYBOOK

Settings file:*

ansible-navigator:
  ansible:
    playbook:

playbook-artifact-enable

启用或禁用为已完成的 playbook 创建工件。注意：当 playbook 需要用户输入时，与 --mode stdout 不兼容。

Choices: True 或 False

Default: True

CLI: --pae 或 --playbook-artifact-enableENV: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_ENABLESettings file:

ansible-navigator:
  playbook-artifact:
    enable:

playbook-artifact-save-as

指定从完成的 playbook 创建的工件的名称。

Default: {playbook_dir}/{playbook_name}-artifact-{ts_utc}.json

CLI: --pas 或 --playbook-artifact-save-as

ENV: ANSIBLE_NAVIGATOR_PLAYBOOK_ARTIFACT_SAVE_AS

Settings file:

ansible-navigator:
  playbook-artifact:
    save-as: