Ansible 설정
Ansible 설정 (Ansible Configuration Settings)
Ansible은 동작을 구성하는 여러 원천을 지원해요. ansible.cfg라는 ini 파일, 환경 변수, 커맨드라인 옵션, 플레이북 키워드, 변수가 그 예시예요. 각 원천의 상대적 우선순위에 대한 자세한 내용은 'Ansible 동작 제어하기: 우선순위 규칙' 문서를 참고하세요.
ansible-config 유틸리티는 사용 가능한 모든 설정, 그 기본값, 설정 방법, 현재 값이 어디서 왔는지 보여줘요. 자세한 내용은 ansible-config 문서를 참고하세요.
출처: 문서
본문
설정 파일 (The configuration file)
변경 사항은 설정 파일에서 만들고 사용할 수 있으며, 다음 순서대로 검색돼요.
ANSIBLE_CONFIG(설정된 경우 환경 변수)ansible.cfg(현재 디렉토리)~/.ansible.cfg(홈 디렉토리)/etc/ansible/ansible.cfg
Ansible은 위 목록을 처리해 처음 찾은 파일을 사용하고, 나머지는 모두 무시해요.
참고: 설정 파일은 INI 형식의 한 변형이에요. 주석이 줄을 시작할 때는 해시 기호(
#)와 세미콜론(;) 둘 다 주석 표시로 허용돼요. 하지만 주석이 일반 값과 같은 줄(인라인)에 있으면 세미콜론만 주석 시작을 허용해요. 예를 들어:
# some basic default values...
inventory = /etc/ansible/hosts ; This points to the file that lists your hosts
샘플 ansible.cfg 파일 생성하기
완전히 주석 처리된 예제 ansible.cfg 파일을 생성할 수 있어요. 예를 들어:
$ ansible-config init --disabled > ansible.cfg
기존 플러그인을 포함하는 더 완전한 파일을 얻을 수도 있어요:
$ ansible-config init --disabled -t all > ansible.cfg
이것들을 시작점으로 삼아 자신만의 ansible.cfg 파일을 만들 수 있어요.
현재 디렉토리의 ansible.cfg로 인한 보안 위험 피하기
Ansible이 전 세계 쓰기 가능한(world-writable) 현재 작업 디렉토리에서 ansible.cfg를 로드한다면 심각한 보안 위험이 생겨요. 다른 사용자가 자신의 설정 파일을 그 자리에 두고, Ansible이 로컬과 원격 양쪽에서 악성 코드를 실행하게 만들 수 있어요. 특히 상승된 권한으로 말이죠. 이런 이유로 Ansible은 디렉토리가 world-writable이면 현재 작업 디렉토리에서 설정 파일을 자동으로 로드하지 않아요.
현재 작업 디렉토리의 설정 파일과 함께 Ansible을 써야 한다면, Ansible 디렉토리에 대한 접근을 특정 사용자 및/또는 그룹으로 제한하는 것이 이 문제를 피하는 가장 좋은 방법이에요. Vagrant나 Windows Subsystem for Linux(WSL)처럼 Unix 권한을 에뮬레이션해야 하는 파일시스템에 Ansible 디렉토리가 있다면, chmod, chown, chgrp가 동작하지 않아 처음엔 어떻게 고쳐야 할지 모를 수 있어요. 대부분의 경우 올바른 수정은 파일시스템의 마운트 옵션을 변경해 Ansible을 실행하는 사용자와 그룹이 파일·디렉토리를 읽고 쓸 수 있지만 다른 사람에게는 닫히게 하는 것이에요. 올바른 설정에 대한 자세한 내용은 다음을 참고하세요:
- Vagrant의 경우, Vagrant 문서의 동기화 폴더 권한을 다룹니다.
- WSL의 경우, WSL 문서와 이 Microsoft 블로그 게시물이 마운트 옵션을 다룹니다.
world-writable인 현재 작업 디렉토리에 Ansible 설정을 저장하는 데 절대적으로 의존해야 한다면, ANSIBLE_CONFIG 환경 변수로 설정 파일을 명시적으로 지정할 수 있어요. 그렇게 하기 전에 위 보안 우려를 완화하는 적절한 조치를 취하세요.
설정의 상대 경로
많은 설정 옵션에 상대 경로를 지정할 수 있어요. 대부분의 경우 사용되는 경로는 현재 실행에 사용된 ansible.cfg 파일 기준이에요. 현재 작업 디렉토리(CWD) 기준의 경로가 필요하면 {{CWD}} 매크로로 지정할 수 있어요. 상대 경로의 루트로 CWD를 사용하면 보안 위험이 될 수 있으므로 이 방식은 권장하지 않아요. 예를 들어: cd /tmp; secureinfo=./newrootpassword ansible-playbook ~/safestuff/change_root_pwd.yml.
공통 옵션 (Common Options)
다음은 이 릴리스에서 사용할 수 있는 옵션의 복사본이에요. 로컬 설치에는 추가 플러그인으로 인해 더 많은 옵션이 있을 수 있어요. ansible-config 커맨드라인 유틸리티로 그 옵션들을 둘러볼 수 있어요.
ACTION_WARNINGS
Description:
기본적으로 Ansible은 태스크 액션(모듈 또는 액션 플러그인)에서 받은 경고를 발행해요. 이 설정을 False로 바꾸면 이 경고를 끌 수 있어요.
Type:
boolean
Default:
True
Version Added:
2.5
Ini:
Section:
[defaults]
Key:
action_warnings
Environment:
Variable:
ANSIBLE_ACTION_WARNINGS
AGNOSTIC_BECOME_PROMPT
Description:
커맨드라인에서 제공된 become 방법을 담은 프롬프트 대신, 방법에 무관한(agnostic) become 프롬프트를 표시해요.
Type:
boolean
Default:
True
Version Added:
2.5
Ini:
Section:
[privilege_escalation]
Key:
agnostic_become_prompt
Environment:
Variable:
ANSIBLE_AGNOSTIC_BECOME_PROMPT
ALLOW_BROKEN_CONDITIONALS
Description:
활성화하면 불리언이 아닌 결과를 가진 조건문을 사용할 수 있어요. 이런 경우 deprecation 경고가 발행돼요. 기본적으로 불리언이 아닌 조건문은 오류가 돼요. 그런 결과는 종종 템플릿이 지원되지 않는 곳에서 의도치 않게 사용되어 항상 참인 조건문이 된 것을 나타내요. 이 옵션을 켜면 리터럴 None이나 빈 문자열인 조건식이 하위 호환을 위해 참으로 평가돼요.
Type:
boolean
Default:
False
Version Added:
2.19
Ini:
Section:
[defaults]
Key:
allow_broken_conditionals
Environment:
Variable:
ANSIBLE_ALLOW_BROKEN_CONDITIONALS
ALLOW_EMBEDDED_TEMPLATES
Description:
활성화하면 특정 하위 호환 시나리오를 위해 임베디드 템플릿을 사용할 수 있어요. 이런 경우 deprecation 경고가 발행돼요. 첫째, 템플릿 구분자에 완전히 둘러싸인 조건문(예: failed_when, until, assert.that). 둘째, 조건문 안의 문자열 상수(예: when: some_var=='{{some_other_var}}'). 마지막으로 룩업의 위치 인자(예: lookup('pipe','echo {{some_var}}')). 이런 경우 임베디드 템플릿이 불필요하므로 이 기능은 deprecated예요. 비활성화하면 임베디드 템플릿 사용이 오류가 돼요. 향후 릴리스에서는 이 기능이 기본으로 비활성화될 예정이에요.
Type:
boolean
Default:
True
Version Added:
2.19
Ini:
Section:
[defaults]
Key:
allow_embedded_templates
Environment:
Variable:
ANSIBLE_ALLOW_EMBEDDED_TEMPLATES
ANSIBLE_CONNECTION_PATH
Description:
ansible-connection 스크립트를 찾을 위치를 지정해요. $PATH를 검색하기 전에 이 위치를 확인해요. null이면 ansible과 같은 디렉토리에서 시작해요.
Type:
path
Default:
None
Version Added:
2.8
Ini:
Section:
[persistent_connection]
Key:
ansible_connection_path
Environment:
Variable:
ANSIBLE_CONNECTION_PATH
Note:
This configuration is now deprecated and scheduled for removal.
Scheduled removal:
2.22
Deprecation reason:
This setting has no effect.
ANSIBLE_COW_ACCEPTLIST
Description:
사용하기에 '안전한' cowsay 템플릿의 목록을 받아요. 설치된 모든 템플릿을 활성화하려면 빈 목록으로 설정하세요.
Type:
list
Default:
['bud-frogs','bunny','cheese','daemon','default','dragon','elephant-in-snake','elephant','eyes','hellokitty','kitty','luke-koala','meow','milk','moofasa','moose','ren','sheep','small','stegosaurus','stimpy','supermilker','three-eyes','turkey','turtle','tux','udder','vader-koala','vader','www']
Ini:
Section:
[defaults]
Key:
cowsay_enabled_stencils
Version Added:
2.11
Environment:
Variable:
ANSIBLE_COW_ACCEPTLIST
Version Added:
2.11
ANSIBLE_COW_PATH
Description:
커스텀 cowsay 경로를 지정하거나 원하는 cowsay 구현으로 교체해요.
Type:
string
Default:
None
Ini:
Section:
[defaults]
Key:
cowpath
Environment:
Variable:
ANSIBLE_COW_PATH
ANSIBLE_COW_SELECTION
Description:
This allows you to choose a specific cowsay stencil for the banners or use ‘random’ to cycle through them.
Default:
default
Ini:
Section:
[defaults]
Key:
cow_selection
Environment:
Variable:
ANSIBLE_COW_SELECTION
ANSIBLE_FORCE_COLOR
Description:
TTY 없이 실행 중이거나 'nocolor' 설정이 True여도 색상 모드를 강제해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
force_color
Environment:
Variable:
ANSIBLE_FORCE_COLOR
ANSIBLE_HOME
Description:
컨트롤러에서 Ansible 설정 파일의 기본 루트 경로예요.
Type:
path
Default:
~/.ansible
Version Added:
2.14
Ini:
Section:
[defaults]
Key:
home
Environment:
Variable:
ANSIBLE_HOME
ANSIBLE_NOCOLOR
Description:
색상화된 출력을 억제하는 설정으로, 실패와 상태 정보를 더 잘 나타내기 위해 사용돼요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
nocolor
Environment:
Variable:
ANSIBLE_NOCOLOR
Variable:
NO_COLOR
Version Added:
2.11
ANSIBLE_NOCOWS
Description:
cowsay가 설치되어 있지만 '소(cows)'를 피하고 싶다면(왜????) 이 옵션을 사용해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
nocows
Environment:
Variable:
ANSIBLE_NOCOWS
ANSIBLE_PIPELINING
Description:
이것은 전역 옵션이에요. 각 연결 플러그인은 더 구체적인 옵션을 갖거나 아예 파이프라이닝을 지원하지 않음으로써 덮어쓸 수 있어요. 파이프라이닝은 연결 플러그인이 지원한다면, 실제 파일 전송 없이 많은 Ansible 모듈을 실행해 원격 서버에서 모듈을 실행하는 데 필요한 네트워크 연산 수를 줄여요. 활성화하면 매우 큰 성능 향상을 가져올 수 있어요. 다만 이는 권한 상승(become)과 충돌해요. 예를 들어 'sudo:' 연산을 쓸 때 모든 관리 호스트의 /etc/sudoers에서 먼저 'requiretty'를 비활성화해야 해요. 그래서 기본값이 비활성화돼 있어요. ANSIBLE_KEEP_REMOTE_FILES가 활성화되면 이 설정은 비활성화돼요.
Type:
boolean
Default:
False
Ini:
Section:
[connection]
Key:
pipelining
Section:
[defaults]
Key:
pipelining
Environment:
Variable:
ANSIBLE_PIPELINING
ANY_ERRORS_FATAL
Description:
any_errors_fatal 키워드의 기본값을 설정해요. True이면 태스크 실패가 치명적 오류로 간주돼요.
Type:
boolean
Default:
False
Version Added:
2.4
Ini:
Section:
[defaults]
Key:
any_errors_fatal
Environment:
Variable:
ANSIBLE_ANY_ERRORS_FATAL
BECOME_ALLOW_SAME_USER
Description:
False(기본값)이면 원격 사용자가 become 사용자와 같을 때 Ansible은 become 사용을 건너뛰어요. 이는 보통 중복 연산이기 때문이에요. 즉 root sudo root 같은 경우예요. True이면 이런 경우가 필요할 때가 있으므로 Ansible이 어쨌든 become 플러그인을 사용하도록 강제해요.
Type:
boolean
Default:
False
Ini:
Section:
[privilege_escalation]
Key:
become_allow_same_user
Environment:
Variable:
ANSIBLE_BECOME_ALLOW_SAME_USER
BECOME_PASSWORD_FILE
Description:
become 플러그인에 사용할 비밀번호 파일이에요. --become-password-file. 실행 가능하면 실행되고 결과 stdout이 비밀번호로 사용돼요.
Type:
path
Default:
None
Version Added:
2.12
Ini:
Section:
[defaults]
Key:
become_password_file
Environment:
Variable:
ANSIBLE_BECOME_PASSWORD_FILE
BECOME_PLUGIN_PATH
Description:
Ansible이 Become 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/become:/usr/share/ansible/plugins/become"}}
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
become_plugins
Environment:
Variable:
ANSIBLE_BECOME_PLUGINS
CACHE_PLUGIN
Description:
Chooses which fact cache plugin to use. By default, no cache is used and facts do not persist between runs.
Default:
memory
Ini:
Section:
[defaults]
Key:
fact_caching
Environment:
Variable:
ANSIBLE_CACHE_PLUGIN
CACHE_PLUGIN_CONNECTION
Description:
Defines connection or path information for the fact cache plugin.
Default:
None
Ini:
Section:
[defaults]
Key:
fact_caching_connection
Environment:
Variable:
ANSIBLE_CACHE_PLUGIN_CONNECTION
CACHE_PLUGIN_PREFIX
Description:
Prefix to use for fact cache plugin files/tables.
Default:
ansible_facts
Ini:
Section:
[defaults]
Key:
fact_caching_prefix
Environment:
Variable:
ANSIBLE_CACHE_PLUGIN_PREFIX
CACHE_PLUGIN_TIMEOUT
Description:
팩트 캐시 플러그인 데이터의 만료 타임아웃이에요.
Type:
integer
Default:
86400
Ini:
Section:
[defaults]
Key:
fact_caching_timeout
Environment:
Variable:
ANSIBLE_CACHE_PLUGIN_TIMEOUT
CALLBACKS_ENABLED
Description:
활성화된 콜백 목록이에요. 모든 콜백에 활성화가 필요한 것은 아니지만, Ansible과 함께 제공되는 많은 콜백은 기본 활성화를 원하지 않으므로 활성화가 필요해요.
Type:
list
Default:
[]
Ini:
Section:
[defaults]
Key:
callbacks_enabled
Version Added:
2.11
Environment:
Variable:
ANSIBLE_CALLBACKS_ENABLED
Version Added:
2.11
COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH
Description:
When a collection is loaded that does not support the running Ansible version (with the collection metadata key requires_ansible).
Default:
warning
Choices:
error:
issue a ‘fatal’ error and stop the play
warning:
issue a warning but continue
ignore:
just continue silently
Ini:
Section:
[defaults]
Key:
collections_on_ansible_version_mismatch
Environment:
Variable:
ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH
COLLECTIONS_PATHS
Description:
Ansible이 컬렉션 콘텐츠를 검색할 콜론으로 구분된 경로예요. 컬렉션은 이 디렉토리들에 직접 있지 않고 중첩된 하위 디렉토리에 있어야 해요. 예를 들어 COLLECTIONS_PATHS에 '{{ANSIBLE_HOME~"/collections"}}'가 포함되어 있고, 그 디렉토리에 my.collection을 추가하려면 '{{ANSIBLE_HOME~"/collections/ansible_collections/my/collection"}}'로 저장해야 해요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/collections:/usr/share/ansible/collections"}}
Ini:
Section:
[defaults]
Key:
collections_path
Version Added:
2.10
Environment:
Variable:
ANSIBLE_COLLECTIONS_PATH
Version Added:
2.10
COLLECTIONS_SCAN_SYS_PATH
Description:
설치된 컬렉션을 위해 sys.path를 스캔할지 여부를 켜거나 끄는 불리언이에요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
collections_scan_sys_path
Environment:
Variable:
ANSIBLE_COLLECTIONS_SCAN_SYS_PATH
COLOR_CHANGED
Description:
Defines the color to use on ‘Changed’ task status.
Default:
yellow
Ini:
Section:
[colors]
Key:
changed
Environment:
Variable:
ANSIBLE_COLOR_CHANGED
COLOR_CONSOLE_PROMPT
Description:
Defines the default color to use for ansible-console.
Default:
white
Version Added:
2.7
Ini:
Section:
[colors]
Key:
console_prompt
Environment:
Variable:
ANSIBLE_COLOR_CONSOLE_PROMPT
COLOR_DEBUG
Description:
Defines the color to use when emitting debug messages.
Default:
darkgray
Ini:
Section:
[colors]
Key:
debug
Environment:
Variable:
ANSIBLE_COLOR_DEBUG
COLOR_DEPRECATE
Description:
Defines the color to use when emitting deprecation messages.
Default:
purple
Ini:
Section:
[colors]
Key:
deprecate
Environment:
Variable:
ANSIBLE_COLOR_DEPRECATE
COLOR_DIFF_ADD
Description:
Defines the color to use when showing added lines in diffs.
Default:
green
Ini:
Section:
[colors]
Key:
diff_add
Environment:
Variable:
ANSIBLE_COLOR_DIFF_ADD
COLOR_DIFF_LINES
Description:
Defines the color to use when showing diffs.
Default:
cyan
Ini:
Section:
[colors]
Key:
diff_lines
Environment:
Variable:
ANSIBLE_COLOR_DIFF_LINES
COLOR_DIFF_REMOVE
Description:
Defines the color to use when showing removed lines in diffs.
Default:
red
Ini:
Section:
[colors]
Key:
diff_remove
Environment:
Variable:
ANSIBLE_COLOR_DIFF_REMOVE
COLOR_DOC_CONSTANT
Description:
Defines the color to use when emitting a constant in the ansible-doc output.
Default:
darkgray
Version Added:
2.18
Ini:
Section:
[colors]
Key:
doc_constant
Environment:
Variable:
ANSIBLE_COLOR_DOC_CONSTANT
COLOR_DOC_DEPRECATED
Description:
Defines the color to use when emitting a deprecated value in the ansible-doc output.
Default:
magenta
Version Added:
2.18
Ini:
Section:
[colors]
Key:
doc_deprecated
Environment:
Variable:
ANSIBLE_COLOR_DOC_DEPRECATED
COLOR_DOC_LINK
Description:
Defines the color to use when emitting a link in the ansible-doc output.
Default:
cyan
Version Added:
2.18
Ini:
Section:
[colors]
Key:
doc_link
Environment:
Variable:
ANSIBLE_COLOR_DOC_LINK
COLOR_DOC_MODULE
Description:
Defines the color to use when emitting a module name in the ansible-doc output.
Default:
yellow
Version Added:
2.18
Ini:
Section:
[colors]
Key:
doc_module
Environment:
Variable:
ANSIBLE_COLOR_DOC_MODULE
COLOR_DOC_PLUGIN
Description:
Defines the color to use when emitting a plugin name in the ansible-doc output.
Default:
yellow
Version Added:
2.18
Ini:
Section:
[colors]
Key:
doc_plugin
Environment:
Variable:
ANSIBLE_COLOR_DOC_PLUGIN
COLOR_DOC_REFERENCE
Description:
Defines the color to use when emitting cross-reference in the ansible-doc output.
Default:
magenta
Version Added:
2.18
Ini:
Section:
[colors]
Key:
doc_reference
Environment:
Variable:
ANSIBLE_COLOR_DOC_REFERENCE
COLOR_ERROR
Description:
Defines the color to use when emitting error messages.
Default:
red
Ini:
Section:
[colors]
Key:
error
Environment:
Variable:
ANSIBLE_COLOR_ERROR
COLOR_HIGHLIGHT
Description:
Defines the color to use for highlighting.
Default:
white
Ini:
Section:
[colors]
Key:
highlight
Environment:
Variable:
ANSIBLE_COLOR_HIGHLIGHT
COLOR_INCLUDED
Description:
Defines the color to use when showing ‘Included’ task status.
Default:
cyan
Version Added:
2.18
Ini:
Section:
[colors]
Key:
included
Environment:
Variable:
ANSIBLE_COLOR_INCLUDED
COLOR_OK
Description:
Defines the color to use when showing ‘OK’ task status.
Default:
green
Ini:
Section:
[colors]
Key:
ok
Environment:
Variable:
ANSIBLE_COLOR_OK
COLOR_SKIP
Description:
Defines the color to use when showing ‘Skipped’ task status.
Default:
cyan
Ini:
Section:
[colors]
Key:
skip
Environment:
Variable:
ANSIBLE_COLOR_SKIP
COLOR_UNREACHABLE
Description:
Defines the color to use on ‘Unreachable’ status.
Default:
brightred
Ini:
Section:
[colors]
Key:
unreachable
Environment:
Variable:
ANSIBLE_COLOR_UNREACHABLE
COLOR_VERBOSE
Description:
Defines the color to use when emitting verbose messages. In other words, those that show with ‘-v’s.
Default:
blue
Ini:
Section:
[colors]
Key:
verbose
Environment:
Variable:
ANSIBLE_COLOR_VERBOSE
COLOR_WARN
Description:
Defines the color to use when emitting warning messages.
Default:
brightpurple
Ini:
Section:
[colors]
Key:
warn
Environment:
Variable:
ANSIBLE_COLOR_WARN
CONNECTION_FACTS_MODULES
Description:
연결에 따라 play의 팩트 수집 단계에서 실행할 모듈을 지정해요.
Type:
dict
Default:
{'asa':'ansible.legacy.asa_facts','cisco.asa.asa':'cisco.asa.asa_facts','eos':'ansible.legacy.eos_facts','arista.eos.eos':'arista.eos.eos_facts','frr':'ansible.legacy.frr_facts','frr.frr.frr':'frr.frr.frr_facts','ios':'ansible.legacy.ios_facts','cisco.ios.ios':'cisco.ios.ios_facts','iosxr':'ansible.legacy.iosxr_facts','cisco.iosxr.iosxr':'cisco.iosxr.iosxr_facts','junos':'ansible.legacy.junos_facts','junipernetworks.junos.junos':'junipernetworks.junos.junos_facts','nxos':'ansible.legacy.nxos_facts','cisco.nxos.nxos':'cisco.nxos.nxos_facts','vyos':'ansible.legacy.vyos_facts','vyos.vyos.vyos':'vyos.vyos.vyos_facts','exos':'ansible.legacy.exos_facts','extreme.exos.exos':'extreme.exos.exos_facts','slxos':'ansible.legacy.slxos_facts','extreme.slxos.slxos':'extreme.slxos.slxos_facts','voss':'ansible.legacy.voss_facts','extreme.voss.voss':'extreme.voss.voss_facts','ironware':'ansible.legacy.ironware_facts','community.network.ironware':'community.network.ironware_facts'}
CONNECTION_PASSWORD_FILE
Description:
연결 플러그인에 사용할 비밀번호 파일이에요. --connection-password-file.
Type:
path
Default:
None
Version Added:
2.12
Ini:
Section:
[defaults]
Key:
connection_password_file
Environment:
Variable:
ANSIBLE_CONNECTION_PASSWORD_FILE
COVERAGE_REMOTE_OUTPUT
Description:
원격 호스트에서 커버리지 리포트를 생성할 출력 디렉토리를 설정해요. 현재는 PowerShell 모듈의 원격 커버리지에만 사용돼요. 이것은 내부용이에요.
Type:
str
Version Added:
2.9
Environment:
Variable:
_ANSIBLE_COVERAGE_REMOTE_OUTPUT
Variables:
name:
_ansible_coverage_remote_output
COVERAGE_REMOTE_PATHS
Description:
원격 호스트에서 실행할 때 Ansible 컨트롤러의 파일에 대해 커버리지를 실행할 경로 목록이에요. 경로 glob와 일치하는 파일만 커버리지가 수집돼요. 여러 경로 glob를 :로 구분해 지정할 수 있어요. 현재는 PowerShell 모듈의 원격 커버리지에만 사용돼요. 이것은 내부용이에요.
Type:
str
Default:
*
Version Added:
2.9
Environment:
Variable:
_ANSIBLE_COVERAGE_REMOTE_PATH_FILTER
DEFAULT_ACTION_PLUGIN_PATH
Description:
Ansible이 액션 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/action:/usr/share/ansible/plugins/action"}}
Ini:
Section:
[defaults]
Key:
action_plugins
Environment:
Variable:
ANSIBLE_ACTION_PLUGINS
DEFAULT_ALLOW_UNSAFE_LOOKUPS
Description:
활성화하면 lookup 플러그인(변수에서 {{lookup('foo')}}로 쓰든 with_foo 루프로 쓰든)이 'unsafe'로 표시되지 않은 데이터를 반환하게 해요. 기본적으로 그런 데이터는 템플릿 엔진이 어떤 jinja2 템플릿 언어도 평가하지 못하게 unsafe로 표시돼요. 이는 보안 위험이 될 수 있기 때문이에요. 이 옵션은 하위 호환을 위해 제공되지만, 사용자는 먼저 나중에 템플릿 엔진을 거칠 수 있는 데이터가 있을 것으로 예상되는 룩업에 allow_unsafe=True를 추가하는 것을 고려해야 해요.
Type:
boolean
Default:
False
Version Added:
2.2.3
Ini:
Section:
[defaults]
Key:
allow_unsafe_lookups
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
This option is no longer used in the Ansible Core code base.
Current alternatives:
Lookup plugins are responsible for tagging strings containing templates to allow evaluation as a template.
DEFAULT_ASK_PASS
Description:
Ansible 플레이북이 로그인 비밀번호를 요구할지 제어해요. SSH 키로 인증한다면 이 설정을 바꿀 필요가 없을 거예요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
ask_pass
Environment:
Variable:
ANSIBLE_ASK_PASS
DEFAULT_ASK_VAULT_PASS
Description:
Ansible 플레이북이 vault 비밀번호를 요구할지 제어해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
ask_vault_pass
Environment:
Variable:
ANSIBLE_ASK_VAULT_PASS
DEFAULT_BECOME
Description:
권한 상승 사용을 토글해요. 로그인 후 다른 사용자로 '되어(become)' 실행하게 해줘요.
Type:
boolean
Default:
False
Ini:
Section:
[privilege_escalation]
Key:
become
Environment:
Variable:
ANSIBLE_BECOME
DEFAULT_BECOME_ASK_PASS
Description:
권한 상승 비밀번호를 물어보도록 토글해요.
Type:
boolean
Default:
False
Ini:
Section:
[privilege_escalation]
Key:
become_ask_pass
Environment:
Variable:
ANSIBLE_BECOME_ASK_PASS
DEFAULT_BECOME_EXE
Description:
executable to use for privilege escalation, otherwise Ansible will depend on PATH.
Default:
None
Ini:
Section:
[privilege_escalation]
Key:
become_exe
Environment:
Variable:
ANSIBLE_BECOME_EXE
DEFAULT_BECOME_FLAGS
Description:
Flags to pass to the privilege escalation executable.
Default:
Ini:
Section:
[privilege_escalation]
Key:
become_flags
Environment:
Variable:
ANSIBLE_BECOME_FLAGS
DEFAULT_BECOME_METHOD
Description:
Privilege escalation method to use when become is enabled.
Default:
sudo
Ini:
Section:
[privilege_escalation]
Key:
become_method
Environment:
Variable:
ANSIBLE_BECOME_METHOD
DEFAULT_BECOME_USER
Description:
The user your login/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified.
Default:
root
Ini:
Section:
[privilege_escalation]
Key:
become_user
Environment:
Variable:
ANSIBLE_BECOME_USER
DEFAULT_CACHE_PLUGIN_PATH
Description:
Ansible이 캐시 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/cache:/usr/share/ansible/plugins/cache"}}
Ini:
Section:
[defaults]
Key:
cache_plugins
Environment:
Variable:
ANSIBLE_CACHE_PLUGINS
DEFAULT_CALLBACK_PLUGIN_PATH
Description:
Ansible이 콜백 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/callback:/usr/share/ansible/plugins/callback"}}
Ini:
Section:
[defaults]
Key:
callback_plugins
Environment:
Variable:
ANSIBLE_CALLBACK_PLUGINS
DEFAULT_CLICONF_PLUGIN_PATH
Description:
Ansible이 Cliconf 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/cliconf:/usr/share/ansible/plugins/cliconf"}}
Ini:
Section:
[defaults]
Key:
cliconf_plugins
Environment:
Variable:
ANSIBLE_CLICONF_PLUGINS
DEFAULT_CONNECTION_PLUGIN_PATH
Description:
Ansible이 연결 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/connection:/usr/share/ansible/plugins/connection"}}
Ini:
Section:
[defaults]
Key:
connection_plugins
Environment:
Variable:
ANSIBLE_CONNECTION_PLUGINS
DEFAULT_DEBUG
Description:
Ansible의 디버그 출력을 토글해요. 매우 장황하며 멀티프로세싱을 방해할 수 있어요. 디버그 출력은 no_log 설정이 켜져 있어도 비밀 정보를 포함할 수 있어 프로덕션에서는 디버그 모드를 사용하면 안 돼요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
debug
Environment:
Variable:
ANSIBLE_DEBUG
DEFAULT_EXECUTABLE
Description:
This indicates the command to use to spawn a shell under, which is required for Ansible’s execution needs on a target. Users may need to change this in rare instances when shell usage is constrained, but in most cases, it may be left as is.
Default:
/bin/sh
Ini:
Section:
[defaults]
Key:
executable
Environment:
Variable:
ANSIBLE_EXECUTABLE
DEFAULT_FILTER_PLUGIN_PATH
Description:
Ansible이 Jinja2 필터 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/filter:/usr/share/ansible/plugins/filter"}}
Ini:
Section:
[defaults]
Key:
filter_plugins
Environment:
Variable:
ANSIBLE_FILTER_PLUGINS
DEFAULT_FORCE_HANDLERS
Description:
호스트에서 실패가 발생해도 알림받은 핸들러가 그 호스트에서 실행되는지 제어하는 옵션이에요. false이면 호스트에서 실패가 발생했을 때 핸들러가 실행되지 않아요. 이는 play 단위로 또는 커맨드라인에서도 설정할 수 있어요. 자세한 내용은 '핸들러와 실패' 문서를 참고하세요.
Type:
boolean
Default:
False
Version Added:
1.9.1
Ini:
Section:
[defaults]
Key:
force_handlers
Environment:
Variable:
ANSIBLE_FORCE_HANDLERS
DEFAULT_FORKS
Description:
Ansible이 대상 호스트에서 태스크를 실행하는 데 사용할 최대 포크 수예요.
Type:
integer
Default:
5
Ini:
Section:
[defaults]
Key:
forks
Environment:
Variable:
ANSIBLE_FORKS
DEFAULT_GATHERING
Description:
This setting controls the default policy of fact gathering (facts discovered about remote systems). This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the cache plugin.
Default:
implicit
Choices:
implicit:
the cache plugin will be ignored and facts will be gathered per play unless ‘gather_facts: False’ is set.
explicit:
facts will not be gathered unless directly requested in the play.
smart:
each new host that has no facts discovered will be scanned, but if the same host is addressed in multiple plays it will not be contacted again in the run.
Version Added:
1.6
Ini:
Section:
[defaults]
Key:
gathering
Environment:
Variable:
ANSIBLE_GATHERING
DEFAULT_HASH_BEHAVIOUR
Description:
이 설정은 사전 변수(일명 hash, map, associative array)의 중복 정의를 Ansible에서 어떻게 처리할지 제어해요. 값이 스칼라(정수, 문자열)나 배열인 변수에는 영향을 주지 않아요. 경고: 이 설정을 바꾸는 것은 권장하지 않아요. 깨지기 쉽고 콘텐츠(play, 롤, 컬렉션)를 이식 불가능하게 만들어 계속 혼란과 오용으로 이어지기 때문이에요. 절대적으로 필요하다고 생각하지 않으면 바꾸지 마세요. 변수 이름 재사용을 피하고 combine 필터와 vars, varnames 룩업을 사용해 개별 변수의 병합 버전을 만들 것을 권장해요. 경험상 이것은 거의 필요하지 않고, 데이터 구조와 play에 너무 많은 복잡성이 도입되었다는 신호예요. 일부 용도에서는 host_vars/와 group_vars/ 디렉토리를 파싱하는 기본 host_group_vars를 대체하며 입력 시 병합하는 커스텀 vars_plugins를 살펴볼 수도 있어요. 이 설정의 대부분 사용자는 인벤토리 범위만 관심이 있지만, 설정 자체는 모든 원천에 영향을 주고 디버깅을 훨씬 어렵게 만들어요. 공식 예시 저장소의 모든 플레이북과 롤은 이 설정의 기본값을 가정해요. 설정을 merge로 바꾸면 변수 원천 전반에 적용되지만, 많은 원천은 내부적으로 여전히 변수를 덮어써요. 예를 들어 include_vars는 Ansible을 갱신하기 전에 내부적으로 변수를 중복 제거하며, 같은 파일에서 '마지막 정의'가 이전 정의를 덮어써요. Ansible 프로젝트는 새 프로젝트에서 merge를 피할 것을 권장해요. Ansible 개발자들은 결국 이 설정을 deprecated로 만들고 제거할 의도이지만, 일부 사용자가 크게 의존하므로 유지되고 있어요. 새 프로젝트는 'merge'를 피해야 해요.
Type:
string
Default:
replace
Choices:
replace:
Any variable that is defined more than once is overwritten using the order from variable precedence rules (highest wins).
merge:
Any dictionary variable will be recursively merged with new definitions across the different variable definition sources.
Ini:
Section:
[defaults]
Key:
hash_behaviour
Environment:
Variable:
ANSIBLE_HASH_BEHAVIOUR
DEFAULT_HOST_LIST
Description:
쉼표로 구분된 Ansible 인벤토리 원천 목록이에요.
Type:
pathlist
Default:
['/etc/ansible/hosts']
Ini:
Section:
[defaults]
Key:
inventory
Environment:
Variable:
ANSIBLE_INVENTORY
DEFAULT_HTTPAPI_PLUGIN_PATH
Description:
Ansible이 HttpApi 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/httpapi:/usr/share/ansible/plugins/httpapi"}}
Ini:
Section:
[defaults]
Key:
httpapi_plugins
Environment:
Variable:
ANSIBLE_HTTPAPI_PLUGINS
DEFAULT_INTERNAL_POLL_INTERVAL
Description:
Ansible 내부 프로세스가 서로 폴링하는 간격(초)을 설정해요. 낮은 값은 큰 플레이북에서 성능을 개선하지만 CPU 부하를 추가로 소모해요. 높은 값은 UI 응답성이 필요 없고 CPU 사용량이 우려되는 자동화 시나리오에서 Ansible 사용에 더 적합해요. 기본값은 Ansible <= 2.1에 하드코딩된 값과 일치해요.
Type:
float
Default:
0.001
Version Added:
2.2
Ini:
Section:
[defaults]
Key:
internal_poll_interval
DEFAULT_INVENTORY_PLUGIN_PATH
Description:
Ansible이 인벤토리 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/inventory:/usr/share/ansible/plugins/inventory"}}
Ini:
Section:
[defaults]
Key:
inventory_plugins
Environment:
Variable:
ANSIBLE_INVENTORY_PLUGINS
DEFAULT_JINJA2_EXTENSIONS
Description:
추가 Jinja2 확장을 활성화할 수 있는 개발자 전용 기능이에요. 자세한 내용은 Jinja2 문서를 참고하세요. 이것들이 무엇을 하는지 모른다면, 아마 이 설정을 바꿀 필요가 없을 거예요 :)
Type:
list
Default:
[]
Ini:
Section:
[defaults]
Key:
jinja2_extensions
Environment:
Variable:
ANSIBLE_JINJA2_EXTENSIONS
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
Jinja2 extensions have been deprecated
Current alternatives:
Ansible-supported Jinja plugins (tests, filters, lookups)
DEFAULT_JINJA2_NATIVE
Description:
이 옵션은 템플릿 연산 중 변수 타입을 보존해요.
Type:
boolean
Default:
True
Version Added:
2.7
Ini:
Section:
[defaults]
Key:
jinja2_native
Environment:
Variable:
ANSIBLE_JINJA2_NATIVE
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
This option is no longer used in the Ansible Core code base.
Current alternatives:
Jinja2 native mode is now the default and only option.
DEFAULT_KEEP_REMOTE_FILES
Description:
Ansible이 원격에서 태스크를 실행하는 데 사용한 임시 파일을 정리할지 여부를 켜거나 꺼요. 이 옵션이 활성화되면 ANSIBLE_PIPELINING을 비활성화해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
keep_remote_files
Environment:
Variable:
ANSIBLE_KEEP_REMOTE_FILES
DEFAULT_LIBVIRT_LXC_NOSECLABEL
Description:
이 설정은 virsh 명령에 --noseclabel 매개변수를 전달해 libvirt가 LXC 컨테이너에 연결하게 해요. SELinux가 없는 시스템에서 실행할 때 필요해요.
Type:
boolean
Default:
False
Version Added:
2.1
Ini:
Section:
[selinux]
Key:
libvirt_lxc_noseclabel
Environment:
Variable:
ANSIBLE_LIBVIRT_LXC_NOSECLABEL
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.22
Deprecation reason:
This option was moved to the plugin itself
Current alternatives:
Use the option from the plugin itself.
DEFAULT_LOAD_CALLBACK_PLUGINS
Description:
/usr/bin/ansible을 실행할 때 콜백 플러그인을 로드할지 제어해요. 커맨드라인 활동을 로깅하거나 알림을 보내는 데 사용할 수 있어요. 콜백 플러그인은 ansible-playbook에서 항상 로드돼요.
Type:
boolean
Default:
False
Version Added:
1.8
Ini:
Section:
[defaults]
Key:
bin_ansible_callbacks
Environment:
Variable:
ANSIBLE_LOAD_CALLBACK_PLUGINS
DEFAULT_LOCAL_TMP
Description:
Ansible이 컨트롤러에서 사용할 임시 디렉토리예요.
Type:
tmppath
Default:
{{ANSIBLE_HOME~"/tmp"}}
Ini:
Section:
[defaults]
Key:
local_tmp
Environment:
Variable:
ANSIBLE_LOCAL_TEMP
DEFAULT_LOG_FILTER
Description:
로그 파일에서 필터링할 로거 이름 목록이에요.
Type:
list
Default:
[]
Ini:
Section:
[defaults]
Key:
log_filter
Environment:
Variable:
ANSIBLE_LOG_FILTER
DEFAULT_LOG_PATH
Description:
Ansible이 컨트롤러에서 로깅할 파일이에요. 설정하지 않으면 로깅이 비활성화돼요.
Type:
path
Default:
None
Ini:
Section:
[defaults]
Key:
log_path
Environment:
Variable:
ANSIBLE_LOG_PATH
DEFAULT_LOOKUP_PLUGIN_PATH
Description:
Ansible이 lookup 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/lookup:/usr/share/ansible/plugins/lookup"}}
Ini:
Section:
[defaults]
Key:
lookup_plugins
Environment:
Variable:
ANSIBLE_LOOKUP_PLUGINS
DEFAULT_MANAGED_STR
Description:
Sets the macro for the ‘ansible_managed’ variable available for ansible_collections.ansible.builtin.template_module and ansible_collections.ansible.windows.win_template_module. This is only relevant to those two modules.
Default:
Ansiblemanaged
Ini:
Section:
[defaults]
Key:
ansible_managed
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
The ansible_managed variable can be set just like any other variable, or a different variable can be used.
Current alternatives:
Set the ansible_managed variable, or use any custom variable in templates.
DEFAULT_MODULE_ARGS
Description:
This sets the default arguments to pass to the ansible adhoc binary if no -a is specified.
Default:
None
Ini:
Section:
[defaults]
Key:
module_args
Environment:
Variable:
ANSIBLE_MODULE_ARGS
DEFAULT_MODULE_COMPRESSION
Description:
Compression scheme to use when transferring Python modules to the target.
Default:
ZIP_DEFLATED
Ini:
Section:
[defaults]
Key:
module_compression
Variables:
name:
ansible_module_compression
DEFAULT_MODULE_NAME
Description:
Module to use with the ansible AdHoc command, if none is specified via -m.
Default:
command
Ini:
Section:
[defaults]
Key:
module_name
DEFAULT_MODULE_PATH
Description:
Ansible이 모듈을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/modules:/usr/share/ansible/plugins/modules"}}
Ini:
Section:
[defaults]
Key:
library
Environment:
Variable:
ANSIBLE_LIBRARY
DEFAULT_MODULE_UTILS_PATH
Description:
Ansible이 모듈이 공유하는 module utils 파일을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/module_utils:/usr/share/ansible/plugins/module_utils"}}
Ini:
Section:
[defaults]
Key:
module_utils
Environment:
Variable:
ANSIBLE_MODULE_UTILS
DEFAULT_NETCONF_PLUGIN_PATH
Description:
Ansible이 Netconf 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/netconf:/usr/share/ansible/plugins/netconf"}}
Ini:
Section:
[defaults]
Key:
netconf_plugins
Environment:
Variable:
ANSIBLE_NETCONF_PLUGINS
DEFAULT_NO_LOG
Description:
태스크 세부 정보의 표시와 로깅을 토글해요. 주로 보안 정보 노출을 피하는 데 사용돼요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
no_log
Environment:
Variable:
ANSIBLE_NO_LOG
DEFAULT_NO_TARGET_SYSLOG
Description:
태스크를 실행할 때 대상에서 syslog로의 Ansible 로깅을 토글해요. Windows 호스트에서는 새 스타일 PowerShell 모듈이 이벤트 로그에 쓰는 것을 비활성화해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
no_target_syslog
Environment:
Variable:
ANSIBLE_NO_TARGET_SYSLOG
Variables:
name:
ansible_no_target_syslog
Version Added:
2.10
DEFAULT_NULL_REPRESENTATION
Description:
템플릿화가 'null' 값으로 반환할 것 설정이에요. 설정하지 않으면 Jinja2가 결정하게 해요.
Type:
raw
Default:
None
Ini:
Section:
[defaults]
Key:
null_representation
Environment:
Variable:
ANSIBLE_NULL_REPRESENTATION
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
This option is no longer used in the Ansible Core code base.
Current alternatives:
There is no alternative at the moment. A different mechanism would have to be implemented in the current code base.
DEFAULT_POLL_INTERVAL
Description:
Ansible의 비동기 태스크(비동기 액션과 폴링에서 다룸)에서, 명시적 poll 간격이 제공되지 않았을 때 그 태스크 상태를 얼마나 자주 확인할지예요. 기본값은 합리적인 15초로, 자주 확인하는 것과 무언가 완료되었을 때 빠른 반응을 제공하는 것 사이의 절충이에요.
Type:
integer
Default:
15
Ini:
Section:
[defaults]
Key:
poll_interval
Environment:
Variable:
ANSIBLE_POLL_INTERVAL
DEFAULT_PRIVATE_KEY_FILE
Description:
에이전트나 비밀번호 대신 인증서 또는 키 파일로 인증하는 연결을 위한 옵션이에요. 매 호출마다 --private-key를 다시 지정하지 않도록 여기서 기본값을 설정할 수 있어요.
Type:
path
Default:
None
Ini:
Section:
[defaults]
Key:
private_key_file
Environment:
Variable:
ANSIBLE_PRIVATE_KEY_FILE
DEFAULT_PRIVATE_ROLE_VARS
Description:
기본적으로 가져온 롤은 변수를 play와 다른 롤에 게시해요. 이 설정은 그렇게 하지 않도록 피할 수 있어요. 이는 롤이 플레이북에서 한 번 이상 사용될 때 롤 변수를 기본값으로 재설정하는 방법으로 도입됐어요. '2.17' 버전부터 M(ansible.builtin.include_roles)와 M(ansible.builtin.import_roles)는 C(public) 매개변수로 개별적으로 이 동작을 덮어쓸 수 있어요. 포함된 롤은 실행 시점에만 변수를 공개하는 반면, 가져온 롤은 플레이북 컴파일 시점에 발생해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
private_role_vars
Environment:
Variable:
ANSIBLE_PRIVATE_ROLE_VARS
DEFAULT_REMOTE_PORT
Description:
원격 연결에 사용할 포트예요. 비어 있으면 연결 플러그인의 기본값을 사용해요.
Type:
integer
Default:
None
Ini:
Section:
[defaults]
Key:
remote_port
Environment:
Variable:
ANSIBLE_REMOTE_PORT
DEFAULT_REMOTE_USER
Description:
Sets the login user for the target machines When blank it uses the connection plugin’s default, normally the user currently executing Ansible.
Ini:
Section:
[defaults]
Key:
remote_user
Environment:
Variable:
ANSIBLE_REMOTE_USER
DEFAULT_ROLES_PATH
Description:
Ansible이 롤을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/roles:/usr/share/ansible/roles:/etc/ansible/roles"}}
Ini:
Section:
[defaults]
Key:
roles_path
Environment:
Variable:
ANSIBLE_ROLES_PATH
DEFAULT_SELINUX_SPECIAL_FS
Description:
일부 파일시스템은 안전한 연산을 지원하지 않거나 일관되지 않은 오류를 반환해요. 이 설정은 목록에 있는 그런 파일시스템을 치명적 오류 없이 '허용'하게 해요. 파일시스템이 목록에 있으면 데이터 손상이 발생할 수 있고 쓰기가 항상 검증되지 않아요.
Type:
list
Default:
['fuse','nfs','vboxsf','ramfs','9p','vfat']
Ini:
Section:
[selinux]
Key:
special_context_filesystems
Environment:
Variable:
ANSIBLE_SELINUX_SPECIAL_FS
Version Added:
2.9
DEFAULT_STDOUT_CALLBACK
Description:
Set the main callback used to display Ansible output. You can only have one at a time. You can have many other callbacks, but just one can be in charge of stdout. See Callback plugins for a list of available options.
Default:
default
Ini:
Section:
[defaults]
Key:
stdout_callback
Environment:
Variable:
ANSIBLE_STDOUT_CALLBACK
DEFAULT_STRATEGY
Description:
Set the default strategy used for plays.
Default:
linear
Version Added:
2.3
Ini:
Section:
[defaults]
Key:
strategy
Environment:
Variable:
ANSIBLE_STRATEGY
DEFAULT_STRATEGY_PLUGIN_PATH
Description:
Ansible이 전략 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/strategy:/usr/share/ansible/plugins/strategy"}}
Ini:
Section:
[defaults]
Key:
strategy_plugins
Environment:
Variable:
ANSIBLE_STRATEGY_PLUGINS
DEFAULT_SU
Description:
태스크에 'su' 사용을 토글해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
su
Environment:
Variable:
ANSIBLE_SU
DEFAULT_SYSLOG_FACILITY
Description:
Syslog facility to use when Ansible logs to the remote target.
Default:
LOG_USER
Ini:
Section:
[defaults]
Key:
syslog_facility
Environment:
Variable:
ANSIBLE_SYSLOG_FACILITY
DEFAULT_TERMINAL_PLUGIN_PATH
Description:
Ansible이 터미널 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/terminal:/usr/share/ansible/plugins/terminal"}}
Ini:
Section:
[defaults]
Key:
terminal_plugins
Environment:
Variable:
ANSIBLE_TERMINAL_PLUGINS
DEFAULT_TEST_PLUGIN_PATH
Description:
Ansible이 Jinja2 테스트 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/test:/usr/share/ansible/plugins/test"}}
Ini:
Section:
[defaults]
Key:
test_plugins
Environment:
Variable:
ANSIBLE_TEST_PLUGINS
DEFAULT_TIMEOUT
Description:
연결 플러그인이 사용할 기본 타임아웃이에요.
Type:
integer
Default:
10
Ini:
Section:
[defaults]
Key:
timeout
Environment:
Variable:
ANSIBLE_TIMEOUT
DEFAULT_TRANSPORT
Description:
Can be any connection plugin available to your ansible installation.
Default:
ssh
Ini:
Section:
[defaults]
Key:
transport
Environment:
Variable:
ANSIBLE_TRANSPORT
DEFAULT_UNDEFINED_VAR_BEHAVIOR
Description:
True이면 Ansible 템플릿화가 오타가 났을 가능성이 있는 변수 이름을 참조하는 단계에서 실패하게 해요. 그렇지 않으면 정의되지 않은 변수를 포함하는 모든 '{{ template_expression }}'이 템플릿이나 ansible 액션 줄에 작성된 그대로 렌더링돼요.
Type:
boolean
Default:
True
Version Added:
1.3
Ini:
Section:
[defaults]
Key:
error_on_undefined_vars
Environment:
Variable:
ANSIBLE_ERROR_ON_UNDEFINED_VARS
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
This option is no longer used in the Ansible Core code base.
Current alternatives:
There is no alternative at the moment. A different mechanism would have to be implemented in the current code base.
DEFAULT_VARS_PLUGIN_PATH
Description:
Ansible이 vars 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/vars:/usr/share/ansible/plugins/vars"}}
Ini:
Section:
[defaults]
Key:
vars_plugins
Environment:
Variable:
ANSIBLE_VARS_PLUGINS
DEFAULT_VAULT_ENCRYPT_IDENTITY
Description:
The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The --encrypt-vault-id CLI option overrides the configured value.
Ini:
Section:
[defaults]
Key:
vault_encrypt_identity
Environment:
Variable:
ANSIBLE_VAULT_ENCRYPT_IDENTITY
DEFAULT_VAULT_ID_MATCH
Description:
If true, decrypting vaults with a vault id will only try the password from the matching vault-id.
Default:
False
Ini:
Section:
[defaults]
Key:
vault_id_match
Environment:
Variable:
ANSIBLE_VAULT_ID_MATCH
DEFAULT_VAULT_IDENTITY
Description:
The label to use for the default vault id label in cases where a vault id label is not provided.
Default:
default
Ini:
Section:
[defaults]
Key:
vault_identity
Environment:
Variable:
ANSIBLE_VAULT_IDENTITY
DEFAULT_VAULT_IDENTITY_LIST
Description:
기본으로 사용할 vault-id 목록이에요. 여러 --vault-id 인자와 동등해요. vault-id는 순서대로 시도돼요.
Type:
list
Default:
[]
Ini:
Section:
[defaults]
Key:
vault_identity_list
Environment:
Variable:
ANSIBLE_VAULT_IDENTITY_LIST
DEFAULT_VAULT_PASSWORD_FILE
Description:
사용할 vault 비밀번호 파일이에요. --vault-password-file 또는 --vault-id와 동등해요. 실행 가능하면 실행되고 결과 stdout이 비밀번호로 사용돼요.
Type:
path
Default:
None
Ini:
Section:
[defaults]
Key:
vault_password_file
Environment:
Variable:
ANSIBLE_VAULT_PASSWORD_FILE
DEFAULT_VERBOSITY
Description:
기본 verbosity를 설정해요. 커맨드라인에 전달된 -v 개수와 동등해요.
Type:
integer
Default:
0
Ini:
Section:
[defaults]
Key:
verbosity
Environment:
Variable:
ANSIBLE_VERBOSITY
DEPRECATION_WARNINGS
Description:
deprecation 경고 표시를 제어하는 토글이에요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
deprecation_warnings
Environment:
Variable:
ANSIBLE_DEPRECATION_WARNINGS
Variables:
name:
ansible_deprecation_warnings
Version Added:
2.19
DEVEL_WARNING
Description:
devel 실행과 관련된 경고 표시를 제어하는 토글이에요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
devel_warning
Environment:
Variable:
ANSIBLE_DEVEL_WARNING
DIFF_ALWAYS
Description:
'changed' 상태일 때 모듈이 차이점을 표시하게 하는 구성 토글로, --diff와 동등해요.
Type:
bool
Default:
False
Ini:
Section:
[diff]
Key:
always
Environment:
Variable:
ANSIBLE_DIFF_ALWAYS
DIFF_CONTEXT
Description:
파일 간 차이를 표시할 때 보여줄 컨텍스트 줄 수예요.
Type:
integer
Default:
3
Ini:
Section:
[diff]
Key:
context
Environment:
Variable:
ANSIBLE_DIFF_CONTEXT
DISPLAY_ARGS_TO_STDOUT
Description:
보통 ansible-playbook은 실행되는 각 태스크에 헤더를 출력해요. 이 헤더에는 지정했다면 태스크의 name: 필드가 포함돼요. 지정하지 않았다면 ansible-playbook은 태스크의 액션을 사용해 현재 실행 중인 태스크를 구분하게 해줘요. 때로 같은 액션을 많이 실행해서 같은 액션의 다른 태스크와 구분하기 위해 태스크에 대한 더 많은 정보를 원할 수 있어요. 이 변수를 True로 설정하면 ansible-playbook이 헤더에 태스크의 인자도 포함해요. 매개변수에 민감한 값이 있고 출력되길 원하지 않을 가능성이 있으므로 기본값은 False예요. True로 설정했다면 환경의 stdout을 안전하게 했는지(아무도 화면을 훔쳐보지 못하고 stdout을 안전하지 않은 파일에 저장하지 않는지) 확인하거나, 모든 플레이북이 민감한 값이 있는 태스크에 명시적으로 no_log: True 매개변수를 추가했는지 확인해야 해요. 자세한 내용은 '플레이북에서 비밀 데이터를 어떻게 지키나요?'를 참고하세요.
Type:
boolean
Default:
False
Version Added:
2.1
Ini:
Section:
[defaults]
Key:
display_args_to_stdout
Environment:
Variable:
ANSIBLE_DISPLAY_ARGS_TO_STDOUT
DISPLAY_SKIPPED_HOSTS
Description:
기본 콜백에서 태스크의 건너뛴 태스크/호스트 항목 표시를 제어하는 토글이에요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
display_skipped_hosts
Environment:
Variable:
ANSIBLE_DISPLAY_SKIPPED_HOSTS
DISPLAY_TRACEBACK
Description:
확장 오류 메시지에 traceback을 언제 포함할지예요.
Type:
list
Default:
['never']
Choices:
error
warning
deprecated
deprecated_value
always
never
Version Added:
2.19
Ini:
Section:
[defaults]
Key:
display_traceback
Environment:
Variable:
ANSIBLE_DISPLAY_TRACEBACK
DOC_FRAGMENT_PLUGIN_PATH
Description:
Ansible이 문서 프래그먼트 플러그인을 검색할 콜론으로 구분된 경로예요.
Type:
pathspec
Default:
{{ANSIBLE_HOME~"/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments"}}
Ini:
Section:
[defaults]
Key:
doc_fragment_plugins
Environment:
Variable:
ANSIBLE_DOC_FRAGMENT_PLUGINS
DOCSITE_ROOT_URL
Description:
Root docsite URL used to generate docs URLs in warning/error text; must be an absolute URL with a valid scheme and trailing slash.
Default:
https://docs.ansible.com/ansible-core/
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
docsite_root_url
DUPLICATE_YAML_DICT_KEY
Description:
기본적으로 Ansible은 YAML에서 중복 dict 키를 만나면 경고를 발행해요. 이 설정을 False로 바꾸면 이 경고를 끌 수 있어요.
Type:
string
Default:
warn
Choices:
error:
issue a ‘fatal’ error and stop the play
warn:
issue a warning but continue
ignore:
just continue silently
Version Added:
2.9
Ini:
Section:
[defaults]
Key:
duplicate_dict_key
Environment:
Variable:
ANSIBLE_DUPLICATE_YAML_DICT_KEY
EDITOR
Description:
for the cases in which Ansible needs to return a file within an editor, this chooses the application to use.
Default:
vi
Ini:
Section:
[defaults]
Key:
editor
Version Added:
2.15
Environment:
Variable:
ANSIBLE_EDITOR
Version Added:
2.15
Variable:
EDITOR
ENABLE_TASK_DEBUGGER
Description:
태스크 디버거를 활성화할지 여부예요. 이전에는 전략 플러그인으로 수행됐어요. 이제 모든 전략 플러그인이 이 동작을 상속할 수 있어요. 디버거는 태스크가 unreachable로 실패할 때 기본적으로 활성화돼요. 더 유연하려면 debugger 키워드를 사용하세요.
Type:
boolean
Default:
False
Version Added:
2.5
Ini:
Section:
[defaults]
Key:
enable_task_debugger
Environment:
Variable:
ANSIBLE_ENABLE_TASK_DEBUGGER
ERROR_ON_MISSING_HANDLER
Description:
알릴 때 누락된 핸들러가 오류 대신 경고가 되게 허용하는 토글이에요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
error_on_missing_handler
Environment:
Variable:
ANSIBLE_ERROR_ON_MISSING_HANDLER
FACTS_MODULES
Description:
play의 팩트 수집 단계에서 실행할 모듈을 지정해요. 'smart' 기본값을 사용하면 연결 타입에 따라 알아내려고 시도해요. 자신의 모듈을 추가하면서 여전히 기본 Ansible 팩트를 사용하고 싶다면 목록에 'setup' 또는 해당 네트워크 모듈을 포함해야 해요('smart'를 추가하면 Ansible이 또 알아냄). 이것은 'setup' 모듈의 명시적 호출에는 영향을 주지 않지만, 'gather_facts' 액션(암시적이든 명시적이든)에는 항상 영향을 줘요.
Type:
list
Default:
['smart']
Ini:
Section:
[defaults]
Key:
facts_modules
Environment:
Variable:
ANSIBLE_FACTS_MODULES
Variables:
name:
ansible_facts_modules
GALAXY_CACHE_DIR
Description:
Galaxy 서버의 캐시된 응답을 저장하는 디렉토리예요. ansible-galaxy collection install과 download 명령만 사용해요. 이 디렉토리 안의 캐시 파일은 world writable이면 무시돼요.
Type:
path
Default:
{{ANSIBLE_HOME~"/galaxy_cache"}}
Version Added:
2.11
Ini:
Section:
[galaxy]
Key:
cache_dir
Environment:
Variable:
ANSIBLE_GALAXY_CACHE_DIR
GALAXY_COLLECTION_IMPORT_POLL_FACTOR
Description:
컬렉션 가져오기 상태를 확인할 때 GALAXY_COLLECTION_IMPORT_POLL_INTERVAL을 늘리는 데 사용하는 배율이에요.
Type:
float
Default:
1.5
Version Added:
2.18
Environment:
Variable:
ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_FACTOR
GALAXY_COLLECTION_IMPORT_POLL_INTERVAL
Description:
컬렉션 가져오기 상태를 폴링하는 초 단위 초기 간격이에요. 이 간격은 GALAXY_COLLECTION_IMPORT_POLL_FACTOR에 따라 기하급수적으로 늘어나며 최대 30초 지연돼요.
Type:
float
Default:
2.0
Version Added:
2.18
Environment:
Variable:
ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_INTERVAL
GALAXY_COLLECTION_SKELETON
Description:
ansible-galaxy collection의 init 액션에 템플릿으로 사용할 컬렉션 스켈레톤 디렉토리예요. --collection-skeleton과 같아요.
Type:
path
Ini:
Section:
[galaxy]
Key:
collection_skeleton
Environment:
Variable:
ANSIBLE_GALAXY_COLLECTION_SKELETON
GALAXY_COLLECTION_SKELETON_IGNORE
Description:
Galaxy 컬렉션 스켈레톤 디렉토리 안에서 무시할 파일 패턴이에요.
Type:
list
Default:
['^.git$','^.*/.git_keep$']
Ini:
Section:
[galaxy]
Key:
collection_skeleton_ignore
Environment:
Variable:
ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE
GALAXY_COLLECTIONS_PATH_WARNING
Description:
ansible-galaxy collection install이 구성된 COLLECTIONS_PATHS에서 --collections-path가 빠졌을 때 경고할지 여부예요.
Type:
bool
Default:
True
Version Added:
2.16
Ini:
Section:
[galaxy]
Key:
collections_path_warning
Environment:
Variable:
ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING
GALAXY_DISABLE_GPG_VERIFY
Description:
컬렉션 설치 중 GPG 서명 검증을 비활성화해요.
Type:
bool
Default:
False
Version Added:
2.13
Ini:
Section:
[galaxy]
Key:
disable_gpg_verify
Environment:
Variable:
ANSIBLE_GALAXY_DISABLE_GPG_VERIFY
GALAXY_DISPLAY_PROGRESS
Description:
ansible-galaxy의 일부 단계는 특정 화면이나 stdout을 파일로 출력할 때 문제를 일으킬 수 있는 진행 휠을 표시해요. 이 구성 옵션은 표시 휠을 보여줄지 여부를 제어해요. 기본값은 stdout에 tty가 있으면 표시 휠을 보여주는 거예요.
Type:
bool
Default:
None
Version Added:
2.10
Ini:
Section:
[galaxy]
Key:
display_progress
Environment:
Variable:
ANSIBLE_GALAXY_DISPLAY_PROGRESS
GALAXY_GPG_KEYRING
Description:
컬렉션 설치·검증 중 GPG 서명 검증에 사용할 키링을 구성해요.
Type:
path
Version Added:
2.13
Ini:
Section:
[galaxy]
Key:
gpg_keyring
Environment:
Variable:
ANSIBLE_GALAXY_GPG_KEYRING
GALAXY_IGNORE_CERTS
Description:
yes로 설정하면 ansible-galaxy는 TLS 인증서를 검증하지 않아요. 자체 서명 인증서가 있는 서버에 대해 테스트할 때 유용할 수 있어요.
Type:
boolean
Ini:
Section:
[galaxy]
Key:
ignore_certs
Environment:
Variable:
ANSIBLE_GALAXY_IGNORE
GALAXY_IGNORE_INVALID_SIGNATURE_STATUS_CODES
Description:
GPG 서명 검증 중 무시할 GPG 상태 코드 목록이에요. 상태 코드 설명은 L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes)을 참고하세요. GALAXY_REQUIRED_VALID_SIGNATURE_COUNT보다 적은 서명이 컬렉션을 성공적으로 검증하면, 모든 오류 코드를 무시하더라도 서명 검증이 실패해요.
Type:
list
Choices:
EXPSIG
EXPKEYSIG
REVKEYSIG
BADSIG
ERRSIG
NO_PUBKEY
MISSING_PASSPHRASE
BAD_PASSPHRASE
NODATA
UNEXPECTED
ERROR
FAILURE
BADARMOR
KEYEXPIRED
KEYREVOKED
NO_SECKEY
Ini:
Section:
[galaxy]
Key:
ignore_signature_status_codes
Environment:
Variable:
ANSIBLE_GALAXY_IGNORE_SIGNATURE_STATUS_CODES
GALAXY_REQUIRED_VALID_SIGNATURE_COUNT
Description:
컬렉션을 설치하거나 검증할 때 GPG 서명 검증 중 성공해야 하는 서명 수예요. 양의 정수이거나 'all'이어야 하며, 'all'은 모든 서명이 컬렉션을 성공적으로 검증해야 함을 나타내요. 값 앞에 +를 붙이면 컬렉션에 대해 유효한 서명이 없을 때 실패하게 해요.
Type:
str
Default:
1
Ini:
Section:
[galaxy]
Key:
required_valid_signature_count
Environment:
Variable:
ANSIBLE_GALAXY_REQUIRED_VALID_SIGNATURE_COUNT
GALAXY_ROLE_SKELETON
Description:
ansible-galaxy/ansible-galaxy role의 init 액션에 템플릿으로 사용할 롤 스켈레톤 디렉토리예요. --role-skeleton과 같아요.
Type:
path
Ini:
Section:
[galaxy]
Key:
role_skeleton
Environment:
Variable:
ANSIBLE_GALAXY_ROLE_SKELETON
GALAXY_ROLE_SKELETON_IGNORE
Description:
Galaxy 롤 또는 컬렉션 스켈레톤 디렉토리 안에서 무시할 파일 패턴이에요.
Type:
list
Default:
['^.git$','^.*/.git_keep$']
Ini:
Section:
[galaxy]
Key:
role_skeleton_ignore
Environment:
Variable:
ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE
GALAXY_SERVER
Description:
URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source.
Default:
https://galaxy.ansible.com
Ini:
Section:
[galaxy]
Key:
server
Environment:
Variable:
ANSIBLE_GALAXY_SERVER
GALAXY_SERVER_LIST
Description:
컬렉션을 설치할 때 사용할 Galaxy 서버 목록이에요. 값은 서버 세부 정보를 정의하는 구성 ini 헤더 [galaxy_server.{{item}}]에 대응해요. Galaxy 서버를 정의하는 방법에 대한 자세한 내용은 'ansible-galaxy 클라이언트 구성'을 참고하세요. 이 목록의 서버 순서가 컬렉션 해석 순서로 사용돼요. 이 구성 옵션을 설정하면 GALAXY_SERVER 구성 옵션이 무시돼요.
Type:
list
Version Added:
2.9
Ini:
Section:
[galaxy]
Key:
server_list
Environment:
Variable:
ANSIBLE_GALAXY_SERVER_LIST
GALAXY_SERVER_TIMEOUT
Description:
Galaxy API 호출의 기본 타임아웃이에요. 특정 타임아웃을 구성하지 않은 Galaxy 서버는 이 값으로 폴백해요.
Type:
int
Default:
60
Ini:
Section:
[galaxy]
Key:
server_timeout
Environment:
Variable:
ANSIBLE_GALAXY_SERVER_TIMEOUT
GALAXY_TOKEN_PATH
Description:
galaxy 액세스 토큰 파일의 로컬 경로예요.
Type:
path
Default:
{{ANSIBLE_HOME~"/galaxy_token"}}
Version Added:
2.9
Ini:
Section:
[galaxy]
Key:
token_path
Environment:
Variable:
ANSIBLE_GALAXY_TOKEN_PATH
HOST_KEY_CHECKING
Description:
Ansible이 호스트에 연결하는 데 사용하는 기본 연결 플러그인에서 호스트 키 검사를 피하고 싶다면 'False'로 설정하세요. 사용된 특정 연결 플러그인의 문서를 읽어 자세히 확인하세요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
host_key_checking
Environment:
Variable:
ANSIBLE_HOST_KEY_CHECKING
HOST_PATTERN_MISMATCH
Description:
This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it.
Default:
warning
Choices:
error:
issue a ‘fatal’ error and stop the play
warning:
issue a warning but continue
ignore:
just continue silently
Version Added:
2.8
Ini:
Section:
[inventory]
Key:
host_pattern_mismatch
Environment:
Variable:
ANSIBLE_HOST_PATTERN_MISMATCH
INJECT_FACTS_AS_VARS
Description:
팩트는 ansible_facts 변수 안에서 사용할 수 있어요. 이 설정은 그것들을 주요 네임스페이스의 자체 변수로도 밀어 넣어요. ansible_facts 딕셔너리 안에서 팩트 이름에서 접두사 ansible_가 제거되는 것과 달리, 이것들은 모듈이 반환하는 정확한 이름을 가져요.
Type:
boolean
Default:
True
Version Added:
2.5
Ini:
Section:
[defaults]
Key:
inject_facts_as_vars
Environment:
Variable:
ANSIBLE_INJECT_FACT_VARS
INJECT_INVOCATION
Description:
활성화하면 사용된 모듈/액션 인자와 함께 태스크 결과에 invocation 키가 추가돼요. 대부분의 콜백 플러그인은 기본적으로 태스크 결과 표시에서 invocation 키를 가려요.
Type:
boolean
Default:
False
Version Added:
2.21
Ini:
Section:
[defaults]
Key:
inject_invocation
Environment:
Variable:
ANSIBLE_INJECT_INVOCATION
Variables:
name:
ansible_inject_invocation
INTERPRETER_PYTHON
Description:
Path to the Python interpreter to be used for module execution on remote targets, or an automatic discovery mode. Supported discovery modes are auto (the default), and auto_silent. All discovery modes match against an ordered list of well-known Python interpreter locations. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters installed later may change which one is used). This warning behavior can be disabled by setting auto_silent. The auto_legacy* modes are removed. They exist for backward-compatibility with older Ansible releases that always defaulted to /usr/bin/python3, which will use that interpreter if present.
Default:
auto
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
interpreter_python
Environment:
Variable:
ANSIBLE_PYTHON_INTERPRETER
Variables:
name:
ansible_python_interpreter
INTERPRETER_PYTHON_FALLBACK
Type:
list
Default:
['python3.14','python3.13','python3.12','python3.11','python3.10','python3.9','/usr/bin/python3','python3']
Version Added:
2.8
Variables:
name:
ansible_interpreter_python_fallback
INVALID_TASK_ATTRIBUTE_FAILED
Description:
'false'이면 태스크의 잘못된 속성이 오류 대신 경고를 낳아요.
Type:
boolean
Default:
True
Version Added:
2.7
Ini:
Section:
[defaults]
Key:
invalid_task_attribute_failed
Environment:
Variable:
ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED
INVENTORY_ANY_UNPARSED_IS_FAILED
Description:
'true'이면 주어진 어떤 인벤토리 원천도 사용 가능한 인벤토리 플러그인으로 파싱되지 못할 때 치명적 오류예요. 그렇지 않으면 이 상황은 경고만 불러일으켜요.
Type:
boolean
Default:
False
Version Added:
2.7
Ini:
Section:
[inventory]
Key:
any_unparsed_is_failed
Environment:
Variable:
ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED
INVENTORY_ENABLED
Description:
활성화된 인벤토리 플러그인 목록이에요. 사용 순서도 결정해요.
Type:
list
Default:
['host_list','script','auto','yaml','ini','toml']
Ini:
Section:
[inventory]
Key:
enable_plugins
Environment:
Variable:
ANSIBLE_INVENTORY_ENABLED
INVENTORY_EXPORT
Description:
ansible-inventory가 Ansible의 인벤토리 뷰를 정확히 반영할지, 아니면 내보내기에 최적화된 방식을 반영할지 제어해요.
Type:
bool
Default:
False
Ini:
Section:
[inventory]
Key:
export
Environment:
Variable:
ANSIBLE_INVENTORY_EXPORT
INVENTORY_IGNORE_EXTS
Description:
디렉토리를 인벤토리 원천으로 사용할 때 무시할 확장자 목록이에요.
Type:
list
Default:
{{REJECT_EXTS+['.orig','.cfg','.retry']}}
Ini:
Section:
[defaults]
Key:
inventory_ignore_extensions
Section:
[inventory]
Key:
ignore_extensions
Environment:
Variable:
ANSIBLE_INVENTORY_IGNORE
INVENTORY_IGNORE_PATTERNS
Description:
디렉토리를 인벤토리 원천으로 사용할 때 무시할 패턴 목록이에요.
Type:
list
Default:
[]
Ini:
Section:
[defaults]
Key:
inventory_ignore_patterns
Section:
[inventory]
Key:
ignore_patterns
Environment:
Variable:
ANSIBLE_INVENTORY_IGNORE_REGEX
INVENTORY_UNPARSED_IS_FAILED
Description:
'true'이면 모든 잠재적 인벤토리 원천이 파싱에 실패하면 치명적 오류예요. 그렇지 않으면 이 상황은 경고만 불러일으켜요.
Type:
bool
Default:
False
Ini:
Section:
[inventory]
Key:
unparsed_is_failed
Environment:
Variable:
ANSIBLE_INVENTORY_UNPARSED_FAILED
INVENTORY_UNPARSED_WARNING
Description:
기본적으로 Ansible은 인벤토리가 로드되지 않았을 때 경고를 발행하고 암시적 로컬호스트 전용 인벤토리를 사용할 것이라고 알려요. 이 설정을 False로 바꾸면 이 경고를 끌 수 있어요.
Type:
boolean
Default:
True
Version Added:
2.14
Ini:
Section:
[inventory]
Key:
inventory_unparsed_warning
Environment:
Variable:
ANSIBLE_INVENTORY_UNPARSED_WARNING
LOCALHOST_WARNING
Description:
기본적으로 Ansible은 인벤토리에 호스트가 없을 때 경고를 발행해요. 이 설정을 False로 바꾸면 이 경고를 끌 수 있어요.
Type:
boolean
Default:
True
Version Added:
2.6
Ini:
Section:
[defaults]
Key:
localhost_warning
Environment:
Variable:
ANSIBLE_LOCALHOST_WARNING
LOG_VERBOSITY
Description:
일반 표시 verbosity보다 높으면 로그 verbosity를 설정하고 그렇지 않으면 일치시켜요.
Type:
int
Version Added:
2.17
Ini:
Section:
[defaults]
Key:
log_verbosity
Environment:
Variable:
ANSIBLE_LOG_VERBOSITY
MAX_FILE_SIZE_FOR_DIFF
Description:
diff 표시에 고려할 파일의 최대 크기예요.
Type:
int
Default:
104448
Ini:
Section:
[defaults]
Key:
max_diff_size
Environment:
Variable:
ANSIBLE_MAX_DIFF_SIZE
MODULE_IGNORE_EXTS
Description:
로드할 모듈을 찾을 때 무시할 확장자 목록이에요. 스크립트와 바이너리 모듈 폴백 확장자를 거부하기 위한 것이에요.
Type:
list
Default:
{{REJECT_EXTS+['.yaml','.yml','.ini']}}
Ini:
Section:
[defaults]
Key:
module_ignore_exts
Environment:
Variable:
ANSIBLE_MODULE_IGNORE_EXTS
MODULE_STRICT_UTF8_RESPONSE
Description:
모듈 응답이 비-UTF-8 데이터를 포함하는지 평가할지 여부를 활성화해요. 비활성화하면 예상치 못한 동작이 발생할 수 있어요. 이 구성을 평가하는 것은 ansible-core만 해야 해요.
Type:
bool
Default:
True
Ini:
Section:
[defaults]
Key:
module_strict_utf8_response
Environment:
Variable:
ANSIBLE_MODULE_STRICT_UTF8_RESPONSE
NETCONF_SSH_CONFIG
Description:
This variable is used to enable bastion/jump host with netconf connection. If set to True the bastion/jump host ssh settings should be present in ~/.ssh/config file, alternatively it can be set to custom ssh configuration file path to read the bastion/jump host settings.
Default:
None
Ini:
Section:
[netconf_connection]
Key:
ssh_config
Environment:
Variable:
ANSIBLE_NETCONF_SSH_CONFIG
NETWORK_GROUP_MODULES
Type:
list
Default:
['eos','nxos','ios','iosxr','junos','enos','ce','vyos','sros','dellos9','dellos10','dellos6','asa','aruba','aireos','bigip','ironware','onyx','netconf','exos','voss','slxos']
Ini:
Section:
[defaults]
Key:
network_group_modules
Environment:
Variable:
ANSIBLE_NETWORK_GROUP_MODULES
OLD_PLUGIN_CACHE_CLEARING
Description:
이전에는 Ansible이 새 롤을 로드할 때 플러그인 로딩 캐시의 일부만 비웠어요. 이로 인해 이전 play에서 로드된 플러그인이 예기치 않게 '고착(sticky)'되는 동작이 발생했어요. 이 설정은 사용자가 그 동작으로 돌아가게 해줘요.
Type:
boolean
Default:
False
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
old_plugin_cache_clear
Environment:
Variable:
ANSIBLE_OLD_PLUGIN_CACHE_CLEAR
PAGER
Description:
for the cases in which Ansible needs to return output in a pageable fashion, this chooses the application to use.
Default:
less
Ini:
Section:
[defaults]
Key:
pager
Version Added:
2.15
Environment:
Variable:
ANSIBLE_PAGER
Version Added:
2.15
Variable:
PAGER
PERSISTENT_COMMAND_TIMEOUT
Description:
영구 연결이 타임아웃되기 전에 원격 장치에서 응답을 기다리는 시간을 제어해요.
Type:
int
Default:
30
Ini:
Section:
[persistent_connection]
Key:
command_timeout
Environment:
Variable:
ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
PERSISTENT_CONNECT_RETRY_TIMEOUT
Description:
영구 연결이 로컬 도메인 소켓에 연결하기 위한 재시도 타임아웃을 제어해요.
Type:
integer
Default:
15
Ini:
Section:
[persistent_connection]
Key:
connect_retry_timeout
Environment:
Variable:
ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT
PERSISTENT_CONNECT_TIMEOUT
Description:
영구 연결이 파괴되기 전에 유휴 상태로 유지될 시간을 제어해요.
Type:
integer
Default:
30
Ini:
Section:
[persistent_connection]
Key:
connect_timeout
Environment:
Variable:
ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
PERSISTENT_CONTROL_PATH_DIR
Description:
연결 지속성 시스템이 사용할 소켓 경로예요.
Type:
path
Default:
{{ANSIBLE_HOME~"/pc"}}
Ini:
Section:
[persistent_connection]
Key:
control_path_dir
Environment:
Variable:
ANSIBLE_PERSISTENT_CONTROL_PATH_DIR
PLAYBOOK_DIR
Description:
여러 비-플레이북 CLI에 --playbook-dir 인자가 있어요. 이것은 그 기본값을 설정해요.
Type:
path
Version Added:
2.9
Ini:
Section:
[defaults]
Key:
playbook_dir
Environment:
Variable:
ANSIBLE_PLAYBOOK_DIR
PLAYBOOK_VARS_ROOT
Description:
This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars.
Default:
top
Choices:
top:
follows the traditional behavior of using the top playbook in the chain to find the root directory.
bottom:
follows the 2.4.0 behavior of using the current playbook to find the root directory.
all:
examines from the first parent to the current playbook.
Version Added:
2.4.1
Ini:
Section:
[defaults]
Key:
playbook_vars_root
Environment:
Variable:
ANSIBLE_PLAYBOOK_VARS_ROOT
PLUGIN_FILTERS_CFG
Description:
시스템에 설치된 플러그인 중 어떤 것이 사용 허용되는지 필터링하는 구성 경로예요. 필터 파일 형식의 자세한 내용은 '모듈 거부' 문서를 참고하세요. 기본값은 /etc/ansible/plugin_filters.yml이에요.
Type:
path
Default:
None
Version Added:
2.5.0
Ini:
Section:
[defaults]
Key:
plugin_filters_cfg
PYTHON_MODULE_RLIMIT_NOFILE
Description:
Attempts to set RLIMIT_NOFILE soft limit to the specified value when executing Python modules (can speed up subprocess usage on Python 2.x. See https://bugs.python.org/issue11284). The value will be limited by the existing hard limit. Default value of 0 does not attempt to adjust existing system-defined limits.
Default:
0
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
python_module_rlimit_nofile
Environment:
Variable:
ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE
Variables:
name:
ansible_python_module_rlimit_nofile
RETRY_FILES_ENABLED
Description:
실패한 Ansible 플레이북이 .retry 파일을 만들지 제어해요.
Type:
bool
Default:
False
Ini:
Section:
[defaults]
Key:
retry_files_enabled
Environment:
Variable:
ANSIBLE_RETRY_FILES_ENABLED
RETRY_FILES_SAVE_PATH
Description:
플레이북이 실패하고 retry 파일이 활성화되었을 때 Ansible이 .retry 파일을 저장할 경로를 설정해요. 이 파일은 모든 play의 실패한 호스트 목록으로 각 실행 후 덮어써져요.
Type:
path
Default:
None
Ini:
Section:
[defaults]
Key:
retry_files_save_path
Environment:
Variable:
ANSIBLE_RETRY_FILES_SAVE_PATH
RUN_VARS_PLUGINS
Description:
사용자의 인벤토리 크기와 play 선택에 따라 vars_plugin 사용을 최적화하는 설정이에요.
Type:
str
Default:
demand
Choices:
demand:
will run vars_plugins relative to inventory sources anytime vars are ‘demanded’ by tasks.
start:
will run vars_plugins relative to inventory sources after importing that inventory source.
Version Added:
2.10
Ini:
Section:
[defaults]
Key:
run_vars_plugins
Environment:
Variable:
ANSIBLE_RUN_VARS_PLUGINS
SHOW_CUSTOM_STATS
Description:
set_stats 플러그인으로 설정된 커스텀 통계를 기본 출력에 추가해요.
Type:
bool
Default:
False
Ini:
Section:
[defaults]
Key:
show_custom_stats
Environment:
Variable:
ANSIBLE_SHOW_CUSTOM_STATS
SSH_AGENT
Description:
Ansible을 통해 SSH 에이전트를 관리해요. none 구성은 에이전트와 상호작용하지 않고, auto는 실행 중 ssh-agent 바이너리로 에이전트를 시작·파괴하며, SSH_AUTH_SOCK 경로는 기존 에이전트와의 상호작용을 허용해요.
Type:
string
Default:
none
Version Added:
2.19
Ini:
Section:
[connection]
Key:
ssh_agent
Environment:
Variable:
ANSIBLE_SSH_AGENT
SSH_AGENT_EXECUTABLE
Description:
SSH_AGENT가 auto일 때 시작할 ssh 에이전트 실행 파일의 경로 또는 이름이에요.
Type:
str
Default:
ssh-agent
Version Added:
2.19
Ini:
Section:
[connection]
Key:
ssh_agent_executable
Environment:
Variable:
ANSIBLE_SSH_AGENT_EXECUTABLE
SSH_AGENT_KEY_LIFETIME
Description:
SSH_AGENT가 정의한 에이전트에 삽입되는 키에 대해, 키가 에이전트에 머물 수 있는 수명(초)을 정의해요.
Type:
int
Version Added:
2.19
Ini:
Section:
[connection]
Key:
ssh_agent_key_lifetime
Environment:
Variable:
ANSIBLE_SSH_AGENT_KEY_LIFETIME
STRING_TYPE_FILTERS
Description:
이 필터 목록은 변수를 템플릿화할 때 '타입 변환'을 피해요. 예를 들어 JSON 문자열을 목록이나 딕셔너리로 변환하는 것을 피하고 싶을 때 유용해요.
Type:
list
Default:
['string','to_json','to_nice_json','to_yaml','to_nice_yaml','ppretty','json']
Ini:
Section:
[jinja2]
Key:
dont_type_filters
Environment:
Variable:
ANSIBLE_STRING_TYPE_FILTERS
Note:
This configuration is now deprecated and scheduled for removal. You should update to a current alternative.
Scheduled removal:
2.23
Deprecation reason:
This option has no effect.
Current alternatives:
None; native types returned from filters are always preserved.
SYSTEM_WARNINGS
Description:
Ansible 자체를 실행 중인 시스템(관리 호스트가 아님)의 잠재적 문제에 대한 경고를 비활성화할 수 있어요. 타사 패키지나 가능하면 해결해야 할 다른 조건에 대한 경고를 포함할 수 있어요.
Type:
boolean
Default:
True
Ini:
Section:
[defaults]
Key:
system_warnings
Environment:
Variable:
ANSIBLE_SYSTEM_WARNINGS
TAGS_RUN
Description:
play에서 실행할 기본 태그 목록이에요. Skip Tags가 우선해요.
Type:
list
Default:
[]
Version Added:
2.5
Ini:
Section:
[tags]
Key:
run
Environment:
Variable:
ANSIBLE_RUN_TAGS
TAGS_SKIP
Description:
play에서 건너뛸 기본 태그 목록이에요. Run Tags보다 우선해요.
Type:
list
Default:
[]
Version Added:
2.5
Ini:
Section:
[tags]
Key:
skip
Environment:
Variable:
ANSIBLE_SKIP_TAGS
TARGET_LOG_INFO
Description:
A string to insert into target logging for tracking purposes
Version Added:
2.17
Ini:
Section:
[defaults]
Key:
target_log_info
Environment:
Variable:
ANSIBLE_TARGET_LOG_INFO
Variables:
name:
ansible_target_log_info
TASK_DEBUGGER_IGNORE_ERRORS
Description:
이 옵션은 ignore_errors=True가 지정된 실패한 태스크에서 태스크 디버거를 호출할지 정의해요. True는 디버거가 ignore_errors를 존중하고, False는 존중하지 않아요.
Type:
boolean
Default:
True
Version Added:
2.7
Ini:
Section:
[defaults]
Key:
task_debugger_ignore_errors
Environment:
Variable:
ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS
TASK_TIMEOUT
Description:
태스크 액션이 실행될 최대 시간(초)을 설정해요. 타임아웃은 템플릿화나 루핑과 독립적으로 실행돼요. 태스크 액션 실행의 각 시도에 적용되며 태스크에 소요된 총 시간에 따라 변하지 않아요. 액션 실행이 타임아웃을 초과하면 Ansible은 프로세스를 중단해요. 이것은 태스크 실패가 아니라 외부 상황으로 인한 실패로 등록되어 적절한 대응과 복구 프로세스를 받아요. 0(기본값)으로 설정하면 타임아웃이 없어요.
Type:
integer
Default:
0
Version Added:
2.10
Ini:
Section:
[defaults]
Key:
task_timeout
Environment:
Variable:
ANSIBLE_TASK_TIMEOUT
TRANSFORM_INVALID_GROUP_CHARS
Description:
인벤토리 원천이 제공한 그룹 이름의 잘못된 문자를 ansible이 변환하게 해요.
Type:
string
Default:
never
Choices:
always:
it will replace any invalid characters with ‘_’ (underscore) and warn the user
never:
it will allow for the group name but warn about the issue
ignore:
it does the same as ‘never’, without issuing a warning
silently:
it does the same as ‘always’, without issuing a warning
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
force_valid_group_names
Environment:
Variable:
ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS
USE_PERSISTENT_CONNECTIONS
Description:
연결에 지속성 활용을 토글해요.
Type:
boolean
Default:
False
Ini:
Section:
[defaults]
Key:
use_persistent_connections
Environment:
Variable:
ANSIBLE_USE_PERSISTENT_CONNECTIONS
VALIDATE_ACTION_GROUP_METADATA
Description:
module_defaults 액션 그룹의 컬렉션 'metadata' 항목 검증을 비활성화하는 토글이에요. 예상치 못한 필드나 값 타입을 담은 메타데이터는 이것이 True일 때 경고를 낳아요.
Type:
bool
Default:
True
Version Added:
2.12
Ini:
Section:
[defaults]
Key:
validate_action_group_metadata
Environment:
Variable:
ANSIBLE_VALIDATE_ACTION_GROUP_METADATA
VARIABLE_PLUGINS_ENABLED
Description:
필요로 하는 변수 플러그인의 허용 목록이에요.
Type:
list
Default:
['host_group_vars']
Version Added:
2.10
Ini:
Section:
[defaults]
Key:
vars_plugins_enabled
Environment:
Variable:
ANSIBLE_VARS_ENABLED
VARIABLE_PRECEDENCE
Description:
그룹 변수 우선순위 병합 순서를 바꿀 수 있어요.
Type:
list
Default:
['all_inventory','groups_inventory','all_plugins_inventory','all_plugins_play','groups_plugins_inventory','groups_plugins_play']
Version Added:
2.4
Ini:
Section:
[defaults]
Key:
precedence
Environment:
Variable:
ANSIBLE_PRECEDENCE
VAULT_ENCRYPT_SALT
Description:
The salt to use for the vault encryption. If it is not provided, a random salt will be used.
Default:
None
Version Added:
2.15
Ini:
Section:
[defaults]
Key:
vault_encrypt_salt
Environment:
Variable:
ANSIBLE_VAULT_ENCRYPT_SALT
VERBOSE_TO_STDERR
Description:
'verbose' 옵션이 stdout 대신 stderr을 사용하게 해요.
Type:
bool
Default:
False
Version Added:
2.8
Ini:
Section:
[defaults]
Key:
verbose_to_stderr
Environment:
Variable:
ANSIBLE_VERBOSE_TO_STDERR
WIN_ASYNC_STARTUP_TIMEOUT
Description:
Ansible의 비동기 태스크(비동기 액션과 폴링에서 다룸)에서, Ansible이 생성한 태스크가 Windows 시스템에서 사용되는 named pipe에 다시 연결할 때까지 기다리는 시간(초)이에요. 기본값은 5초예요. 느린 시스템이나 부하가 높은 시스템에서는 너무 낮을 수 있어요. 이것은 async 명령이 실행될 수 있는 총 시간이 아니라, async 명령이 시작되기를 기다리는 별도의 타임아웃이에요. 태스크는 파이프에 연결된 후에야 async_timeout에 대해 타이밍되기 시작하므로, 태스크가 걸릴 수 있는 전체 최대 지속 시간이 여기에 지정된 만큼 연장돼요.
Type:
integer
Default:
5
Version Added:
2.10
Ini:
Section:
[defaults]
Key:
win_async_startup_timeout
Environment:
Variable:
ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT
Variables:
name:
ansible_win_async_startup_timeout
WORKER_SESSION_ISOLATION
Description:
Ansible 포크된 워커는 공유 TTY의 경합을 피하기 위해 기본적으로 세션 격리로 실행돼요. 상속된 부모 TTY 접근이 필요하면 이 옵션을 false로 설정해 세션 격리를 비활성화해요. 세션 격리 비활성화는 필요에 따라 개별 태스크, 블록, play, 롤 또는 호스트에 ansible_worker_session_isolation 변수를 설정해 가능한 가장 작은 범위로 제한해야 해요.
Type:
boolean
Default:
True
Version Added:
2.21
Ini:
Section:
[defaults]
Key:
worker_session_isolation
Environment:
Variable:
ANSIBLE_WORKER_SESSION_ISOLATION
Variables:
name:
ansible_worker_session_isolation
WORKER_SHUTDOWN_POLL_COUNT
Description:
Task Queue Manager 워커 프로세스가 깨끗하게 종료되었는지 확인하기 위해 검사할 최대 횟수예요. 이 한도에 도달한 후에도 여전히 실행 중인 워커 프로세스는 종료돼요. 이것은 내부용이에요.
Type:
integer
Default:
0
Version Added:
2.10
Environment:
Variable:
ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT
WORKER_SHUTDOWN_POLL_DELAY
Description:
Task Queue Manager 워커 프로세스가 깨끗하게 종료되었는지 확인하기 위해 폴링 루프 사이에 잠드는 초 수예요. 이것은 내부용이에요.
Type:
float
Default:
0.1
Version Added:
2.10
Environment:
Variable:
ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY
YAML_FILENAME_EXTENSIONS
Description:
YAML 또는 JSON 또는 이들의 vaulted 버전이어야 하는 '변수' 파일을 찾을 때 이 모든 확장자를 확인해요. 이것은 vars_files, include_vars, 인벤토리, vars 플러그인 등에 영향을 줘요.
Type:
list
Default:
['.yml','.yaml','.json']
Ini:
Section:
[defaults]
Key:
yaml_valid_extensions
Environment:
Variable:
ANSIBLE_YAML_FILENAME_EXT
환경 변수 (Environment Variables)
아래 표는 각 설정 옵션에 대응하는 환경 변수를 정리한 목록이에요. 옵션 이름, 환경 변수 이름, 해당 INI 섹션/키 같은 식별자는 원문 그대로 보존했어요.
Environment Variables
Other environment variables to configure plugins in collections can be found in Index of all Collection Environment Variables.
ANSIBLE_CONFIG
Override the default ansible config file
ANSIBLE_ALLOW_BROKEN_CONDITIONALS
When enabled, this option allows conditionals with non-boolean results to be used.A deprecation warning will be emitted in these cases.By default, non-boolean conditionals result in an error.Such results often indicate unintentional use of templates where they are not supported, resulting in a conditional that is always true.When this option is enabled, conditional expressions which are a literal None or empty string will evaluate as true for backwards compatibility.
See also ALLOW_BROKEN_CONDITIONALS
ANSIBLE_ALLOW_EMBEDDED_TEMPLATES
When enabled, this option allows embedded templates to be used for specific backward compatibility scenarios.A deprecation warning will be emitted in these cases.First, conditionals (for example, failed_when, until, assert.that) fully enclosed in template delimiters.Second, string constants in conditionals (for example, when:some_var=='{{some_other_var}}').Finally, positional arguments to lookups (for example, lookup('pipe','echo{{some_var}}')).This feature is deprecated, since embedded templates are unnecessary in these cases.When disabled, use of embedded templates will result in an error.A future release will disable this feature by default.
See also ALLOW_EMBEDDED_TEMPLATES
ANSIBLE_HOME
The default root path for Ansible config files on the controller.
See also ANSIBLE_HOME
ANSIBLE_CONNECTION_PATH
Specify where to look for the ansible-connection script. This location will be checked before searching $PATH.If null, ansible will start with the same directory as the ansible script.
See also ANSIBLE_CONNECTION_PATH
ANSIBLE_COW_SELECTION
This allows you to choose a specific cowsay stencil for the banners or use ‘random’ to cycle through them.
See also ANSIBLE_COW_SELECTION
ANSIBLE_COW_ACCEPTLIST
Accept a list of cowsay templates that are ‘safe’ to use, set to an empty list if you want to enable all installed templates.
See also ANSIBLE_COW_ACCEPTLIST
Version Added:
2.11
ANSIBLE_FORCE_COLOR
This option forces color mode even when running without a TTY or the “nocolor” setting is True.
See also ANSIBLE_FORCE_COLOR
ANSIBLE_NOCOLOR
This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.
See also ANSIBLE_NOCOLOR
NO_COLOR
This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.
See also ANSIBLE_NOCOLOR
Version Added:
2.11
ANSIBLE_NOCOWS
If you have cowsay installed but want to avoid the ‘cows’ (why????), use this.
See also ANSIBLE_NOCOWS
ANSIBLE_COW_PATH
Specify a custom cowsay path or swap in your cowsay implementation of choice.
See also ANSIBLE_COW_PATH
ANSIBLE_PIPELINING
This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all.Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfer.It can result in a very significant performance improvement when enabled.However this conflicts with privilege escalation (become). For example, when using ‘sudo:’ operations you must first disable ‘requiretty’ in /etc/sudoers on all managed hosts, which is why it is disabled by default.This setting will be disabled if ANSIBLE_KEEP_REMOTE_FILES is enabled.
See also ANSIBLE_PIPELINING
ANSIBLE_ANY_ERRORS_FATAL
Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors.
See also ANY_ERRORS_FATAL
ANSIBLE_BECOME_ALLOW_SAME_USER
When False``(default),Ansiblewillskipusingbecomeiftheremoteuseristhesameasthebecomeuser,asthisisnormallyaredundantoperation.Inotherwordsrootsudotoroot.If``True, this forces Ansible to use the become plugin anyways as there are cases in which this is needed.
See also BECOME_ALLOW_SAME_USER
ANSIBLE_BECOME_PASSWORD_FILE
The password file to use for the become plugin. --become-password-file.If executable, it will be run and the resulting stdout will be used as the password.
See also BECOME_PASSWORD_FILE
ANSIBLE_AGNOSTIC_BECOME_PROMPT
Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method.
See also AGNOSTIC_BECOME_PROMPT
ANSIBLE_CACHE_PLUGIN
Chooses which fact cache plugin to use. By default, no cache is used and facts do not persist between runs.
See also CACHE_PLUGIN
ANSIBLE_CACHE_PLUGIN_CONNECTION
Defines connection or path information for the fact cache plugin.
See also CACHE_PLUGIN_CONNECTION
ANSIBLE_CACHE_PLUGIN_PREFIX
Prefix to use for fact cache plugin files/tables.
See also CACHE_PLUGIN_PREFIX
ANSIBLE_CACHE_PLUGIN_TIMEOUT
Expiration timeout for the fact cache plugin data.
See also CACHE_PLUGIN_TIMEOUT
ANSIBLE_COLLECTIONS_SCAN_SYS_PATH
A boolean to enable or disable scanning the sys.path for installed collections.
See also COLLECTIONS_SCAN_SYS_PATH
ANSIBLE_COLLECTIONS_PATH
Colon-separated paths in which Ansible will search for collections content. Collections must be in nested subdirectories, not directly in these directories. For example, if COLLECTIONS_PATHS includes '{{ANSIBLE_HOME~"/collections"}}', and you want to add my.collection to that directory, it must be saved as '{{ANSIBLE_HOME~"/collections/ansible_collections/my/collection"}}'.
See also COLLECTIONS_PATHS
Version Added:
2.10
ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH
When a collection is loaded that does not support the running Ansible version (with the collection metadata key requires_ansible).
See also COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH
ANSIBLE_COLOR_CHANGED
Defines the color to use on ‘Changed’ task status.
See also COLOR_CHANGED
ANSIBLE_COLOR_CONSOLE_PROMPT
Defines the default color to use for ansible-console.
See also COLOR_CONSOLE_PROMPT
ANSIBLE_COLOR_DEBUG
Defines the color to use when emitting debug messages.
See also COLOR_DEBUG
ANSIBLE_COLOR_DEPRECATE
Defines the color to use when emitting deprecation messages.
See also COLOR_DEPRECATE
ANSIBLE_COLOR_DIFF_ADD
Defines the color to use when showing added lines in diffs.
See also COLOR_DIFF_ADD
ANSIBLE_COLOR_DIFF_LINES
Defines the color to use when showing diffs.
See also COLOR_DIFF_LINES
ANSIBLE_COLOR_DIFF_REMOVE
Defines the color to use when showing removed lines in diffs.
See also COLOR_DIFF_REMOVE
ANSIBLE_COLOR_ERROR
Defines the color to use when emitting error messages.
See also COLOR_ERROR
ANSIBLE_COLOR_HIGHLIGHT
Defines the color to use for highlighting.
See also COLOR_HIGHLIGHT
ANSIBLE_COLOR_INCLUDED
Defines the color to use when showing ‘Included’ task status.
See also COLOR_INCLUDED
ANSIBLE_COLOR_OK
Defines the color to use when showing ‘OK’ task status.
See also COLOR_OK
ANSIBLE_COLOR_SKIP
Defines the color to use when showing ‘Skipped’ task status.
See also COLOR_SKIP
ANSIBLE_COLOR_UNREACHABLE
Defines the color to use on ‘Unreachable’ status.
See also COLOR_UNREACHABLE
ANSIBLE_COLOR_VERBOSE
Defines the color to use when emitting verbose messages. In other words, those that show with ‘-v’s.
See also COLOR_VERBOSE
ANSIBLE_COLOR_WARN
Defines the color to use when emitting warning messages.
See also COLOR_WARN
ANSIBLE_COLOR_DOC_MODULE
Defines the color to use when emitting a module name in the ansible-doc output.
See also COLOR_DOC_MODULE
ANSIBLE_COLOR_DOC_REFERENCE
Defines the color to use when emitting cross-reference in the ansible-doc output.
See also COLOR_DOC_REFERENCE
ANSIBLE_COLOR_DOC_LINK
Defines the color to use when emitting a link in the ansible-doc output.
See also COLOR_DOC_LINK
ANSIBLE_COLOR_DOC_DEPRECATED
Defines the color to use when emitting a deprecated value in the ansible-doc output.
See also COLOR_DOC_DEPRECATED
ANSIBLE_COLOR_DOC_CONSTANT
Defines the color to use when emitting a constant in the ansible-doc output.
See also COLOR_DOC_CONSTANT
ANSIBLE_COLOR_DOC_PLUGIN
Defines the color to use when emitting a plugin name in the ansible-doc output.
See also COLOR_DOC_PLUGIN
ANSIBLE_CONNECTION_PASSWORD_FILE
The password file to use for the connection plugin. --connection-password-file.
See also CONNECTION_PASSWORD_FILE
_ANSIBLE_COVERAGE_REMOTE_OUTPUT
Sets the output directory on the remote host to generate coverage reports into.Currently only used for remote coverage on PowerShell modules.This is for internal use only.
See also COVERAGE_REMOTE_OUTPUT
_ANSIBLE_COVERAGE_REMOTE_PATH_FILTER
A list of paths for files on the Ansible controller to run coverage for when executing on the remote host.Only files that match the path glob will have their coverage collected.Multiple path globs can be specified and are separated by :.Currently only used for remote coverage on PowerShell modules.This is for internal use only.
See also COVERAGE_REMOTE_PATHS
ANSIBLE_ACTION_WARNINGS
By default, Ansible will issue a warning when received from a task action (module or action plugin).These warnings can be silenced by adjusting this setting to False.
See also ACTION_WARNINGS
ANSIBLE_LOCALHOST_WARNING
By default, Ansible will issue a warning when there are no hosts in the inventory.These warnings can be silenced by adjusting this setting to False.
See also LOCALHOST_WARNING
ANSIBLE_LOG_VERBOSITY
This will set log verbosity if higher than the normal display verbosity, otherwise it will match that.
See also LOG_VERBOSITY
ANSIBLE_INVENTORY_UNPARSED_WARNING
By default, Ansible will issue a warning when no inventory was loaded and notes that it will use an implicit localhost-only inventory.These warnings can be silenced by adjusting this setting to False.
See also INVENTORY_UNPARSED_WARNING
ANSIBLE_DOC_FRAGMENT_PLUGINS
Colon-separated paths in which Ansible will search for Documentation Fragments Plugins.
See also DOC_FRAGMENT_PLUGIN_PATH
ANSIBLE_ACTION_PLUGINS
Colon-separated paths in which Ansible will search for Action Plugins.
See also DEFAULT_ACTION_PLUGIN_PATH
ANSIBLE_ASK_PASS
This controls whether an Ansible playbook should prompt for a login password. If using SSH keys for authentication, you probably do not need to change this setting.
See also DEFAULT_ASK_PASS
ANSIBLE_ASK_VAULT_PASS
This controls whether an Ansible playbook should prompt for a vault password.
See also DEFAULT_ASK_VAULT_PASS
ANSIBLE_BECOME
Toggles the use of privilege escalation, allowing you to ‘become’ another user after login.
See also DEFAULT_BECOME
ANSIBLE_BECOME_ASK_PASS
Toggle to prompt for privilege escalation password.
See also DEFAULT_BECOME_ASK_PASS
ANSIBLE_BECOME_METHOD
Privilege escalation method to use when become is enabled.
See also DEFAULT_BECOME_METHOD
ANSIBLE_BECOME_EXE
executable to use for privilege escalation, otherwise Ansible will depend on PATH.
See also DEFAULT_BECOME_EXE
ANSIBLE_BECOME_FLAGS
Flags to pass to the privilege escalation executable.
See also DEFAULT_BECOME_FLAGS
ANSIBLE_BECOME_PLUGINS
Colon-separated paths in which Ansible will search for Become Plugins.
See also BECOME_PLUGIN_PATH
ANSIBLE_BECOME_USER
The user your login/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified.
See also DEFAULT_BECOME_USER
ANSIBLE_CACHE_PLUGINS
Colon-separated paths in which Ansible will search for Cache Plugins.
See also DEFAULT_CACHE_PLUGIN_PATH
ANSIBLE_CALLBACK_PLUGINS
Colon-separated paths in which Ansible will search for Callback Plugins.
See also DEFAULT_CALLBACK_PLUGIN_PATH
ANSIBLE_CALLBACKS_ENABLED
List of enabled callbacks, not all callbacks need enabling, but many of those shipped with Ansible do as we don’t want them activated by default.
See also CALLBACKS_ENABLED
Version Added:
2.11
ANSIBLE_CLICONF_PLUGINS
Colon-separated paths in which Ansible will search for Cliconf Plugins.
See also DEFAULT_CLICONF_PLUGIN_PATH
ANSIBLE_CONNECTION_PLUGINS
Colon-separated paths in which Ansible will search for Connection Plugins.
See also DEFAULT_CONNECTION_PLUGIN_PATH
ANSIBLE_DEBUG
Toggles debug output in Ansible. This is very verbose and can hinder multiprocessing. Debug output can also include secret information despite no_log settings being enabled, which means debug mode should not be used in production.
See also DEFAULT_DEBUG
ANSIBLE_EXECUTABLE
This indicates the command to use to spawn a shell under, which is required for Ansible’s execution needs on a target. Users may need to change this in rare instances when shell usage is constrained, but in most cases, it may be left as is.
See also DEFAULT_EXECUTABLE
ANSIBLE_FILTER_PLUGINS
Colon-separated paths in which Ansible will search for Jinja2 Filter Plugins.
See also DEFAULT_FILTER_PLUGIN_PATH
ANSIBLE_FORCE_HANDLERS
This option controls if notified handlers run on a host even if a failure occurs on that host.When false, the handlers will not run if a failure has occurred on a host.This can also be set per play or on the command line. See Handlers and Failure for more details.
See also DEFAULT_FORCE_HANDLERS
ANSIBLE_FORKS
Maximum number of forks Ansible will use to execute tasks on target hosts.
See also DEFAULT_FORKS
ANSIBLE_GATHERING
This setting controls the default policy of fact gathering (facts discovered about remote systems).This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the cache plugin.
See also DEFAULT_GATHERING
ANSIBLE_HASH_BEHAVIOUR
This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible.This does not affect variables whose values are scalars (integers, strings) or arrays.WARNING, changing this setting is not recommended as this is fragile and makes your content (plays, roles, collections) nonportable, leading to continual confusion and misuse. Don’t change this setting unless you think you have an absolute need for it.We recommend avoiding reusing variable names and relying on the combine filter and vars and varnames lookups to create merged versions of the individual variables. In our experience, this is rarely needed and is a sign that too much complexity has been introduced into the data structures and plays.For some uses you can also look into custom vars_plugins to merge on input, even substituting the default host_group_vars that is in charge of parsing the host_vars/ and group_vars/ directories. Most users of this setting are only interested in inventory scope, but the setting itself affects all sources and makes debugging even harder.All playbooks and roles in the official examples repos assume the default for this setting.Changing the setting to merge applies across variable sources, but many sources will internally still overwrite the variables. For example include_vars will dedupe variables internally before updating Ansible, with ‘last defined’ overwriting previous definitions in same file.The Ansible project recommends you avoid merge for new projects.**It is the intention of the Ansible developers to eventually deprecate and remove this setting, but it is being kept as some users do heavily rely on it. New projects should **avoid ‘merge’.
See also DEFAULT_HASH_BEHAVIOUR
ANSIBLE_INVENTORY
Comma-separated list of Ansible inventory sources
See also DEFAULT_HOST_LIST
ANSIBLE_HTTPAPI_PLUGINS
Colon-separated paths in which Ansible will search for HttpApi Plugins.
See also DEFAULT_HTTPAPI_PLUGIN_PATH
ANSIBLE_INVENTORY_PLUGINS
Colon-separated paths in which Ansible will search for Inventory Plugins.
See also DEFAULT_INVENTORY_PLUGIN_PATH
ANSIBLE_JINJA2_EXTENSIONS
This is a developer-specific feature that allows enabling additional Jinja2 extensions.See the Jinja2 documentation for details. If you do not know what these do, you probably don’t need to change this setting :)
See also DEFAULT_JINJA2_EXTENSIONS
ANSIBLE_JINJA2_NATIVE
This option preserves variable types during template operations.
See also DEFAULT_JINJA2_NATIVE
ANSIBLE_KEEP_REMOTE_FILES
Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.If this option is enabled it will disable ANSIBLE_PIPELINING.
See also DEFAULT_KEEP_REMOTE_FILES
ANSIBLE_LIBVIRT_LXC_NOSECLABEL
This setting causes libvirt to connect to LXC containers by passing --noseclabel parameter to virsh command. This is necessary when running on systems which do not have SELinux.
See also DEFAULT_LIBVIRT_LXC_NOSECLABEL
ANSIBLE_LOAD_CALLBACK_PLUGINS
Controls whether callback plugins are loaded when running /usr/bin/ansible. This may be used to log activity from the command line, send notifications, and so on. Callback plugins are always loaded for ansible-playbook.
See also DEFAULT_LOAD_CALLBACK_PLUGINS
ANSIBLE_LOCAL_TEMP
Temporary directory for Ansible to use on the controller.
See also DEFAULT_LOCAL_TMP
ANSIBLE_LOG_PATH
File to which Ansible will log on the controller.When not set the logging is disabled.
See also DEFAULT_LOG_PATH
ANSIBLE_LOG_FILTER
List of logger names to filter out of the log file.
See also DEFAULT_LOG_FILTER
ANSIBLE_LOOKUP_PLUGINS
Colon-separated paths in which Ansible will search for Lookup Plugins.
See also DEFAULT_LOOKUP_PLUGIN_PATH
ANSIBLE_MODULE_ARGS
This sets the default arguments to pass to the ansible adhoc binary if no -a is specified.
See also DEFAULT_MODULE_ARGS
ANSIBLE_LIBRARY
Colon-separated paths in which Ansible will search for Modules.
See also DEFAULT_MODULE_PATH
ANSIBLE_MODULE_UTILS
Colon-separated paths in which Ansible will search for Module utils files, which are shared by modules.
See also DEFAULT_MODULE_UTILS_PATH
ANSIBLE_NETCONF_PLUGINS
Colon-separated paths in which Ansible will search for Netconf Plugins.
See also DEFAULT_NETCONF_PLUGIN_PATH
ANSIBLE_NO_LOG
Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures.
See also DEFAULT_NO_LOG
ANSIBLE_NO_TARGET_SYSLOG
Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts, this will disable a newer style PowerShell modules from writing to the event log.
See also DEFAULT_NO_TARGET_SYSLOG
ANSIBLE_NULL_REPRESENTATION
What templating should return as a ‘null’ value. When not set it will let Jinja2 decide.
See also DEFAULT_NULL_REPRESENTATION
ANSIBLE_POLL_INTERVAL
For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how often to check back on the status of those tasks when an explicit poll interval is not supplied. The default is a reasonably moderate 15 seconds which is a tradeoff between checking in frequently and providing a quick turnaround when something may have completed.
See also DEFAULT_POLL_INTERVAL
ANSIBLE_PRIVATE_KEY_FILE
Option for connections using a certificate or key file to authenticate, rather than an agent or passwords, you can set the default value here to avoid re-specifying --private-key with every invocation.
See also DEFAULT_PRIVATE_KEY_FILE
ANSIBLE_PRIVATE_ROLE_VARS
By default, imported roles publish their variables to the play and other roles, this setting can avoid that.This was introduced as a way to reset role variables to default values if a role is used more than once in a playbook.Starting in version ‘2.17’ M(ansible.builtin.include_roles) and M(ansible.builtin.import_roles) can individually override this via the C(public) parameter.Included roles only make their variables public at execution, unlike imported roles which happen at playbook compile time.
See also DEFAULT_PRIVATE_ROLE_VARS
ANSIBLE_REMOTE_PORT
Port to use in remote connections, when blank it will use the connection plugin default.
See also DEFAULT_REMOTE_PORT
ANSIBLE_REMOTE_USER
Sets the login user for the target machinesWhen blank it uses the connection plugin’s default, normally the user currently executing Ansible.
See also DEFAULT_REMOTE_USER
ANSIBLE_ROLES_PATH
Colon-separated paths in which Ansible will search for Roles.
See also DEFAULT_ROLES_PATH
ANSIBLE_SELINUX_SPECIAL_FS
Some filesystems do not support safe operations and/or return inconsistent errors, this setting makes Ansible ‘tolerate’ those in the list without causing fatal errors.Data corruption may occur and writes are not always verified when a filesystem is in the list.
See also DEFAULT_SELINUX_SPECIAL_FS
Version Added:
2.9
ANSIBLE_STDOUT_CALLBACK
Set the main callback used to display Ansible output. You can only have one at a time.You can have many other callbacks, but just one can be in charge of stdout.See Callback plugins for a list of available options.
See also DEFAULT_STDOUT_CALLBACK
ANSIBLE_EDITOR
for the cases in which Ansible needs to return a file within an editor, this chooses the application to use.
See also EDITOR
Version Added:
2.15
EDITOR
for the cases in which Ansible needs to return a file within an editor, this chooses the application to use.
See also EDITOR
ANSIBLE_ENABLE_TASK_DEBUGGER
Whether or not to enable the task debugger, this previously was done as a strategy plugin.Now all strategy plugins can inherit this behavior. The debugger defaults to activating whena task is failed on unreachable. Use the debugger keyword for more flexibility.
See also ENABLE_TASK_DEBUGGER
ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS
This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True is specified.True specifies that the debugger will honor ignore_errors, and False will not honor ignore_errors.
See also TASK_DEBUGGER_IGNORE_ERRORS
ANSIBLE_STRATEGY
Set the default strategy used for plays.
See also DEFAULT_STRATEGY
ANSIBLE_STRATEGY_PLUGINS
Colon-separated paths in which Ansible will search for Strategy Plugins.
See also DEFAULT_STRATEGY_PLUGIN_PATH
ANSIBLE_SU
Toggle the use of “su” for tasks.
See also DEFAULT_SU
ANSIBLE_SYSLOG_FACILITY
Syslog facility to use when Ansible logs to the remote target.
See also DEFAULT_SYSLOG_FACILITY
ANSIBLE_TERMINAL_PLUGINS
Colon-separated paths in which Ansible will search for Terminal Plugins.
See also DEFAULT_TERMINAL_PLUGIN_PATH
ANSIBLE_TEST_PLUGINS
Colon-separated paths in which Ansible will search for Jinja2 Test Plugins.
See also DEFAULT_TEST_PLUGIN_PATH
ANSIBLE_TIMEOUT
This is the default timeout for connection plugins to use.
See also DEFAULT_TIMEOUT
ANSIBLE_TRANSPORT
Can be any connection plugin available to your ansible installation.
See also DEFAULT_TRANSPORT
ANSIBLE_ERROR_ON_UNDEFINED_VARS
When True, this causes ansible templating to fail steps that reference variable names that are likely typoed.Otherwise, any ‘{{ template_expression }}’ that contains undefined variables will be rendered in a template or ansible action line exactly as written.
See also DEFAULT_UNDEFINED_VAR_BEHAVIOR
ANSIBLE_VARS_PLUGINS
Colon-separated paths in which Ansible will search for Vars Plugins.
See also DEFAULT_VARS_PLUGIN_PATH
ANSIBLE_VAULT_ID_MATCH
If true, decrypting vaults with a vault id will only try the password from the matching vault-id.
See also DEFAULT_VAULT_ID_MATCH
ANSIBLE_VAULT_IDENTITY
The label to use for the default vault id label in cases where a vault id label is not provided.
See also DEFAULT_VAULT_IDENTITY
ANSIBLE_VAULT_ENCRYPT_SALT
The salt to use for the vault encryption. If it is not provided, a random salt will be used.
See also VAULT_ENCRYPT_SALT
ANSIBLE_VAULT_ENCRYPT_IDENTITY
The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The --encrypt-vault-id CLI option overrides the configured value.
See also DEFAULT_VAULT_ENCRYPT_IDENTITY
ANSIBLE_VAULT_IDENTITY_LIST
A list of vault-ids to use by default. Equivalent to multiple --vault-id args. Vault-ids are tried in order.
See also DEFAULT_VAULT_IDENTITY_LIST
ANSIBLE_VAULT_PASSWORD_FILE
The vault password file to use. Equivalent to --vault-password-file or --vault-id.If executable, it will be run and the resulting stdout will be used as the password.
See also DEFAULT_VAULT_PASSWORD_FILE
ANSIBLE_VERBOSITY
Sets the default verbosity, equivalent to the number of -v passed in the command line.
See also DEFAULT_VERBOSITY
ANSIBLE_DEPRECATION_WARNINGS
Toggle to control the showing of deprecation warnings
See also DEPRECATION_WARNINGS
ANSIBLE_DEVEL_WARNING
Toggle to control showing warnings related to running devel.
See also DEVEL_WARNING
ANSIBLE_DIFF_ALWAYS
Configuration toggle to tell modules to show differences when in ‘changed’ status, equivalent to --diff.
See also DIFF_ALWAYS
ANSIBLE_DIFF_CONTEXT
Number of lines of context to show when displaying the differences between files.
See also DIFF_CONTEXT
ANSIBLE_DISPLAY_ARGS_TO_STDOUT
Normally ansible-playbook will print a header for each task that is run. These headers will contain the name: field from the task if you specified one. If you didn’t then ansible-playbook uses the task’s action to help you tell which task is presently running. Sometimes you run many of the same action and so you want more information about the task to differentiate it from others of the same action. If you set this variable to True in the config then ansible-playbook will also include the task’s arguments in the header.This setting defaults to False because there is a chance that you have sensitive values in your parameters and you do not want those to be printed.If you set this to True you should be sure that you have secured your environment’s stdout (no one can shoulder surf your screen and you aren’t saving stdout to an insecure file) or made sure that all of your playbooks explicitly added the no_log:True parameter to tasks that have sensitive values How do I keep secret data in my playbook? for more information.
See also DISPLAY_ARGS_TO_STDOUT
ANSIBLE_DISPLAY_SKIPPED_HOSTS
Toggle to control displaying skipped task/host entries in a task in the default callback.
See also DISPLAY_SKIPPED_HOSTS
ANSIBLE_DISPLAY_TRACEBACK
When to include tracebacks in extended error messages
See also DISPLAY_TRACEBACK
ANSIBLE_DUPLICATE_YAML_DICT_KEY
By default, Ansible will issue a warning when a duplicate dict key is encountered in YAML.These warnings can be silenced by adjusting this setting to False.
See also DUPLICATE_YAML_DICT_KEY
ANSIBLE_ERROR_ON_MISSING_HANDLER
Toggle to allow missing handlers to become a warning instead of an error when notifying.
See also ERROR_ON_MISSING_HANDLER
ANSIBLE_FACTS_MODULES
Which modules to run during a play’s fact gathering stage, using the default of ‘smart’ will try to figure it out based on connection type.If adding your own modules but you still want to use the default Ansible facts, you will want to include ‘setup’ or corresponding network module to the list (if you add ‘smart’, Ansible will also figure it out).This does not affect explicit calls to the ‘setup’ module, but does always affect the ‘gather_facts’ action (implicit or explicit).
See also FACTS_MODULES
ANSIBLE_GALAXY_IGNORE
If set to yes, ansible-galaxy will not validate TLS certificates. This can be useful for testing against a server with a self-signed certificate.
See also GALAXY_IGNORE_CERTS
ANSIBLE_GALAXY_SERVER_TIMEOUT
The default timeout for Galaxy API calls. Galaxy servers that don’t configure a specific timeout will fall back to this value.
See also GALAXY_SERVER_TIMEOUT
ANSIBLE_GALAXY_ROLE_SKELETON
Role skeleton directory to use as a template for the init action in ansible-galaxy/ansible-galaxyrole, same as --role-skeleton.
See also GALAXY_ROLE_SKELETON
ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE
patterns of files to ignore inside a Galaxy role or collection skeleton directory.
See also GALAXY_ROLE_SKELETON_IGNORE
ANSIBLE_GALAXY_COLLECTION_SKELETON
Collection skeleton directory to use as a template for the init action in ansible-galaxycollection, same as --collection-skeleton.
See also GALAXY_COLLECTION_SKELETON
ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE
patterns of files to ignore inside a Galaxy collection skeleton directory.
See also GALAXY_COLLECTION_SKELETON_IGNORE
ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING
whether ansible-galaxycollectioninstall should warn about --collections-path missing from configured COLLECTIONS_PATHS.
See also GALAXY_COLLECTIONS_PATH_WARNING
ANSIBLE_GALAXY_SERVER
URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source.
See also GALAXY_SERVER
ANSIBLE_GALAXY_SERVER_LIST
A list of Galaxy servers to use when installing a collection.The value corresponds to the config ini header [galaxy_server.{{item}}] which defines the server details.See Configuring the ansible-galaxy client for more details on how to define a Galaxy server.The order of servers in this list is used as the order in which a collection is resolved.Setting this config option will ignore the GALAXY_SERVER config option.
See also GALAXY_SERVER_LIST
ANSIBLE_GALAXY_TOKEN_PATH
Local path to galaxy access token file
See also GALAXY_TOKEN_PATH
ANSIBLE_GALAXY_DISPLAY_PROGRESS
Some steps in ansible-galaxy display a progress wheel which can cause issues on certain displays or when outputting the stdout to a file.This config option controls whether the display wheel is shown or not.The default is to show the display wheel if stdout has a tty.
See also GALAXY_DISPLAY_PROGRESS
ANSIBLE_GALAXY_CACHE_DIR
The directory that stores cached responses from a Galaxy server.This is only used by the ansible-galaxycollectioninstall and download commands.Cache files inside this dir will be ignored if they are world writable.
See also GALAXY_CACHE_DIR
ANSIBLE_GALAXY_DISABLE_GPG_VERIFY
Disable GPG signature verification during collection installation.
See also GALAXY_DISABLE_GPG_VERIFY
ANSIBLE_GALAXY_GPG_KEYRING
Configure the keyring used for GPG signature verification during collection installation and verification.
See also GALAXY_GPG_KEYRING
ANSIBLE_GALAXY_IGNORE_SIGNATURE_STATUS_CODES
A list of GPG status codes to ignore during GPG signature verification. See L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes) for status code descriptions.If fewer signatures successfully verify the collection than GALAXY_REQUIRED_VALID_SIGNATURE_COUNT, signature verification will fail even if all error codes are ignored.
See also GALAXY_IGNORE_INVALID_SIGNATURE_STATUS_CODES
ANSIBLE_GALAXY_REQUIRED_VALID_SIGNATURE_COUNT
The number of signatures that must be successful during GPG signature verification while installing or verifying collections.This should be a positive integer or all to indicate all signatures must successfully validate the collection.Prepend + to the value to fail if no valid signatures are found for the collection.
See also GALAXY_REQUIRED_VALID_SIGNATURE_COUNT
ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_INTERVAL
The initial interval in seconds for polling the import status of a collection.This interval increases exponentially based on the GALAXY_COLLECTION_IMPORT_POLL_FACTOR, with a maximum delay of 30 seconds.
See also GALAXY_COLLECTION_IMPORT_POLL_INTERVAL
ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_FACTOR
The multiplier used to increase the GALAXY_COLLECTION_IMPORT_POLL_INTERVAL when checking the collection import status.
See also GALAXY_COLLECTION_IMPORT_POLL_FACTOR
ANSIBLE_HOST_KEY_CHECKING
Set this to “False” if you want to avoid host key checking by the underlying connection plugin Ansible uses to connect to the host.Please read the documentation of the specific connection plugin used for details.
See also HOST_KEY_CHECKING
ANSIBLE_HOST_PATTERN_MISMATCH
This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it.
See also HOST_PATTERN_MISMATCH
ANSIBLE_INJECT_INVOCATION
When enabled, an invocation key will be added to the task result with the module/action arguments used. Most callback plugins mask the invocation key from task result display by default.
See also INJECT_INVOCATION
ANSIBLE_PYTHON_INTERPRETER
Path to the Python interpreter to be used for module execution on remote targets, or an automatic discovery mode. Supported discovery modes are auto (the default), and auto_silent. All discovery modes match against an ordered list of well-known Python interpreter locations. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters installed later may change which one is used). This warning behavior can be disabled by setting auto_silent. The auto_legacy* modes are removed. They exist for backward-compatibility with older Ansible releases that always defaulted to /usr/bin/python3, which will use that interpreter if present.
See also INTERPRETER_PYTHON
ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS
Make ansible transform invalid characters in group names supplied by inventory sources.
See also TRANSFORM_INVALID_GROUP_CHARS
ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED
If ‘false’, invalid attributes for a task will result in warnings instead of errors.
See also INVALID_TASK_ATTRIBUTE_FAILED
ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED
If ‘true’, it is a fatal error when any given inventory source cannot be successfully parsed by any available inventory plugin; otherwise, this situation only attracts a warning.
See also INVENTORY_ANY_UNPARSED_IS_FAILED
ANSIBLE_INVENTORY_ENABLED
List of enabled inventory plugins, it also determines the order in which they are used.
See also INVENTORY_ENABLED
ANSIBLE_INVENTORY_EXPORT
Controls if ansible-inventory will accurately reflect Ansible’s view into inventory or its optimized for exporting.
See also INVENTORY_EXPORT
ANSIBLE_INVENTORY_IGNORE
List of extensions to ignore when using a directory as an inventory source.
See also INVENTORY_IGNORE_EXTS
ANSIBLE_INVENTORY_IGNORE_REGEX
List of patterns to ignore when using a directory as an inventory source.
See also INVENTORY_IGNORE_PATTERNS
ANSIBLE_INVENTORY_UNPARSED_FAILED
If ‘true’ it is a fatal error if every single potential inventory source fails to parse, otherwise, this situation will only attract a warning.
See also INVENTORY_UNPARSED_IS_FAILED
ANSIBLE_MAX_DIFF_SIZE
Maximum size of files to be considered for diff display.
See also MAX_FILE_SIZE_FOR_DIFF
ANSIBLE_NETWORK_GROUP_MODULES
See also NETWORK_GROUP_MODULES
ANSIBLE_INJECT_FACT_VARS
Facts are available inside the ansible_facts variable, this setting also pushes them as their own vars in the main namespace.Unlike inside the ansible_facts dictionary where the prefix ansible_ is removed from fact names, these will have the exact names that are returned by the module.
See also INJECT_FACTS_AS_VARS
ANSIBLE_MODULE_IGNORE_EXTS
List of extensions to ignore when looking for modules to load.This is for rejecting script and binary module fallback extensions.
See also MODULE_IGNORE_EXTS
ANSIBLE_MODULE_STRICT_UTF8_RESPONSE
Enables whether module responses are evaluated for containing non-UTF-8 data.Disabling this may result in unexpected behavior.Only ansible-core should evaluate this configuration.
See also MODULE_STRICT_UTF8_RESPONSE
ANSIBLE_OLD_PLUGIN_CACHE_CLEAR
Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviors in which a plugin loaded in previous plays would be unexpectedly ‘sticky’. This setting allows the user to return to that behavior.
See also OLD_PLUGIN_CACHE_CLEARING
ANSIBLE_PAGER
for the cases in which Ansible needs to return output in a pageable fashion, this chooses the application to use.
See also PAGER
Version Added:
2.15
PAGER
for the cases in which Ansible needs to return output in a pageable fashion, this chooses the application to use.
See also PAGER
ANSIBLE_PERSISTENT_CONTROL_PATH_DIR
Path to the socket to be used by the connection persistence system.
See also PERSISTENT_CONTROL_PATH_DIR
ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
This controls how long the persistent connection will remain idle before it is destroyed.
See also PERSISTENT_CONNECT_TIMEOUT
ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT
This controls the retry timeout for persistent connection to connect to the local domain socket.
See also PERSISTENT_CONNECT_RETRY_TIMEOUT
ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
This controls the amount of time to wait for a response from a remote device before timing out a persistent connection.
See also PERSISTENT_COMMAND_TIMEOUT
ANSIBLE_PLAYBOOK_DIR
A number of non-playbook CLIs have a --playbook-dir argument; this sets the default value for it.
See also PLAYBOOK_DIR
ANSIBLE_PLAYBOOK_VARS_ROOT
This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars.
See also PLAYBOOK_VARS_ROOT
ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE
Attempts to set RLIMIT_NOFILE soft limit to the specified value when executing Python modules (can speed up subprocess usage on Python 2.x. See https://bugs.python.org/issue11284). The value will be limited by the existing hard limit. Default value of 0 does not attempt to adjust existing system-defined limits.
See also PYTHON_MODULE_RLIMIT_NOFILE
ANSIBLE_RETRY_FILES_ENABLED
This controls whether a failed Ansible playbook should create a .retry file.
See also RETRY_FILES_ENABLED
ANSIBLE_RETRY_FILES_SAVE_PATH
This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.This file will be overwritten after each run with the list of failed hosts from all plays.
See also RETRY_FILES_SAVE_PATH
ANSIBLE_RUN_VARS_PLUGINS
This setting can be used to optimize vars_plugin usage depending on the user’s inventory size and play selection.
See also RUN_VARS_PLUGINS
ANSIBLE_SHOW_CUSTOM_STATS
This adds the custom stats set via the set_stats plugin to the default output.
See also SHOW_CUSTOM_STATS
ANSIBLE_SSH_AGENT
Manage an SSH Agent via Ansible. A configuration of none will not interact with an agent, auto will start and destroy an agent via ssh-agent binary during the run, and a path to an SSH_AUTH_SOCK will allow interaction with a pre-existing agent.
See also SSH_AGENT
ANSIBLE_SSH_AGENT_EXECUTABLE
When SSH_AGENT is auto, the path or name of the ssh agent executable to start.
See also SSH_AGENT_EXECUTABLE
ANSIBLE_SSH_AGENT_KEY_LIFETIME
For keys inserted into an agent defined by SSH_AGENT, define a lifetime, in seconds, that the key may remain in the agent.
See also SSH_AGENT_KEY_LIFETIME
ANSIBLE_STRING_TYPE_FILTERS
This list of filters avoids ‘type conversion’ when templating variables.Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.
See also STRING_TYPE_FILTERS
ANSIBLE_SYSTEM_WARNINGS
Allows disabling of warnings related to potential issues on the system running Ansible itself (not on the managed hosts).These may include warnings about third-party packages or other conditions that should be resolved if possible.
See also SYSTEM_WARNINGS
ANSIBLE_RUN_TAGS
default list of tags to run in your plays, Skip Tags has precedence.
See also TAGS_RUN
ANSIBLE_SKIP_TAGS
default list of tags to skip in your plays, has precedence over Run Tags
See also TAGS_SKIP
ANSIBLE_TARGET_LOG_INFO
A string to insert into target logging for tracking purposes
See also TARGET_LOG_INFO
ANSIBLE_TASK_TIMEOUT
Set the maximum time (in seconds) for a task action to execute in.Timeout runs independently from templating or looping. It applies per each attempt of executing the task’s action and remains unchanged by the total time spent on a task.When the action execution exceeds the timeout, Ansible interrupts the process. This is registered as a failure due to outside circumstances, not a task failure, to receive appropriate response and recovery process.If set to 0 (the default) there is no timeout.
See also TASK_TIMEOUT
ANSIBLE_WORKER_SESSION_ISOLATION
Ansible forked workers run session-isolated by default to avoid contention on shared TTYs.If access to the inherited parent TTY is required, set this option to false to disable session isolation.Disabling session isolation should be limited to the smallest possible scope by setting the ansible_worker_session_isolation variable on individual tasks, blocks, plays, roles, or hosts as needed.
See also WORKER_SESSION_ISOLATION
ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT
The maximum number of times to check Task Queue Manager worker processes to verify they have exited cleanly.After this limit is reached any worker processes still running will be terminated.This is for internal use only.
See also WORKER_SHUTDOWN_POLL_COUNT
ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY
The number of seconds to sleep between polling loops when checking Task Queue Manager worker processes to verify they have exited cleanly.This is for internal use only.
See also WORKER_SHUTDOWN_POLL_DELAY
ANSIBLE_USE_PERSISTENT_CONNECTIONS
Toggles the use of persistence for connections.
See also USE_PERSISTENT_CONNECTIONS
ANSIBLE_VARS_ENABLED
Accept list for variable plugins that require it.
See also VARIABLE_PLUGINS_ENABLED
ANSIBLE_PRECEDENCE
Allows to change the group variable precedence merge order.
See also VARIABLE_PRECEDENCE
ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT
For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how long, in seconds, to wait for the task spawned by Ansible to connect back to the named pipe used on Windows systems. The default is 5 seconds. This can be too low on slower systems, or systems under heavy load.This is not the total time an async command can run for, but is a separate timeout to wait for an async command to start. The task will only start to be timed against its async_timeout once it has connected to the pipe, so the overall maximum duration the task can take will be extended by the amount specified here.
See also WIN_ASYNC_STARTUP_TIMEOUT
ANSIBLE_YAML_FILENAME_EXT
Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these.This affects vars_files, include_vars, inventory and vars plugins among others.
See also YAML_FILENAME_EXTENSIONS
ANSIBLE_NETCONF_SSH_CONFIG
This variable is used to enable bastion/jump host with netconf connection. If set to True the bastion/jump host ssh settings should be present in ~/.ssh/config file, alternatively it can be set to custom ssh configuration file path to read the bastion/jump host settings.
See also NETCONF_SSH_CONFIG
ANSIBLE_VALIDATE_ACTION_GROUP_METADATA
A toggle to disable validating a collection’s ‘metadata’ entry for a module_defaults action group. Metadata containing unexpected fields or value types will produce a warning when this is True.
See also VALIDATE_ACTION_GROUP_METADATA
ANSIBLE_VERBOSE_TO_STDERR
Force ‘verbose’ option to use stderr instead of stdout
See also VERBOSE_TO_STDERR PreviousNext