8.2. 自動化コンテンツナビゲーターの一般設定

以下の表は、自動化コンテンツナビゲーターの一般的な各パラメーターと設定オプションを説明しています。

表8.1 自動化コンテンツナビゲーターの一般的なパラメーター設定

パラメーター説明オプションの設定

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 または 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

コレクションのドキュメントキャッシュへのパス。

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:

execution-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:

ログレベル

自動化コンテンツナビゲーターのログレベルを指定します。

Choices: debug、info、warning、error または critical

Default: warning

CLI: --ll または --log-level

ENV: ANSIBLE_NAVIGATOR_LOG_LEVEL

Settings file: 

ansible-navigator:
  logging:
    level:

mode

ユーザーインターフェイスモードを指定します。

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: 常にイメージをプルします。

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: