\u8fd9\u662f\u300aAnsible Advent Calendar 2017\u300b\u7684\u7b2c10\u7bc7\u6587\u7ae0\u3002
\n\u8fd9\u662f\u4e00\u4e2a\u6709\u8da3\u7684\u8bdd\u9898\u3002<\/p>\n
\u6211\u8ba4\u4e3a\u5f88\u591a\u4eba\u90fd\u77e5\u9053\u5728Ansible\u4efb\u52a1\u8f93\u51fa\u4e2d\u53ef\u4ee5\u4f7f\u7528cowsay\u3002<\/p>\n
<\/p>\n
__________________ \r\n< PLAY [localhost] >\r\n------------------ \r\n \\ ^__^\r\n \\ (oo)\\_______\r\n (__)\\ )\\\/\\\r\n ||----w |\r\n || ||\r\n\r\n_________________________ \r\n< TASK [Gathering Facts] >\r\n------------------------- \r\n \\ ^__^\r\n \\ (oo)\\_______\r\n (__)\\ )\\\/\\\r\n ||----w |\r\n || ||\r\n\r\n<\/code><\/pre>\n\u5982\u679c\u4f60\u5b89\u88c5\u4e86cowsay\uff0c\u6ca1\u6709\u505a\u4efb\u4f55\u7279\u6b8a\u7684\u8bbe\u7f6e\uff0c\u90a3\u4e48Ansible\u7684\u6d88\u606f\u5c31\u4f1a\u88abcowsay\u8f6c\u5316\uff0c\u800c\u90a3\u4e9b\u4e0d\u77e5\u9053\u5982\u4f55\u4f7f\u7528cowsay\u7684\u4eba\u53ef\u80fd\u4f1a\u9677\u5165\u6050\u614c\u4e4b\u4e2d\u3002\u987a\u4fbf\u63d0\u4e00\u4e0b\uff0c\u8fd9\u662f\u4e24\u5e74\u524d\u7684\u6211\u3002<\/p>\n
\u5bf9\u4e8e\u90a3\u4e2aAnsible\u7684cowsay\u8f93\u51fa\uff0c\u6211\u51b3\u5b9a\u5c1d\u8bd5\u4f7f\u7528\u4e0ecowsay\u76f8\u4f3c\u7684\u6709\u8da3\u547d\u4ee4echo-sd\u6765\u8f93\u51fa\u3002<\/p>\n
\u987a\u4fbf\u8bf4\u4e00\u4e0b\uff0c\u5728\u8fd9\u7bc7\u6587\u7ae0\u4e2d\u6240\u4ecb\u7ecd\u7684\u65b9\u6cd5\u662f\u76f4\u63a5\u4fee\u6539\u6838\u5fc3\u6e90\u4ee3\u7801\uff0c\u4e5f\u5c31\u662f\u6240\u8c13\u7684\u201c\u8111\u888b\u808c\u8089\u73a9\u6cd5\u201d\u3002\u6309\u7167 Ansible \u7684\u8bbe\u8ba1\uff0c\u672c\u5e94\u91c7\u7528\u7c7b\u4f3c\u4e0b\u9762\u8fd9\u7bc7\u6587\u7ae0\u4e2d\u6240\u4ecb\u7ecd\u7684 Callback \u63d2\u4ef6\u673a\u5236\u6765\u5b9e\u73b0\u3002<\/p>\n
Ansible\u306ecallback plugin\u3092\u4f7f\u3063\u3066\u7a81\u7136\u306e\u6b7b(echo-sd)\u3092\u8868\u73fe\u3059\u308b<\/ul>\n\u5728\u54ea\u91cc\u6539\u52a8<\/h1>\n
\u6211\u60f3\u505a\u7684\u662f\u201c\u53d1\u73b0Ansible\u6b63\u5728cowsay\u7684\u5730\u65b9\uff0c\u5e76\u5c06\u5176\u66ff\u6362\u4e3aecho-sd\u201d\u3002
\n\u56e0\u6b64\uff0c\u6211\u4f1a\u67e5\u770bAnsible\u4ee3\u7801\uff0c\u627e\u5230\u5b83\u4e0ecowsay\u7684\u8fde\u63a5\u70b9\u3002
\n\u7531\u4e8e\u662f\u5f00\u6e90\u7684\uff0c\u6240\u4ee5\u53ef\u4ee5\u81ea\u7531\u5730\u67e5\u770b\u548c\u4fee\u6539\u6e90\u4ee3\u7801\uff0c\u592a\u68d2\u4e86\u3002<\/p>\n
ansible\/ansible – GitHub<\/p>\n
\u5b89\u88c5\u624b\u518c\u548c\u6587\u6863\u4ee5\u53ca ansible \u7684\u5176\u5b83\u4fe1\u606f\u7684\u6e90\u5934\u3002<\/p>\n
\u9996\u5148\uff0c\u8ba9\u6211\u4eec\u5728\u4ee3\u7801\u5e93\u4e2d\u8bda\u5b9e\u5730\u4f7f\u7528\u201ccowsay\u201d\u8fdb\u884c\u641c\u7d22\u3002<\/p>\n
\u641c\u7d22- cowsay<\/p>\n
\u67094\u4e2a\u6587\u4ef6\u88ab\u547d\u4e2d\u3002<\/p>\n
\n- \n
lib\/ansible\/utils\/display.py<\/ul>\n<\/li>\n<\/ul>\n <\/p>\n
\n- \n
docs\/docsite\/rst\/faq.rst<\/ul>\n<\/li>\n<\/ul>\n <\/p>\n
\n- \n
examples\/ansible.cfg<\/ul>\n<\/li>\n<\/ul>\n <\/p>\n
lib\/ansible\/config\/base.yml<\/ul>\n\u770b\u8d77\u6765\u4e0d\u592a\u9700\u8981\u53bb\u770b\u4e86\u3002
\n\u5341\u6709\u516b\u4e5d\u7684\u53ef\u80fd\u662f display.py \u662f\u7f6a\u72af\u3002<\/p>\n
b_COW_PATHS<\/span> =<\/span> (<\/span>\r\n b<\/span>\"\/usr\/bin\/cowsay\"<\/span>,<\/span>\r\n b<\/span>\"\/usr\/games\/cowsay\"<\/span>,<\/span>\r\n b<\/span>\"\/usr\/local\/bin\/cowsay\"<\/span>,<\/span> # BSD path for cowsay\r\n<\/span> b<\/span>\"\/opt\/local\/bin\/cowsay\"<\/span>,<\/span> # MacPorts path for cowsay\r\n<\/span>)<\/span>\r\n<\/code><\/pre>\n\u56e0\u4e3a\u5305\u542b\u8fd9\u6837\u7684\u4e1c\u897f\uff0c\u6240\u4ee5\u770b\u8d77\u6765\u662f\u80af\u5b9a\u7684\u7f6a\u72af\u3002
\n\u4f3c\u4e4e\u5df2\u7ecf\u8003\u8651\u4e86\u4e0d\u540c\u64cd\u4f5c\u7cfb\u7edf\u5fae\u5999\u5730\u6709\u4e0d\u540c\u7684cowsay\u547d\u4ee4\u8def\u5f84\u95ee\u9898\u3002\u592a\u68d2\u4e86\u3002<\/p>\n
\u6539\u826f\u7684\u51c6\u5907\u5de5\u4f5c<\/h1>\n
\u4e3a\u4e86\u6539\u9020\uff0c\u6211\u4f1a\u83b7\u53d6\u6e90\u4ee3\u7801\u3002\u6211\u5c06\u4f7f\u7528\u6700\u65b0\u7684\u7a33\u5b9a\u7248\u672cv2.4.2.0-1\u6765\u4f5c\u4e3a\u4ee3\u7801\u57fa\u7840\u3002<\/p>\n
# Ansible\u30ea\u30dd\u30b8\u30c8\u30ea\u3092\u30af\u30ed\u30fc\u30f3\r\n$ git clone https:\/\/github.com\/ansible\/ansible.git\r\n$ cd ansible\r\n$ git checkout v2.4.2.0-1\r\n\r\n# \u5b9f\u884c\u74b0\u5883\u3092\u30bb\u30c3\u30c8\u30a2\u30c3\u30d7\r\n$ source .\/hacking\/env-setup\r\n$ ansible --version\r\nansible 2.4.2.0 (detached HEAD e3a8bf02ac) last updated 2017\/12\/10 02:06:21 (GMT +900)\r\n config file = None\r\n configured module search path = [u'\/root\/.ansible\/plugins\/modules', u'\/usr\/share\/ansible\/plugins\/modules']\r\n ansible python module location = \/opt\/ansible\/lib\/ansible\r\n executable location = \/opt\/ansible\/bin\/ansible\r\n python version = 2.7.5 (default, Nov 6 2016, 00:28:07) [GCC 4.8.5 20150623 (Red Hat 4.8.5-11)]\r\n<\/code><\/pre>\n\u8bf7\u70b9\u51fb\u6b64\u5904\u67e5\u770b\u786e\u8ba4\u6267\u884c\u7684Playbook\u3002<\/p>\n
-<\/span> hosts<\/span>:<\/span> localhost<\/span>\r\n user<\/span>:<\/span> ansible<\/span>\r\n tasks<\/span>:<\/span>\r\n -<\/span> name<\/span>:<\/span> Display message<\/span>\r\n debug<\/span>:<\/span>\r\n msg<\/span>:<\/span> \"<\/span>\u7a81\u7136\u306e\u6b7b\"<\/span>\r\n<\/code><\/pre>\n\u8fd9\u662f\u5e73\u65f6\u7684\u6d88\u606f\u3002<\/p>\n
$ ansible-playbook -i hosts echo-sd.yml\r\n\r\nPLAY [localhost] *********************************************************************************************\r\n\r\nTASK [Gathering Facts] ***************************************************************************************\r\nok: [localhost]\r\n\r\nTASK [Display message] ***************************************************************************************\r\nok: [localhost] => {\r\n \"msg\": \"\u7a81\u7136\u306e\u6b7b\"\r\n}\r\n\r\nPLAY RECAP ***************************************************************************************************\r\nlocalhost : ok=2 changed=0 unreachable=0 failed=0\r\n<\/code><\/pre>\n\u600e\u6837\u5904\u7406<\/h1>\n
\u5c3d\u7ba1\u8fd9\u5f88\u7b80\u5355\u7c97\u66b4\uff0c\u4f46\u5982\u679c\u6211\u4eec\u5c1d\u8bd5\u5c06echo-sd\u4ee3\u66ffcowsay\uff0c\u4f1a\u53d1\u751f\u4ec0\u4e48\u5462\uff1f<\/p>\n
b_COW_PATHS<\/span> =<\/span> (<\/span>\r\n b<\/span>\"\/usr\/local\/bin\/echo-sd\"<\/span>,<\/span> # echo-sd\u306e\u30d1\u30b9\r\n<\/span>)<\/span>\r\n<\/code><\/pre>\n\u5982\u679c\u80fd\u987a\u5229\u8fdb\u884c\uff0c\u5c31\u4f1a\u5927\u8d5a\u4e00\u7b14\uff0c\u5e26\u7740\u7948\u7977\u7684\u5fc3\u60c5\uff0c\u8ba9\u6211\u4eec\u5c1d\u8bd5\u4e00\u4e0b…\uff01<\/p>\n
$ ansible-playbook -i hosts echo-sd.yml\r\n\r\n\r\nok: [localhost]\r\n\r\nok: [localhost] => {\r\n \"msg\": \"echo-sd !!!\"\r\n}\r\n\r\nlocalhost : ok=2 changed=0 unreachable=0 failed=0\r\n\r\n$ echo-sd \u4f55\u3082\u51fa\u306a\u3044\r\n\uff3f\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\uff3f\r\n\uff1e\u3000\u4f55\u3082\u51fa\u306a\u3044\u3000\uff1c\r\n\uffe3Y^Y^Y^Y^Y^Y^Y^\uffe3\r\n<\/code><\/pre>\n\u55ef\uff0c\u4e8b\u60c5\u5e76\u4e0d\u4f1a\u50cf\u9884\u671f\u7684\u90a3\u6837\u987a\u5229\u8fdb\u884c\u3002\u8ba9\u6211\u4eec\u8ba4\u771f\u5730\u7ee7\u7eed\u52aa\u529b\u5427\u3002<\/p>\n
\u5b8c\u7f8e\u7248\u672c<\/h2>\n
\u6211\u4f1a\u6309\u7167\u987a\u5e8f\u9010\u6b65\u89e3\u91ca\uff0c\u6682\u65f6\u6298\u53e0\u8d77\u6765\u3002\u4e8b\u5b9e\u4e0a\uff0c\u6211\u5148\u5b8c\u6210\u4e86\u7248\u672c\uff0c\u7136\u540e\u9700\u8981\u4fee\u6539\u4e24\u4e2a\u6587\u4ef6\u3002<\/p>\nlib\/ansible\/utils\/display.py# (c) 2014, Michael DeHaan <michael.dehaan@gmail.com>
\n#
\n# \u8fd9\u4e2a\u6587\u4ef6\u662fAnsible\u7684\u4e00\u90e8\u5206
\n#
\n# Ansible\u662f\u81ea\u7531\u8f6f\u4ef6\uff1a\u60a8\u53ef\u4ee5\u6839\u636e\u81ea\u7531\u8f6f\u4ef6\u57fa\u91d1\u4f1a\u53d1\u5e03\u7684GNU\u901a\u7528\u516c\u5171\u8bb8\u53ef\u8bc1\u7684\u6761\u6b3e\u91cd\u65b0\u5206\u53d1\u6216\u4fee\u6539\u5b83
\n# \u6216\uff08\u6839\u636e\u60a8\u7684\u9009\u62e9\uff09\u4efb\u4f55\u540e\u7eed\u7248\u672c\u3002
\n#
\n# Ansible\u5e0c\u671b\u5b83\u662f\u6709\u7528\u7684\uff0c\u4f46\u6ca1\u6709\u4efb\u4f55\u62c5\u4fdd\uff1b\u751a\u81f3\u6ca1\u6709\u9002\u9500\u6027\u6216\u9002\u7528\u6027\u7684\u6697\u793a\u4fdd\u8bc1\u3002
\n# \u6709\u5173\u66f4\u591a\u8be6\u7ec6\u4fe1\u606f\uff0c\u8bf7\u53c2\u9605GNU\u901a\u7528\u516c\u5171\u8bb8\u53ef\u8bc1\u3002
\n#
\n# \u60a8\u5e94\u8be5\u6536\u5230\u4e0eAnsible\u7684GNU\u901a\u7528\u516c\u5171\u8bb8\u53ef\u8bc1\u4e00\u8d77\u7684\u526f\u672c\u3002
\n# \u5982\u679c\u6ca1\u6709\uff0c\u53c2\u9605<http:\/\/www.gnu.org\/licenses\/>\u3002<\/p>\nfrom __future__ import (absolute_import, division, print_function)
\n__metaclass__ = type<\/p>\n
import errno
\nimport fcntl
\nimport getpass
\nimport locale
\nimport logging
\nimport os
\nimport random
\nimport subprocess
\nimport sys
\nimport textwrap
\nimport time<\/p>\n
from struct import unpack, pack
\nfrom termios import TIOCGWINSZ<\/p>\n
from ansible import constants as C
\nfrom ansible.errors import AnsibleError
\nfrom ansible.module_utils._text import to_bytes, to_text
\nfrom ansible.utils.color import stringc<\/p>\n
try:
\n# Python 2
\ninput = raw_input
\nexcept NameError:
\n# Python 3, we already have raw_input
\npass<\/p>\n
logger = None
\n# TODO: make this a logging callback instead
\nif C.DEFAULT_LOG_PATH:
\npath = C.DEFAULT_LOG_PATH
\nif (os.path.exists(path) and os.access(path, os.W_OK)) or os.access(os.path.dirname(path), os.W_OK):
\nlogging.basicConfig(filename=path, level=logging.DEBUG, format=’%(asctime)s %(name)s %(message)s’)
\nmypid = str(os.getpid())
\nuser = getpass.getuser()
\nlogger = logging.getLogger(“p=%s u=%s | ” % (mypid, user))
\nelse:
\nprint(“[WARNING]: log file at %s is not writeable and we cannot create it, aborting\\n” % path, file=sys.stderr)<\/p>\n
b_ECHO_SD_PATHS = (
\nb”\/usr\/local\/bin\/echo-sd”, # echo-sd\u7684\u8def\u5f84
\n)<\/p>\n
b_ECHO_SD_STYLES = (
\nb”vertical”,
\nb”tanzaku”,
\nb”default”,
\n)<\/p>\n
class Display:<\/p>\n
def __init__(self, verbosity=0):<\/p>\n
self.columns = None
\nself.verbosity = verbosity<\/p>\n
# \u9632\u6b62\u91cd\u590d\u663e\u793a\u6240\u6709\u5f03\u7528\u6d88\u606f\u7684\u5217\u8868
\nself._deprecations = {}
\nself._warns = {}
\nself._errors = {}<\/p>\n
self.b_echo_sd = None
\nself.nonsd = C.ANSIBLE_SD_SELECTION<\/p>\n
self.set_echo_sd_info()<\/p>\n
self._set_column_width()<\/p>\n
def set_echo_sd_info(self):
\nif not C.ANSIBLE_NOSD:
\nfor b_echo_sd_path in b_ECHO_SD_PATHS:
\nif os.path.exists(b_echo_sd_path):
\nself.b_echo_sd = b_echo_sd_path<\/p>\n
def display(self, msg, color=None, stderr=False, screen_only=False, log_only=False):
\n“””\u5411\u7528\u6237\u663e\u793a\u6d88\u606f<\/p>\n
\u6ce8\u610f\uff1amsg\u5fc5\u987b\u662f\u4e00\u4e2aUnicode\u5b57\u7b26\u4e32\uff0c\u4ee5\u9632\u6b62UnicodeError traceback\u3002
\n“””<\/p>\n
nocolor = msg
\nif color:
\nmsg = stringc(msg, color)<\/p>\n
if not log_only:
\nif not msg.endswith(u’\\n’):
\nmsg2 = msg + u’\\n’
\nelse:
\nmsg2 = msg<\/p>\n
msg2 = to_bytes(msg2, encoding=self._output_encoding(stderr=stderr))
\nif sys.version_info >= (3,):
\n# \u5728python3\u4e0a\u5c06\u5176\u8f6c\u6362\u56de\u6587\u672c\u5b57\u7b26\u4e32
\n# \u6211\u4eec\u9996\u5148\u5c06\u5176\u8f6c\u6362\u4e3a\u5b57\u8282\u5b57\u7b26\u4e32\uff0c\u4ee5\u6446\u8131\u7528\u6237\u533a\u57df\u8bbe\u7f6e\u4e2d\u65e0\u6548\u7684\u5b57\u7b26
\nmsg2 = to_text(msg2, self._output_encoding(stderr=stderr), errors=’replace’)<\/p>\n
if not stderr:
\nfileobj = sys.stdout
\nelse:
\nfileobj = sys.stderr<\/p>\n
fileobj.write(msg2)<\/p>\n
try:
\nfileobj.flush()
\nexcept IOError as e:
\n# \u5ffd\u7565EPIPE\uff08\u6307\u793a\u6587\u4ef6\u5bf9\u8c61\u5df2\u8fc7\u65e9\u5173\u95ed\uff09\u7684\u9519\u8bef\uff0c\u4f8b\u5982\u7ba1\u9053\u5230\u201chead -n1\u201d
\nif e.errno != errno.EPIPE:
\nraise<\/p>\n
if logger and not screen_only:
\nmsg2 = nocolor.lstrip(u’\\n’)<\/p>\n
msg2 = to_bytes(msg2)
\nif sys.version_info >= (3,):
\n# \u5728python3\u4e0a\u5c06\u5176\u8f6c\u6362\u56de\u6587\u672c\u5b57\u7b26\u4e32
\n# \u6211\u4eec\u9996\u5148\u5c06\u5176\u8f6c\u6362\u4e3a\u5b57\u8282\u5b57\u7b26\u4e32\uff0c\u4ee5\u6446\u8131\u7528\u6237\u533a\u57df\u8bbe\u7f6e\u4e2d\u65e0\u6548\u7684\u5b57\u7b26
\nmsg2 = to_text(msg2, self._output_encoding(stderr=stderr))<\/p>\n
if color == C.COLOR_ERROR:
\nlogger.error(msg2)
\nelse:
\nlogger.info(msg2)<\/p>\n
def v(self, msg, host=None):
\nreturn self.verbose(msg, host=host, caplevel=0)<\/p>\n
def vv(self, msg, host=None):
\nreturn self.verbose(msg, host=host, caplevel=1)<\/p>\n
def vvv(self, msg, host=None):
\nreturn self.verbose(msg, host=host, caplevel=2)<\/p>\n
def vvvv(self, msg, host=None):
\nreturn self.verbose(msg, host=host, caplevel=3)<\/p>\n
def vvvvv(self, msg, host=None):
\nreturn self.verbose(msg, host=host, caplevel=4)<\/p>\n
def vvvvvv(self, msg, host=None):
\nreturn self.verbose(msg, host=host, caplevel=5)<\/p>\n
def debug(self, msg):
\nif C.DEFAULT_DEBUG:
\nself.display(“%6d %0.5f: %s” % (os.getpid(), time.time(), msg), color=C.COLOR_DEBUG)<\/p>\n
def verbose(self, msg, host=None, caplevel=2):
\nif self.verbosity > caplevel:
\nif host is None:
\nself.display(msg, color=C.COLOR_VERBOSE)
\nelse:
\nself<\/p>\n<\/details>\nlib\/ansible\/config\/base.yml# Copyright (c) 2017 Ansible Project
\n# GNU General Public License v3.0+ (see COPYING or https:\/\/www.gnu.org\/licenses\/gpl-3.0.txt)
\n—
\nACCELERATE_CONNECT_TIMEOUT:
\ndefault: 1.0
\ndescription:
\n– “This setting controls the timeout for the socket connect call, and should be kept relatively low.
\nThe connection to the accelerate_port will be attempted 3 times before Ansible will fall back to ssh or paramiko
\n(depending on your default connection setting) to try and start the accelerate daemon remotely.”
\n– “Note, this value can be set to less than one second, however it is probably not a good idea to do so
\nunless you are on a very fast and reliable LAN. If you are connecting to systems over the internet, it may be necessary to increase this timeout.”
\nenv: [{name: ACCELERATE_CONNECT_TIMEOUT }]
\nini:
\n– {key: accelerate_connect_timeout, section: accelerate}
\ntype: float
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nversion_added: “1.4”
\nACCELERATE_DAEMON_TIMEOUT:
\ndefault: 30
\ndescription:
\n– This setting controls the timeout for the accelerated daemon, as measured in minutes. The default daemon timeout is 30 minutes.
\n– “Prior to 1.6, the timeout was hard-coded from the time of the daemon’s launch.”
\n– For version 1.6+, the timeout is now based on the last activity to the daemon and is configurable via this option.
\nenv: [{name: ACCELERATE_DAEMON_TIMEOUT}]
\nini:
\n– {key: accelerate_daemon_timeout, section: accelerate}
\ntype: integer
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nversion_added: “1.6”
\nACCELERATE_KEYS_DIR:
\ndefault: ~\/.fireball.keys
\ndescription: ”
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nenv: [{name: ACCELERATE_KEYS_DIR}]
\nini:
\n– {key: accelerate_keys_dir, section: accelerate}
\nACCELERATE_KEYS_DIR_PERMS:
\ndefault: ‘700’
\ndescription: ‘TODO: write it’
\nenv: [{name: ACCELERATE_KEYS_DIR_PERMS}]
\nini:
\n– {key: accelerate_keys_dir_perms, section: accelerate}
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nACCELERATE_KEYS_FILE_PERMS:
\ndefault: ‘600’
\ndescription: ‘TODO: write it’
\nenv: [{name: ACCELERATE_KEYS_FILE_PERMS}]
\nini:
\n– {key: accelerate_keys_file_perms, section: accelerate}
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nACCELERATE_MULTI_KEY:
\ndefault: False
\ndescription: ‘TODO: write it’
\nenv: [{name: ACCELERATE_MULTI_KEY}]
\nini:
\n– {key: accelerate_multi_key, section: accelerate}
\ntype: boolean
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nACCELERATE_PORT:
\ndefault: 5099
\ndescription: ‘TODO: write it’
\nenv: [{name: ACCELERATE_PORT}]
\nini:
\n– {key: accelerate_port, section: accelerate}
\ntype: integer
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nACCELERATE_TIMEOUT:
\ndefault: 30
\ndescription: ‘TODO: write it’
\nenv: [{name: ACCELERATE_TIMEOUT}]
\nini:
\n– {key: accelerate_timeout, section: accelerate}
\ntype: integer
\ndeprecated:
\nwhy: Removing accelerate as a connection method, settings not needed either.
\nversion: “2.5”
\nalternatives: ssh and paramiko
\nALLOW_WORLD_READABLE_TMPFILES:
\nname: Allow world readable temporary files
\ndefault: False
\ndescription:
\n– This makes the temporary files created on the machine to be world readable and will issue a warning instead of failing the task.
\n– It is useful when becoming an unprivileged user.
\nenv: []
\nini:
\n– {key: allow_world_readable_tmpfiles, section: defaults}
\ntype: boolean
\nyaml: {key: defaults.allow_world_readable_tmpfiles}
\nversion_added: “2.1”
\nANSIBLE_SD_SELECTION:
\nname: echo-sd style selection
\ndefault: default
\ndescription: This allows you to chose a specific echo-sd style for the banners or use ‘random’ to cycle through them.
\nenv: [{name: ANSIBLE_SD_SELECTION}]
\nini:
\n– {key: sd_selection, section: defaults}
\nANSIBLE_FORCE_COLOR:
\nname: Force color output
\ndefault: False
\ndescription: This options forces color mode even when running without a TTY or the “nocolor” setting is True.
\nenv: [{name: ANSIBLE_FORCE_COLOR}]
\nini:
\n– {key: force_color, section: defaults}
\ntype: boolean
\nyaml: {key: display.force_color}
\nANSIBLE_NOCOLOR:
\nname: Suppress color output
\ndefault: False
\ndescription: This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.
\nenv: [{name: ANSIBLE_NOCOLOR}]
\nini:
\n– {key: nocolor, section: defaults}
\ntype: boolean
\nyaml: {key: display.nocolor}
\nANSIBLE_NOSD:
\nname: Suppress echo-sd output
\ndefault: False
\ndescription: If you have echo-sd installed but want to avoid the ‘echo-sd’ (why????), use this.
\nenv: [{name: ANSIBLE_NOSD}]
\nini:
\n– {key: nosd, section: defaults}
\ntype: boolean
\nyaml: {key: display.i_am_no_fun}
\nANSIBLE_PIPELINING:
\nname: Connection pipelining
\ndefault: False
\ndescription:
\n– Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server,
\nby executing many Ansible modules without actual file transfer.
\n– This can result in a very significant performance improvement when enabled.
\n– “However this conflicts with privilege escalation (become). For example, when using ‘sudo:’ operations you must first
\ndisable ‘requiretty’ in \/etc\/sudoers on all managed hosts, which is why it is disabled by default.”
\nenv:
\n– name: ANSIBLE_PIPELINING
\n– name: ANSIBLE_SSH_PIPELINING
\nini:
\n– section: connection
\nkey: pipelining
\n– section: ssh_connection
\nkey: pipelining
\ntype: boolean
\nyaml: {key: plugins.connection.pipelining}
\nANSIBLE_SSH_ARGS:
\n# TODO: move to ssh plugin
\ndefault: -C -o ControlMaster=auto -o ControlPersist=60s
\ndescription:
\n– If set, this will override the Ansible default ssh arguments.
\n– In particular, users may wish to raise the ControlPersist time to encourage performance. A value of 30 minutes may be appropriate.
\n– Be aware that if `-o ControlPath` is set in ssh_args, the control path setting is not used.
\nenv: [{name: ANSIBLE_SSH_ARGS}]
\nini:
\n– {key: ssh_args, section: ssh_connection}
\nyaml: {key: ssh_connection.ssh_args}
\nANSIBLE_SSH_CONTROL_PATH:
\n# TODO: move to ssh plugin
\ndefault: null
\ndescription:
\n– This is the location to save ssh’s ControlPath sockets, it uses ssh’s variable substitution.
\n– Since 2.3, if null, ansible will generate a unique hash. Use `%(directory)s` to indicate where to use the control dir path setting.
\n– Before 2.3 it defaulted to `control_path=%(directory)s\/ansible-ssh-%%h-%%p-%%r`.
\n– Be aware that this setting is ignored if `-o ControlPath` is set in ssh args.
\nenv: [{name: ANSIBLE_SSH_CONTROL_PATH}]
\nini:
\n– {key: control_path, section: ssh_connection}
\nyaml: {key: ssh_connection.control_path}
\nANSIBLE_SSH_CONTROL_PATH_DIR:
\n# TODO: move to ssh plugin
\ndefault: ~\/.ansible\/cp
\ndescription:
\n– This sets the directory to use for ssh control path if the control path setting is null.
\n– Also, provides the `%(directory)s` variable for the control path setting.
\nenv: [{name: ANSIBLE_SSH_CONTROL_PATH_DIR}]
\nini:
\n– {key: control_path_dir, section: ssh_connection}
\nyaml: {key: ssh_connection.control_path_dir}
\nANSIBLE_SSH_EXECUTABLE:
\n# TODO: move to ssh plugin
\ndefault: ssh
\ndescription:
\n– This defines the location of the ssh binary. It defaults to `ssh` which will use the first ssh binary available in $PATH.
\n– This option is usually not required, it might be useful when access to system ssh is restricted,
\nor when using ssh wrappers to connect to remote hosts.
\nenv: [{name: ANSIBLE_SSH_EXECUTABLE}]
\nini:
\n– {key: ssh_executable, section: ssh_connection}
\nyaml: {key: ssh_connection.ssh_executable}
\nversion_added: “2.2”
\nANSIBLE_SSH_RETRIES:
\n# TODO: move to ssh plugin
\ndefault: 0
\ndescription: Number of attempts to establish a connection before we give up and report the host as ‘UNREACHABLE’
\nenv: [{name: ANSIBLE_SSH_RETRIES}]
\nini:
\n– {key: retries, section: ssh_connection}
\ntype: integer
\nyaml: {key: ssh_connection.retries}
\nANY_ERRORS_FATAL:
\nname: Make Task failures fatal
\ndefault: False
\ndescription: Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors.
\nenv:
\n– name: ANSIBLE_ANY_ERRORS_FATAL
\nini:
\n– section: defaults
\nkey: any_errors_fatal
\ntype: boolean
\nyaml: {key: errors.any_task_errors_fatal}
\nversion_added: “2.4”
\nBECOME_ALLOW_SAME_USER:
\nname: Allow becomming the same user
\ndefault: False
\ndescription: This setting controls if become is skipped when remote user and become user are the same. I.E root sudo to root.
\nenv: [{name: ANSIBLE_BECOME_ALLOW_SAME_USER}]
\nini:
\n– {key: become_allow_same_user, section: privilege_escalation}
\ntype: boolean
\nyaml: {key: privilege_escalation.become_allow_same_user}
\nCACHE_PLUGIN:
\nname: Persistent Cache plugin
\ndefault: memory
\ndescription: Chooses which cache plugin to use, the default ‘memory’ is ephimeral.
\nenv: [{name: ANSIBLE_CACHE_PLUGIN}]
\nini:
\n– {key: fact_caching, section: defaults}
\nyaml: {key: facts.cache.plugin}
\nCACHE_PLUGIN_CONNECTION:
\nname: Cache Plugin URI
\ndefault: ~
\ndescription: Defines connection or path information for the cache plugin
\nenv: [{name: ANSIBLE_CACHE_PLUGIN_CONNECTION}]
\nini:
\n– {key: fact_caching_connection, section: defaults}
\nyaml: {key: facts.cache.uri}
\nCACHE_PLUGIN_PREFIX:
\nname: Cache Plugin table prefix
\ndefault: ansible_facts
\ndescription: Prefix to use for cache plugin files\/tables
\nenv: [{name: ANSIBLE_CACHE_PLUGIN_PREFIX}]
\nini:
\n– {key: fact_caching_prefix, section: defaults}
\nyaml: {key: facts.cache.prefix}
\nCACHE_PLUGIN_TIMEOUT:
\nname: Cache Plugin expiration timeout
\ndefault: 86400
\ndescription: Expiration timeout for the cache plugin data
\nenv: [{name: ANSIBLE_CACHE_PLUGIN_TIMEOUT}]
\nini:
\n– {key: fact_caching_timeout, section: defaults}
\ntype: integer
\nyaml: {key: facts.cache.timeout}
\nCOLOR_CHANGED:
\nname: Color for ‘changed’ task status
\ndefault: yellow
\ndescription: Defines the color to use on ‘Changed’ task status
\nenv: [{name: ANSIBLE_COLOR_CHANGED}]
\nini:
\n– {key: changed, section: colors}
\nyaml: {key: display.colors.changed}
\nCOLOR_DEBUG:
\nname: Color for debug statements
\ndefault: dark gray
\ndescription: Defines the color to use when emitting debug messages
\nenv: [{name: ANSIBLE_COLOR_DEBUG}]
\nini:
\n– {key: debug, section: colors}
\nyaml: {key: display.colors.debug}
\nCOLOR_DEPRECATE:
\nname: Color for deprecation messages
\ndefault: purple
\ndescription: Defines the color to use when emitting deprecation messages
\nenv: [{name: ANSIBLE_COLOR_DEPRECATE}]
\nini:
\n– {key: deprecate, section: colors}
\nyaml: {key: display.colors.deprecate}
\nCOLOR_DIFF_ADD:
\nname: Color for diff added display
\ndefault: green
\ndescription: Defines the color to use when showing added lines in diffs
\nenv: [{name: ANSIBLE_COLOR_DIFF_ADD}]
\nini:
\n– {key: diff_add, section: colors}
\nyaml: {key: display.colors.diff.add}
\nCOLOR_DIFF_LINES:
\nname: Color for diff lines display
\ndefault: cyan
\ndescription: Defines the color to use when showing diffs
\nenv: [{name: ANSIBLE_COLOR_DIFF_LINES}]
\nini:
\n– {key: diff_lines, section: colors}
\nCOLOR_DIFF_REMOVE:
\nname: Color for diff removed display
\ndefault: red
\ndescription: Defines the color to use when showing removed lines in diffs
\nenv: [{name: ANSIBLE_COLOR_DIFF_REMOVE}]
\nini:
\n– {key: diff_remove, section: colors}
\nCOLOR_ERROR:
\nname: Color for error messages
\ndefault: red
\ndescription: Defines the color to use when emitting error messages
\nenv: [{name: ANSIBLE_COLOR_ERROR}]
\nini:
\n– {key: error, section: colors}
\nyaml: {key: colors.error}
\nCOLOR_HIGHLIGHT:
\nname: Color for highlighting
\ndefault: white
\ndescription: Color used for highlights
\nenv: [{name: ANSIBLE_COLOR_HIGHLIGHT}]
\nini:
\n– {key: highlight, section: colors}
\nCOLOR_OK:
\nname: Color for ‘ok’ task status
\ndefault: green
\ndescription: Defines the color to use when showing ‘OK’ task status
\nenv: [{name: ANSIBLE_COLOR_OK}]
\nini:
\n– {key: ok, section: colors}
\nCOLOR_SKIP:
\nname: Color for ‘skip’ task status
\ndefault: cyan
\ndescription: Defines the color to use when showing ‘Skipped’ task status
\nenv: [{name: ANSIBLE_COLOR_SKIP}]
\nini:
\n– {key: skip, section: colors}
\nCOLOR_UNREACHABLE:
\nname: Color for ‘unreachable’ host state
\ndefault: bright red
\ndescription: Defines the color to use on ‘Unreachable’ status
\nenv: [{name: ANSIBLE_COLOR_UNREACHABLE}]
\nini:
\n– {key: unreachable, section: colors}
\nCOLOR_VERBOSE:
\nname: Color for verbose messages
\ndefault: blue
\ndescription: Defines the color to use when emitting verbose messages. i.e those that show with ‘-v’s.
\nenv: [{name: ANSIBLE_COLOR_VERBOSE}]
\nini:
\n– {key: verbose, section: colors}
\nCOLOR_WARN:
\nname: Color for warning messages
\ndefault: bright purple
\ndescription: Defines the color to use when emitting warning messages
\nenv: [{name: ANSIBLE_COLOR_WARN}]
\nini:
\n– {key: warn, section: colors}
\nCOMMAND_WARNINGS:
\nname: Command module warnings
\ndefault: True
\ndescription:
\n– By default Ansible will issue a warning when the shell or command module is used and the command appears to be similar to an existing Ansible module.
\n– These warnings can be silenced by adjusting this setting to False. You can also control this at the task level with the module optoin “warn“.
\nenv: [{name: ANSIBLE_COMMAND_WARNINGS}]
\nini:
\n– {key: command_warnings, section: defaults}
\ntype: boolean
\nversion_added: “1.8”
\nDEFAULT_ACTION_PLUGIN_PATH:
\nname: Action plugins path
\ndefault: ~\/.ansible\/plugins\/action:\/usr\/share\/ansible\/plugins\/action
\ndescription: Colon separated paths in which Ansible will search for Action Plugins.
\nenv: [{name: ANSIBLE_ACTION_PLUGINS}]
\nini:
\n– {key: action_plugins, section: defaults}
\ntype: pathspec
\nyaml: {key: plugins.action.path}
\nDEFAULT_ALLOW_UNSAFE_LOOKUPS:
\nname: Allow unsafe lookups
\ndefault: False
\ndescription:
\n– “When enabled, this option allows lookup plugins (whether used in variables as “{{lookup(‘foo’)}}“ or as a loop as with_foo)
\nto return data that is not marked ‘unsafe’.”
\n– By default, such data is marked as unsafe to prevent the templating engine from evaluating any jinja2 templating language,
\nas this could represent a security risk. This option is provided to allow for backwards-compatibility,
\nhowever users should first consider adding allow_unsafe=True to any lookups which may be expected to contain data which may be run
\nthrough the templating engine late
\nenv: []
\nini:
\n– {key: allow_unsafe_lookups, section: defaults}
\ntype: boolean
\nversion_added: “2.2.3”
\nDEFAULT_ASK_PASS:
\nname: Ask for the login password
\ndefault: False
\ndescription:
\n– This controls whether an Ansible playbook should prompt for a login password.
\nIf using SSH keys for authentication, you probably do not needed to change this setting.
\nenv: [{name: ANSIBLE_ASK_PASS}]
\nini:
\n– {key: ask_pass, section: defaults}
\ntype: boolean
\nyaml: {key: defaults.ask_pass}
\nDEFAULT_ASK_SUDO_PASS:
\nname: Ask for the sudo password
\ndefault: False
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription:
\n– This controls whether an Ansible playbook should prompt for a sudo password.
\nenv: [{name: ANSIBLE_ASK_SUDO_PASS}]
\nini:
\n– {key: ask_sudo_pass, section: defaults}
\ntype: boolean
\nDEFAULT_ASK_SU_PASS:
\nname: Ask for the su password
\ndefault: False
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription:
\n– This controls whether an Ansible playbook should prompt for a su password.
\nenv: [{name: ANSIBLE_ASK_SU_PASS}]
\nini:
\n– {key: ask_su_pass, section: defaults}
\ntype: boolean
\nDEFAULT_ASK_VAULT_PASS:
\nname: Ask for the vault password(s)
\ndefault: False
\ndescription:
\n– This controls whether an Ansible playbook should prompt for a vault password.
\nenv: [{name: ANSIBLE_ASK_VAULT_PASS}]
\nini:
\n– {key: ask_vault_pass, section: defaults}
\ntype: boolean
\nDEFAULT_BECOME:
\nname: Enable privilege escalation (become)
\ndefault: False
\ndescription: Toggles the use of privilege escalation, allowing you to ‘become’ another user after login.
\nenv: [{name: ANSIBLE_BECOME}]
\nini:
\n– {key: become, section: privilege_escalation}
\ntype: boolean
\nDEFAULT_BECOME_ASK_PASS:
\nname: Ask for the privelege escalation (become) password
\ndefault: False
\ndescription: Toggle to prompt for privilege escalation password.
\nenv: [{name: ANSIBLE_BECOME_ASK_PASS}]
\nini:
\n– {key: become_ask_pass, section: privilege_escalation}
\ntype: boolean
\nDEFAULT_BECOME_METHOD:
\nname: Choose privilege escalation method
\ndefault: ‘sudo’
\ndescription: Privilege escalation method to use when `become` is enabled.
\nenv: [{name: ANSIBLE_BECOME_METHOD}]
\nini:
\n– {section: privilege_escalation, key: become_method}
\nDEFAULT_BECOME_EXE:
\nname: Choose ‘become’ executable
\ndefault: ~
\ndescription: ‘executable to use for privilege escalation, otherwise Ansible will depend on PATH’
\nenv: [{name: ANSIBLE_BECOME_EXE}]
\nini:
\n– {key: become_exe, section: privilege_escalation}
\nDEFAULT_BECOME_FLAGS:
\nname: Set ‘become’ executable options
\ndefault: ”
\ndescription: Flags to pass to the privilege escalation executable.
\nenv: [{name: ANSIBLE_BECOME_FLAGS}]
\nini:
\n– {key: become_flags, section: privilege_escalation}
\nDEFAULT_BECOME_USER:
\n# FIXME: should really be blank and make -u passing optional depending on it
\nname: Set the user you ‘become’ via privlege escalation
\ndefault: root
\ndescription: The user your login\/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified.
\nenv: [{name: ANSIBLE_BECOME_USER}]
\nini:
\n– {key: become_user, section: privilege_escalation}
\nyaml: {key: become.user}
\nDEFAULT_CACHE_PLUGIN_PATH:
\nname: Cache Plugins Path
\ndefault: ~\/.ansible\/plugins\/cache:\/usr\/share\/ansible\/plugins\/cache
\ndescription: Colon separated paths in which Ansible will search for Cache Plugins.
\nenv: [{name: ANSIBLE_CACHE_PLUGINS}]
\nini:
\n– {key: cache_plugins, section: defaults}
\ntype: pathspec
\nDEFAULT_CALLABLE_WHITELIST:
\nname: Template ‘callable’ whitelist
\ndefault: []
\ndescription: Whitelist of callable methods to be made available to template evaluation
\nenv: [{name: ANSIBLE_CALLABLE_WHITELIST}]
\nini:
\n– {key: callable_whitelist, section: defaults}
\ntype: list
\nDEFAULT_CALLBACK_PLUGIN_PATH:
\nname: Callback Plugins Path
\ndefault: ~\/.ansible\/plugins\/callback:\/usr\/share\/ansible\/plugins\/callback
\ndescription: Colon separated paths in which Ansible will search for Callback Plugins.
\nenv: [{name: ANSIBLE_CALLBACK_PLUGINS}]
\nini:
\n– {key: callback_plugins, section: defaults}
\ntype: pathspec
\nyaml: {key: plugins.callback.path}
\nDEFAULT_CALLBACK_WHITELIST:
\nname: Callback Whitelist
\ndefault: []
\ndescription:
\n– “List of whitelisted callbacks, not all callbacks need whitelisting,
\nbut many of those shipped with Ansible do as we don’t want them activated by default.”
\nenv: [{name: ANSIBLE_CALLBACK_WHITELIST}]
\nini:
\n– {key: callback_whitelist, section: defaults}
\ntype: list
\nyaml: {key: plugins.callback.whitelist}
\nDEFAULT_CONNECTION_PLUGIN_PATH:
\nname: Connection Plugins Path
\ndefault: ~\/.ansible\/plugins\/connection:\/usr\/share\/ansible\/plugins\/connection
\ndescription: Colon separated paths in which Ansible will search for Connection Plugins.
\nenv: [{name: ANSIBLE_CONNECTION_PLUGINS}]
\nini:
\n– {key: connection_plugins, section: defaults}
\ntype: pathspec
\nyaml: {key: plugins.connection.path}
\nDEFAULT_DEBUG:
\nname: Debug mode
\ndefault: False
\ndescription: Toggles debug output in Ansible, VERY verbose and can hinder multiprocessing.
\nenv: [{name: ANSIBLE_DEBUG}]
\nini:
\n– {key: debug, section: defaults}
\ntype: boolean
\nDEFAULT_EXECUTABLE:
\nname: Target shell executable
\ndefault: \/bin\/sh
\ndescription:
\n– “This indicates the command to use to spawn a shell under for Ansible’s execution needs on a target.
\nUsers may need to change this in rare instances when shell usage is constrained, but in most cases it may be left as is.”
\nenv: [{name: ANSIBLE_EXECUTABLE}]
\nini:
\n– {key: executable, section: defaults}
\nDEFAULT_FACT_PATH:
\nname: local fact path
\ndefault: ~
\ndescription:
\n– “This option allows you to globally configure a custom path for ‘local_facts’ for the implied M(setup) task when using fact gathering.”
\n– “If not set, it will fallback to the default from the M(setup) module: “\/etc\/ansible\/facts.d“.”
\n– “This does **not** affect user defined tasks that use the M(setup) module.”
\nenv: [{name: ANSIBLE_FACT_PATH}]
\nini:
\n– {key: fact_path, section: defaults}
\ntype: path
\nyaml: {key: facts.gathering.fact_path}
\nDEFAULT_FILTER_PLUGIN_PATH:
\nname: Jinja2 Filter Plugins Path
\ndefault: ~\/.ansible\/plugins\/filter:\/usr\/share\/ansible\/plugins\/filter
\ndescription: Colon separated paths in which Ansible will search for Jinja2 Filter Plugins.
\nenv: [{name: ANSIBLE_FILTER_PLUGINS}]
\nini:
\n– {key: filter_plugins, section: defaults}
\ntype: pathspec
\nDEFAULT_FORCE_HANDLERS:
\nname: Force handlers to run after failure
\ndefault: False
\ndescription:
\n– This option controls if notified handlers run on a host even if a failure occurs on that host.
\n– When false, the handlers will not run if a failure has occurred on a host.
\n– This can also be set per play or on the command line. See Handlers and Failure for more details.
\nenv: [{name: ANSIBLE_FORCE_HANDLERS}]
\nini:
\n– {key: force_handlers, section: defaults}
\ntype: boolean
\nversion_added: “1.9.1”
\nDEFAULT_FORKS:
\nname: Number of task forks
\ndefault: 5
\ndescription: Maximum number of forks Ansible will use to execute tasks on target hosts.
\nenv: [{name: ANSIBLE_FORKS}]
\nini:
\n– {key: forks, section: defaults}
\ntype: integer
\nDEFAULT_GATHERING:
\nname: Gathering behaviour
\ndefault: ‘implicit’
\ndescription:
\n– This setting controls the default policy of fact gathering (facts discovered about remote systems).
\n– “When ‘implicit’ (the default), the cache plugin will be ignored and facts will be gathered per play unless ‘gather_facts: False’ is set.”
\n– “When ‘explicit’ the inverse is true, facts will not be gathered unless directly requested in the play.”
\n– “The ‘smart’ value means each new host that has no facts discovered will be scanned,
\nbut if the same host is addressed in multiple plays it will not be contacted again in the playbook run.”
\n– “This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the cache plugin.”
\nenv: [{name: ANSIBLE_GATHERING}]
\nini:
\n– key: gathering
\nsection: defaults
\nversion_added: “1.6”
\nchoices: [‘smart’, ‘explicit’, ‘implicit’]
\nDEFAULT_GATHER_SUBSET:
\nname: Gather facts subset
\ndefault: ‘all’
\ndescription:
\n– Set the `gather_subset` option for the M(setup) task in the implicit fact gathering.
\nSee the module documentation for specifics.
\n– “It does **not** apply to user defined M(setup) tasks.”
\nenv: [{name: ANSIBLE_GATHER_SUBSET}]
\nini:
\n– key: gather_subset
\nsection: defaults
\nversion_added: “2.1”
\nDEFAULT_GATHER_TIMEOUT:
\nname: Gather facts timeout
\ndefault: 10
\ndescription:
\n– Set the timeout in seconds for the implicit fact gathering.
\n– “It does **not** apply to user defined M(setup) tasks.”
\nenv: [{name: ANSIBLE_GATHER_TIMEOUT}]
\nini:
\n– {key: gather_timeout, section: defaults}
\ntype: integer
\nyaml: {key: defaults.gather_timeout}
\nDEFAULT_HANDLER_INCLUDES_STATIC:
\nname: Make handler M(include) static
\ndefault: False
\ndescription:
\n– “Since 2.0 M(include) can be ‘dynamic’, this setting (if True) forces that if the include appears in a “handlers“ section to be ‘static’.”
\nenv: [{name: ANSIBLE_HANDLER_INCLUDES_STATIC}]
\nini:
\n– {key: handler_includes_static, section: defaults}
\ntype: boolean
\ndeprecated:
\nwhy: include itself is deprecated and this setting will not matter in the future
\nversion: “2.8”
\nalternatives: none as its already built into the decision between include_tasks and import_tasks
\nDEFAULT_HASH_BEHAVIOUR:
\nname: Hash merge behaviour
\ndefault: replace
\ntype: string
\nchoices: [“replace”, “merge”]
\ndescription:
\n– This setting controls how variables merge in Ansible.
\nBy default Ansible will override variables in specific precedence orders, as described in Variables.
\nWhen a variable of higher precedence wins, it will replace the other value.
\n– “Some users prefer that variables that are hashes (aka ‘dictionaries’ in Python terms) are merged.
\nThis setting is called ‘merge’. This is not the default behavior and it does not affect variables whose values are scalars
\n(integers, strings) or arrays. We generally recommend not using this setting unless you think you have an absolute need for it,
\nand playbooks in the official examples repos do not use this setting”
\n– In version 2.0 a “combine“ filter was added to allow doing this for a particular variable (described in Filters).
\nenv: [{name: ANSIBLE_HASH_BEHAVIOUR}]
\nini:
\n– {key: hash_behaviour, section: defaults}
\nDEFAULT_HOST_LIST:
\nname: Inventory Source
\ndefault: \/etc\/ansible\/hosts
\ndescription: Colon separated list of Ansible inventory sources
\nenv:
\n– name: ANSIBLE_HOSTS
\ndeprecated:
\nwhy: The variable is misleading as it can be a list of hosts and\/or paths to inventory sources
\nversion: “2.8”
\nalternatives: ANSIBLE_INVENTORY
\n– name: ANSIBLE_INVENTORY
\nexpand_relative_paths: True
\nini:
\n– key: hostfile
\nsection: defaults
\ndeprecated:
\nwhy: The key is misleading as it can also be a list of hosts, a directory or a list of paths
\nversion: “2.8”
\nalternatives: “[defaults]\\ninventory=\/path\/to\/file|dir”
\n– key: inventory
\nsection: defaults
\ntype: pathlist
\nyaml: {key: defaults.inventory}
\nDEFAULT_INTERNAL_POLL_INTERVAL:
\nname: Internal poll interval
\ndefault: 0.001
\nenv: []
\nini:
\n– {key: internal_poll_interval, section: defaults}
\ntype: float
\nversion_added: “2.2”
\ndescription:
\n– This sets the interval (in seconds) of Ansible internal processes polling each other.
\nLower values improve performance with large playbooks at the expense of extra CPU load.
\nHigher values are more suitable for Ansible usage in automation scenarios,
\nwhen UI responsiveness is not required but CPU usage might be a concern.
\n– “The default corresponds to the value hardcoded in Ansible <= 2.1”
\nDEFAULT_INVENTORY_PLUGIN_PATH:
\nname: Inventory Plugins Path
\ndefault: ~\/.ansible\/plugins\/inventory:\/usr\/share\/ansible\/plugins\/inventory
\ndescription: Colon separated paths in which Ansible will search for Inventory Plugins.
\nenv: [{name: ANSIBLE_INVENTORY_PLUGINS}]
\nini:
\n– {key: inventory_plugins, section: defaults}
\ntype: pathspec
\nDEFAULT_JINJA2_EXTENSIONS:
\nname: Enabled Jinja2 extensions
\ndefault: []
\ndescription:
\n– This is a developer-specific feature that allows enabling additional Jinja2 extensions.
\n– “See the Jinja2 documentation for details. If you do not know what these do, you probably don’t need to change this setting :)”
\nenv: [{name: ANSIBLE_JINJA2_EXTENSIONS}]
\nini:
\n– {key: jinja2_extensions, section: defaults}
\nDEFAULT_KEEP_REMOTE_FILES:
\nname: Keep remote files
\ndefault: False
\ndescription: Enables\/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
\nenv: [{name: ANSIBLE_KEEP_REMOTE_FILES}]
\nini:
\n– {key: keep_remote_files, section: defaults}
\ntype: boolean
\nDEFAULT_LIBVIRT_LXC_NOSECLABEL:
\n# TODO: move to plugin
\nname: No security label on Lxc
\ndefault: False
\ndescription:
\n– “This setting causes libvirt to connect to lxc containers by passing –noseclabel to virsh.
\nThis is necessary when running on systems which do not have SELinux.”
\nenv: [{name: LIBVIRT_LXC_NOSECLABEL}]
\nini:
\n– {key: libvirt_lxc_noseclabel, section: selinux}
\ntype: boolean
\nversion_added: “2.1”
\nDEFAULT_LOAD_CALLBACK_PLUGINS:
\nname: Load callbacks for adhoc
\ndefault: False
\ndescription:
\n– Controls whether callback plugins are loaded when running \/usr\/bin\/ansible.
\nThis may be used to log activity from the command line, send notifications, and so on.
\nCallback plugins are always loaded for “ansible-playbook“.
\nenv: [{name: ANSIBLE_LOAD_CALLBACK_PLUGINS}]
\nini:
\n– {key: bin_ansible_callbacks, section: defaults}
\ntype: boolean
\nversion_added: “1.8”
\nDEFAULT_LOCAL_TMP:
\nname: Controller temporary directory
\ndefault: ~\/.ansible\/tmp
\ndescription: Temporary directory for Ansible to use on the controller.
\nenv: [{name: ANSIBLE_LOCAL_TEMP}]
\nini:
\n– {key: local_tmp, section: defaults}
\ntype: tmppath
\nDEFAULT_LOG_PATH:
\nname: Ansible log file path
\ndefault: ”
\ndescription: File to which Ansible will log on the controller. When empty logging is disabled.
\nenv: [{name: ANSIBLE_LOG_PATH}]
\nini:
\n– {key: log_path, section: defaults}
\ntype: path
\nDEFAULT_LOOKUP_PLUGIN_PATH:
\nname: Lookup Plugins Path
\ndescription: Colon separated paths in which Ansible will search for Lookup Plugins.
\ndefault: ~\/.ansible\/plugins\/lookup:\/usr\/share\/ansible\/plugins\/lookup
\nenv: [{name: ANSIBLE_LOOKUP_PLUGINS}]
\nini:
\n– {key: lookup_plugins, section: defaults}
\ntype: pathspec
\nyaml: {key: defaults.lookup_plugins}
\nDEFAULT_MANAGED_STR:
\nname: Ansible managed
\ndefault: ‘Ansible managed’
\ndescription: Sets the macro for the ‘ansible_managed’ variable available for M(template) tasks.
\nenv: []
\nini:
\n– {key: ansible_managed, section: defaults}
\nyaml: {key: defaults.ansible_managed}
\nDEFAULT_MODULE_ARGS:
\nname: Adhoc default arguments
\ndefault: ”
\ndescription:
\n– This sets the default arguments to pass to the “ansible“ adhoc binary if no “-a“ is specified.
\nenv: [{name: ANSIBLE_MODULE_ARGS}]
\nini:
\n– {key: module_args, section: defaults}
\nDEFAULT_MODULE_COMPRESSION:
\nname: Python module compression
\ndefault: ZIP_DEFLATED
\ndescription: Compression scheme to use when transfering Python modules to the target.
\nenv: []
\nini:
\n– {key: module_compression, section: defaults}
\n# vars:
\n# – name: ansible_module_compression
\nDEFAULT_MODULE_LANG:
\nname: Target language environment
\ndefault: “{{CONTROLER_LANG}}”
\ndescription: “Language locale setting to use for modules when they execute on the target, if empty it defaults to ‘en_US.UTF-8′”
\nenv: [{name: ANSIBLE_MODULE_LANG}]
\nini:
\n– {key: module_lang, section: defaults}
\n# vars:
\n# – name: ansible_module_lang
\nDEFAULT_MODULE_NAME:
\nname: Default adhoc module
\ndefault: command
\ndescription: “Module to use with the “ansible“ AdHoc command, if none is specified via “-m“.”
\nenv: []
\nini:
\n– {key: module_name, section: defaults}
\nDEFAULT_MODULE_PATH:
\nname: Modules Path
\ndescription: Colon separated paths in which Ansible will search for Modules.
\ndefault: ~\/.ansible\/plugins\/modules:\/usr\/share\/ansible\/plugins\/modules
\nenv: [{name: ANSIBLE_LIBRARY}]
\nini:
\n– {key: library, section: defaults}
\ntype: pathspec
\nDEFAULT_MODULE_SET_LOCALE:
\nname: Target locale
\ndefault: False
\ndescription: Controls if we set locale for modules when executing on the target.
\nenv: [{name: ANSIBLE_MODULE_SET_LOCALE}]
\nini:
\n– {key: module_set_locale, section: defaults}
\ntype: boolean
\n# vars:
\n# – name: ansible_module_locale
\nDEFAULT_MODULE_UTILS_PATH:
\nname: Module Utils Path
\ndescription: Colon separated paths in which Ansible will search for Module utils files, which are shared by modules.
\ndefault: ~\/.ansible\/plugins\/module_utils:\/usr\/share\/ansible\/plugins\/module_utils
\nenv: [{name: ANSIBLE_MODULE_UTILS}]
\nini:
\n– {key: module_utils, section: defaults}
\ntype: pathspec
\nDEFAULT_NO_LOG:
\nname: No log
\ndefault: False
\ndescription: “Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures.”
\nenv: [{name: ANSIBLE_NO_LOG}]
\nini:
\n– {key: no_log, section: defaults}
\ntype: boolean
\nDEFAULT_NO_TARGET_SYSLOG:
\nname: No syslog on target
\ndefault: False
\ndescription: Toggle Ansbile logging to syslog on the target when it executes tasks.
\nenv: [{name: ANSIBLE_NO_TARGET_SYSLOG}]
\nini:
\n– {key: no_target_syslog, section: defaults}
\ntype: boolean
\nyaml: {key: defaults.no_target_syslog}
\nDEFAULT_NULL_REPRESENTATION:
\nname: Represent a null
\ndefault: ~
\ndescription: What templating should return as a ‘null’ value. When not set it will let Jinja2 decide.
\nenv: [{name: ANSIBLE_NULL_REPRESENTATION}]
\nini:
\n– {key: null_representation, section: defaults}
\ntype: none
\nDEFAULT_POLL_INTERVAL:
\nname: Async poll interval
\ndefault: 15
\ndescription:
\n– For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling),
\nthis is how often to check back on the status of those tasks when an explicit poll interval is not supplied.
\nThe default is a reasonably moderate 15 seconds which is a tradeoff between checking in frequently and
\nproviding a quick turnaround when something may have completed.
\nenv: [{name: ANSIBLE_POLL_INTERVAL}]
\nini:
\n– {key: poll_interval, section: defaults}
\ntype: integer
\nDEFAULT_PRIVATE_KEY_FILE:
\nname: Private key file
\ndefault: ~
\ndescription:
\n– Option for connections using a certificate or key file to authenticate, rather than an agent or passwords,
\nyou can set the default value here to avoid re-specifying –private-key with every invocation.
\nenv: [{name: ANSIBLE_PRIVATE_KEY_FILE}]
\nini:
\n– {key: private_key_file, section: defaults}
\ntype: path
\nDEFAULT_PRIVATE_ROLE_VARS:
\nname: Private role variables
\ndefault: False
\ndescription: ”
\nenv: [{name: ANSIBLE_PRIVATE_ROLE_VARS}]
\nini:
\n– {key: private_role_vars, section: defaults}
\ntype: boolean
\nyaml: {key: defaults.private_role_vars}
\nDEFAULT_REMOTE_PORT:
\nname: Remote port
\ndefault: ~
\ndescription: Port to use in remote connections, when blank it will use the connection plugin default.
\nenv: [{name: ANSIBLE_REMOTE_PORT}]
\nini:
\n– {key: remote_port, section: defaults}
\ntype: integer
\nyaml: {key: defaults.remote_port}
\nDEFAULT_REMOTE_TMP:
\nname: Target temporary directory
\ndefault: ~\/.ansible\/tmp
\ndescription:
\n– Temporary directory to use on targets when executing tasks.
\n– In some cases Ansible may still choose to use a system temporary dir to avoid permission issues.
\nenv: [{name: ANSIBLE_REMOTE_TEMP}]
\nini:
\n– {key: remote_tmp, section: defaults}
\nvars:
\n– name: ansible_remote_tmp
\nDEFAULT_REMOTE_USER:
\nname: Login\/Remote User
\ndefault:
\ndescription:
\n– Sets the login user for the target machines
\n– “When blank it uses the connection plugin’s default, normally the user currently executing Ansible.”
\nenv: [{name: ANSIBLE_REMOTE_USER}]
\nini:
\n– {key: remote_user, section: defaults}
\nDEFAULT_ROLES_PATH:
\nname: Roles path
\ndefault: ~\/.ansible\/roles:\/usr\/share\/ansible\/roles:\/etc\/ansible\/roles
\ndescription: Colon separated paths in which Ansible will search for Roles.
\nenv: [{name: ANSIBLE_ROLES_PATH}]
\nexpand_relative_paths: True
\nini:
\n– {key: roles_path, section: defaults}
\ntype: pathspec
\nyaml: {key: defaults.roles_path}
\nDEFAULT_SCP_IF_SSH:
\n# TODO: move to ssh plugin
\ndefault: smart
\ndescription:
\n– “Prefered method to use when transfering files over ssh”
\n– When set to smart, Ansible will try them until one succeeds or they all fail
\n– If set to True, it will force ‘scp’, if False it will use ‘sftp’
\nenv: [{name: ANSIBLE_SCP_IF_SSH}]
\nini:
\n– {key: scp_if_ssh, section: ssh_connection}
\nDEFAULT_SELINUX_SPECIAL_FS:
\nname: Problematic file systems
\ndefault: fuse, nfs, vboxsf, ramfs, 9p
\ndescription:
\n– “Some filesystems do not support safe operations and\/or return inconsistent errors,
\nthis setting makes Ansible ‘tolerate’ those in the list w\/o causing fatal errors.”
\n– Data corruption may occur and writes are not always verified when a filesystem is in the list.
\nenv: []
\nini:
\n– {key: special_context_filesystems, section: selinux}
\ntype: list
\nDEFAULT_SFTP_BATCH_MODE:
\n# TODO: move to ssh plugin
\ndefault: True
\ndescription: ‘TODO: write it’
\nenv: [{name: ANSIBLE_SFTP_BATCH_MODE}]
\nini:
\n– {key: sftp_batch_mode, section: ssh_connection}
\ntype: boolean
\nyaml: {key: ssh_connection.sftp_batch_mode}
\nDEFAULT_SQUASH_ACTIONS:
\nname: Squashable actions
\ndefault: apk, apt, dnf, homebrew, openbsd_pkg, pacman, pkgng, yum, zypper
\ndescription:
\n– Ansible can optimise actions that call modules that support list parameters when using “with_“ looping.
\nInstead of calling the module once for each item, the module is called once with the full list.
\n– The default value for this setting is only for certain package managers, but it can be used for any module
\n– Currently, this is only supported for modules that have a name or pkg parameter, and only when the item is the only thing being passed to the parameter.
\nenv: [{name: ANSIBLE_SQUASH_ACTIONS}]
\nini:
\n– {key: squash_actions, section: defaults}
\ntype: list
\nversion_added: “2.0”
\nDEFAULT_SSH_TRANSFER_METHOD:
\n# TODO: move to ssh plugin
\ndefault:
\ndescription: ‘unused?’
\n# – “Prefered method to use when transfering files over ssh”
\n# – Setting to smart will try them until one succeeds or they all fail
\n#choices: [‘sftp’, ‘scp’, ‘dd’, ‘smart’]
\nenv: [{name: ANSIBLE_SSH_TRANSFER_METHOD}]
\nini:
\n– {key: transfer_method, section: ssh_connection}
\nDEFAULT_STDOUT_CALLBACK:
\nname: Main display callback plugin
\ndefault: default
\ndescription:
\n– “Set the main callback used to display Ansible output, you can only have one at a time.”
\n– You can have many other callbacks, but just one can be in charge of stdout.
\nenv: [{name: ANSIBLE_STDOUT_CALLBACK}]
\nini:
\n– {key: stdout_callback, section: defaults}
\nDEFAULT_STRATEGY:
\nname: Implied strategy
\ndefault: ‘linear’
\ndescription: Set the default strategy used for plays.
\nenv: [{name: ANSIBLE_STRATEGY}]
\nini:
\n– {key: strategy, section: defaults}
\nversion_added: “2.3”
\nDEFAULT_STRATEGY_PLUGIN_PATH:
\nname: Strategy Plugins Path
\ndescription: Colon separated paths in which Ansible will search for Strategy Plugins.
\ndefault: ~\/.ansible\/plugins\/strategy:\/usr\/share\/ansible\/plugins\/strategy
\nenv: [{name: ANSIBLE_STRATEGY_PLUGINS}]
\nini:
\n– {key: strategy_plugins, section: defaults}
\ntype: pathspec
\nDEFAULT_SU:
\ndefault: False
\ndescription: ‘Toggle the use of “su” for tasks.’
\nenv: [{name: ANSIBLE_SU}]
\nini:
\n– {key: su, section: defaults}
\ntype: boolean
\nyaml: {key: defaults.su}
\nDEFAULT_SUDO:
\ndefault: False
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription: ‘Toggle the use of “sudo” for tasks.’
\nenv: [{name: ANSIBLE_SUDO}]
\nini:
\n– {key: sudo, section: defaults}
\ntype: boolean
\nDEFAULT_SUDO_EXE:
\nname: sudo executable
\ndefault: sudo
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription: ‘specify an “sudo” executable, otherwise it relies on PATH.’
\nenv: [{name: ANSIBLE_SUDO_EXE}]
\nini:
\n– {key: sudo_exe, section: defaults}
\nDEFAULT_SUDO_FLAGS:
\nname: sudo flags
\ndefault: ‘-H -S -n’
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription: ‘Flags to pass to “sudo”‘
\nenv: [{name: ANSIBLE_SUDO_FLAGS}]
\nini:
\n– {key: sudo_flags, section: defaults}
\nDEFAULT_SUDO_USER:
\nname: sudo user
\ndefault:
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription: ‘User you become when using “sudo”, leaving it blank will use the default configured on the target (normally root)’
\nenv: [{name: ANSIBLE_SUDO_USER}]
\nini:
\n– {key: sudo_user, section: defaults}
\nDEFAULT_SU_EXE:
\nname: su executable
\ndefault: su
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription: ‘specify an “su” executable, otherwise it relies on PATH.’
\nenv: [{name: ANSIBLE_SU_EXE}]
\nini:
\n– {key: su_exe, section: defaults}
\nDEFAULT_SU_FLAGS:
\nname: su flags
\ndefault: ”
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\ndescription: ‘Flags to pass to su’
\nenv: [{name: ANSIBLE_SU_FLAGS}]
\nini:
\n– {key: su_flags, section: defaults}
\nDEFAULT_SU_USER:
\nname: su user
\ndefault:
\ndescription: ‘User you become when using “su”, leaving it blank will use the default configured on the target (normally root)’
\nenv: [{name: ANSIBLE_SU_USER}]
\nini:
\n– {key: su_user, section: defaults}
\ndeprecated:
\nwhy: In favor of become which is a generic framework
\nversion: “2.8”
\nalternatives: become
\nDEFAULT_SYSLOG_FACILITY:
\nname: syslog facility
\ndefault: LOG_USER
\ndescription: Syslog facility to use when Ansible logs to the remote target
\nenv: [{name: ANSIBLE_SYSLOG_FACILITY}]
\nini:
\n– {key: syslog_facility, section: defaults}
\nDEFAULT_TASK_INCLUDES_STATIC:
\nname: Task include static
\ndefault: False
\ndescription:
\n– The `include` tasks can be static or dynamic, this toggles the default expected behaviour if autodetection fails and it is not explicitly set in task.
\nenv: [{name: ANSIBLE_TASK_INCLUDES_STATIC}]
\nini:
\n– {key: task_includes_static, section: defaults}
\ntype: boolean
\nversion_added: “2.1”
\ndeprecated:
\nwhy: include itself is deprecated and this setting will not matter in the future
\nversion: “2.8”
\nalternatives: None, as its already built into the decision between include_tasks and import_tasks
\nDEFAULT_TEST_PLUGIN_PATH:
\nname: Jinja2 Test Plugins Path
\ndescription: Colon separated paths in which Ansible will search for Jinja2 Test Plugins.
\ndefault: ~\/.ansible\/plugins\/test:\/usr\/share\/ansible\/plugins\/test
\nenv: [{name: ANSIBLE_TEST_PLUGINS}]
\nini:
\n– {key: test_plugins, section: defaults}
\ntype: pathspec
\nDEFAULT_TIMEOUT:
\nname: Connection timeout
\ndefault: 10
\ndescription: This is the default timeout for connection plugins to use.
\nenv: [{name: ANSIBLE_TIMEOUT}]
\nini:
\n– {key: timeout, section: defaults}
\ntype: integer
\nDEFAULT_TRANSPORT:
\nname: Connection plugin
\ndefault: smart
\ndescription: “Default connection plugin to use, the ‘smart’ option will toggle between ‘ssh’ and ‘paramiko’ depending on controller OS and ssh versions”
\nenv: [{name: ANSIBLE_TRANSPORT}]
\nini:
\n– {key: transport, section: defaults}
\nDEFAULT_UNDEFINED_VAR_BEHAVIOR:
\nname: Jinja2 fail on undefined
\ndefault: True
\nversion_added: “1.3”
\ndescription:
\n– When True, this causes ansible templating to fail steps that reference variable names that are likely typoed.
\n– “Otherwise, any ‘{{ template_expression }}’ that contains undefined variables will be rendered in a template or ansible action line exactly as written.”
\nenv: [{name: ANSIBLE_ERROR_ON_UNDEFINED_VARS}]
\nini:
\n– {key: error_on_undefined_vars, section: defaults}
\ntype: boolean
\nDEFAULT_VARS_PLUGIN_PATH:
\nname: Vars Plugins Path
\ndefault: ~\/.ansible\/plugins\/vars:\/usr\/share\/ansible\/plugins\/vars
\ndescription: Colon separated paths in which Ansible will search for Vars Plugins.
\nenv: [{name: ANSIBLE_VARS_PLUGINS}]
\nini:
\n– {key: vars_plugins, section: defaults}
\ntype: pathspec
\n# TODO: unused?
\n#DEFAULT_VAR_COMPRESSION_LEVEL:
\n# default: 0
\n# description: ‘TODO: write it’
\n# env: [{name: ANSIBLE_VAR_COMPRESSION_LEVEL}]
\n# ini:
\n# – {key: var_compression_level, section: defaults}
\n# type: integer
\n# yaml: {key: defaults.var_compression_level}
\nDEFAULT_VAULT_ID_MATCH:
\nname: Force vault id match
\ndefault: False
\ndescription: ‘If true, decrypting vaults with a vault id will only try the password from the matching vault-id’
\nenv: [{name: ANSIBLE_VAULT_ID_MATCH}]
\nini:
\n– {key: vault_id_match, section: defaults}
\nyaml: {key: defaults.vault_id_match}
\nDEFAULT_VAULT_IDENTITY:
\nname: Vault id label
\ndefault: default
\ndescription: ‘The label to use for the default vault id label in cases where a vault id label is not provided’
\nenv: [{name: ANSIBLE_VAULT_IDENTITY}]
\nini:
\n– {key: vault_identity, section: defaults}
\nyaml: {key: defaults.vault_identity}
\nDEFAULT_VAULT_IDENTITY_LIST:
\nname: Default vault ids
\ndefault: []
\ndescription: ‘A list of vault-ids to use by default. Equivalent to multiple –vault-id args. Vault-ids are tried in order.’
\nenv: [{name: ANSIBLE_VAULT_IDENTITY_LIST}]
\nini:
\n– {key: vault_identity_list, section: defaults}
\ntype: list
\nyaml: {key: defaults.vault_identity_list}
\nDEFAULT_VAULT_PASSWORD_FILE:
\nname: Vault password file
\ndefault: ~
\ndescription: ‘The vault password file to use. Equivalent to –vault-password-file or –vault-id’
\nenv: [{name: ANSIBLE_VAULT_PASSWORD_FILE}]
\nini:
\n– {key: vault_password_file, section: defaults}
\ntype: path
\nyaml: {key: defaults.vault_password_file}
\nDEFAULT_VERBOSITY:
\nname: Verbosity
\ndefault: 0
\ndescription: Sets the default verbosity, equivalent to the number of “-v“ passed in the command line.
\nenv: [{name: ANSIBLE_VERBOSITY}]
\nini:
\n– {key: verbosity, section: defaults}
\ntype: integer
\nDEPRECATION_WARNINGS:
\nname: Deprecation messages
\ndefault: True
\ndescription: “Toggle to control the showing of deprecation warnings”
\nenv: [{name: ANSIBLE_DEPRECATION_WARNINGS}]
\nini:
\n– {key: deprecation_warnings, section: defaults}
\ntype: boolean
\nDIFF_ALWAYS:
\nname: Show differences
\ndefault: False
\ndescription: Configuration toggle to tell modules to show differences when in ‘changed’ status, equivalent to “–diff“.
\nenv: [{name: ANSIBLE_DIFF_ALWAYS}]
\nini:
\n– {key: always, section: diff}
\ntype: bool
\nDIFF_CONTEXT:
\nname: Difference context
\ndefault: 3
\ndescription: How many lines of context to show when displaying the differences between files.
\nenv: [{name: ANSIBLE_DIFF_CONTEXT}]
\nini:
\n– {key: context, section: diff}
\ntype: integer
\nDISPLAY_ARGS_TO_STDOUT:
\nname: Show task arguments
\ndefault: False
\ndescription:
\n– “Normally “ansible-playbook“ will print a header for each task that is run.
\nThese headers will contain the name: field from the task if you specified one.
\nIf you didn’t then “ansible-playbook“ uses the task’s action to help you tell which task is presently running.
\nSometimes 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.
\nIf you set this variable to True in the config then “ansible-playbook“ will also include the task’s arguments in the header.”
\n– “This setting defaults to False because there is a chance that you have sensitive values in your parameters and
\nyou do not want those to be printed.”
\n– “If you set this to True you should be sure that you have secured your environment’s stdout
\n(no one can shoulder surf your screen and you aren’t saving stdout to an insecure file) or
\nmade sure that all of your playbooks explicitly added the “no_log: True“ parameter to tasks which have sensistive values
\nSee How do I keep secret data in my playbook? for more information.”
\nenv: [{name: ANSIBLE_DISPLAY_ARGS_TO_STDOUT}]
\nini:
\n– {key: display_args_to_stdout, section: defaults}
\ntype: boolean
\nversion_added: “2.1”
\nDISPLAY_SKIPPED_HOSTS:
\nname: Show skipped results
\ndefault: True
\ndescription: “Toggle to control displaying skipped task\/host entries in a task in the default callback”
\nenv: [{name: DISPLAY_SKIPPED_HOSTS}]
\nini:
\n– {key: display_skipped_hosts, section: defaults}
\ntype: boolean
\nERROR_ON_MISSING_HANDLER:
\nname: Missing handler error
\ndefault: True
\ndescription: “Toggle to allow missing handlers to become a warning instead of an error when notifying.”
\nenv: [{name: ANSIBLE_ERROR_ON_MISSING_HANDLER}]
\nini:
\n– {key: error_on_missing_handler, section: defaults}
\ntype: boolean
\nGALAXY_IGNORE_CERTS:
\nname: Galaxy validate certs
\ndefault: False
\ndescription:
\n– If set to yes, ansible-galaxy will not validate TLS certificates.
\nThis can be useful for testing against a server with a self-signed certificate.
\nenv: [{name: ANSIBLE_GALAXY_IGNORE}]
\nini:
\n– {key: ignore_certs, section: galaxy}
\ntype: boolean
\nGALAXY_ROLE_SKELETON:
\nname: Galaxy skeleton direcotry
\ndefault:
\ndescription: Role skeleton directory to use as a template for the “init“ action in “ansible-galaxy“, same as “–role-skeleton“.
\nenv: [{name: ANSIBLE_GALAXY_ROLE_SKELETON}]
\nini:
\n– {key: role_skeleton, section: galaxy}
\ntype: path
\nGALAXY_ROLE_SKELETON_IGNORE:
\nname: Galaxy skeleton ignore
\ndefault: [“^.git$”, “^.*\/.git_keep$”]
\ndescription: patterns of files to ignore inside a galaxy role skeleton directory
\nenv: [{name: ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE}]
\nini:
\n– {key: role_skeleton_ignore, section: galaxy}
\ntype: list
\n# TODO: unused?
\n#GALAXY_SCMS:
\n# name: Galaxy SCMS
\n# default: git, hg
\n# description: Available galaxy source control management systems.
\n# env: [{name: ANSIBLE_GALAXY_SCMS}]
\n# ini:
\n# – {key: scms, section: galaxy}
\n# type: list
\nGALAXY_SERVER:
\ndefault: https:\/\/galaxy.ansible.com
\ndescription: “URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source.”
\nenv: [{name: ANSIBLE_GALAXY_SERVER}]
\nini:
\n– {key: server, section: galaxy}
\nyaml: {key: galaxy.server}
\nHOST_KEY_CHECKING:
\nname: Check host keys
\ndefault: True
\ndescription: ‘Set this to “False” if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host’
\nenv: [{name: ANSIBLE_HOST_KEY_CHECKING}]
\nini:
\n– {key: host_key_checking, section: defaults}
\ntype: boolean
\nINVENTORY_ENABLED:
\nname: Active Inventory plugins
\ndefault: [‘host_list’, ‘script’, ‘yaml’, ‘ini’]
\ndescription: List of enabled inventory plugins, it also determines the order in which they are used.
\nenv: [{name: ANSIBLE_INVENTORY_ENABLED}]
\nini:
\n– {key: enable_plugins, section: inventory}
\ntype: list
\nINVENTORY_IGNORE_EXTS:
\nname: Inventory ignore extensions
\ndefault: “{{(BLACKLIST_EXTS + ( ‘~’, ‘.orig’, ‘.ini’, ‘.cfg’, ‘.retry’))}}”
\ndescription: List of extensions to ignore when using a directory as an inventory source
\nenv: [{name: ANSIBLE_INVENTORY_IGNORE}]
\nini:
\n– {key: inventory_ignore_extensions, section: defaults}
\n– {key: ignore_extensions, section: inventory}
\ntype: list
\nINVENTORY_IGNORE_PATTERNS:
\nname: Inventory ignore patterns
\ndefault: []
\ndescription: List of patterns to ignore when using a directory as an inventory source
\nenv: [{name: ANSIBLE_INVENTORY_IGNORE_REGEX}]
\nini:
\n– {key: inventory_ignore_patterns, section: defaults}
\n– {key: ignore_patterns, section: inventory}
\ntype: list
\nINVENTORY_UNPARSED_IS_FAILED:
\nname: Unparsed Inventory failure
\ndefault: False
\ndescription: If ‘true’ unparsed inventory sources become fatal errors, they are warnings otherwise.
\nenv: [{name: ANSIBLE_INVENTORY_UNPARSED_FAILED}]
\nini:
\n– {key: unparsed_is_failed, section: inventory}
\ntype: bool
\nMAX_FILE_SIZE_FOR_DIFF:
\nname: Diff maxiumum file size
\ndefault: 104448
\ndescription: Maximum size of files to be considered for diff display
\nenv: [{name: ANSIBLE_MAX_DIFF_SIZE}]
\nini:
\n– {key: max_diff_size, section: defaults}
\ntype: int
\nMERGE_MULTIPLE_CLI_TAGS:
\nname: Merge ‘tags’ options
\ndefault: True
\ndescription:
\n– “This allows changing how multiple –tags and –skip-tags arguments are handled on the command line.
\nIn Ansible up to and including 2.3, specifying –tags more than once will only take the last value of –tags.”
\n– “Setting this config value to True will mean that all of the –tags options will be merged together. The same holds true for –skip-tags.”
\nenv: [{name: ANSIBLE_MERGE_MULTIPLE_CLI_TAGS}]
\nini:
\n– {key: merge_multiple_cli_tags, section: defaults}
\ntype: bool
\nversion_added: “2.3”
\nNETWORK_GROUP_MODULES:
\nname: Network module families
\ndefault: [eos, nxos, ios, iosxr, junos, ce, vyos, sros, dellos9, dellos10, dellos6, asa, aruba, aireos]
\ndescription: ‘TODO: write it’
\nenv: [{name: NETWORK_GROUP_MODULES}]
\nini:
\n– {key: network_group_modules, section: defaults}
\ntype: list
\nyaml: {key: defaults.network_group_modules}
\n#ONLY_NAMESPACE_FACTS:
\n# Deffered to 2.5
\n# FIXME: reenable when we can remove ansible_ prefix from namespaced facts
\n# default: False
\n# description:
\n# – Facts normally get injected as top level variables, this setting prevents that.
\n# – Facts are still available in the `ansible_facts` variable w\/o the `ansible_` prefix.
\n# env: [{name: ANSIBLE_RESTRICT_FACTS}]
\n# ini:
\n# – {key: restrict_facts_namespace, section: defaults}
\n# type: boolean
\n# yaml: {key: defaults.restrict_facts_namespace}
\n# version_added: “2.4”
\nPARAMIKO_HOST_KEY_AUTO_ADD:
\n# TODO: move to plugin
\ndefault: False
\ndescription: ‘TODO: write it’
\nenv: [{name: ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD}]
\nini:
\n– {key: host_key_auto_add, section: paramiko_connection}
\ntype: boolean
\nPARAMIKO_LOOK_FOR_KEYS:
\n# TODO: move to plugin
\ndefault: True
\ndescription: ‘TODO: write it’
\nenv: [{name: ANSIBLE_PARAMIKO_LOOK_FOR_KEYS}]
\nini:
\n– {key: look_for_keys, section: paramiko_connection}
\ntype: boolean
\nPARAMIKO_PROXY_COMMAND:
\n# TODO: move to plugin
\ndefault:
\ndescription: ‘TODO: write it’
\nenv: [{name: ANSIBLE_PARAMIKO_PROXY_COMMAND}]
\nini:
\n– {key: proxy_command, section: paramiko_connection}
\nPARAMIKO_PTY:
\n# TODO: move to plugin
\ndefault: True
\ndescription: ‘TODO: write it’
\nenv: [{name: ANSIBLE_PARAMIKO_PTY}]
\nini:
\n– {key: pty, section: paramiko_connection}
\ntype: boolean
\nPARAMIKO_RECORD_HOST_KEYS:
\n# TODO: move to plugin
\ndefault: True
\ndescription: ‘TODO: write it’
\nenv: [{name: ANSIBLE_PARAMIKO_RECORD_HOST_KEYS}]
\nini:
\n– {key: record_host_keys, section: paramiko_connection}
\ntype: boolean
\nPERSISTENT_CONTROL_PATH_DIR:
\nname: Persistence socket path
\ndefault: ~\/.ansible\/pc
\ndescription: Path to socket to be used by the connection persistence system.
\nenv: [{name: ANSIBLE_PERSISTENT_CONTROL_PATH_DIR}]
\nini:
\n– {key: control_path_dir, section: persistent_connection}
\ntype: path
\nPERSISTENT_CONNECT_TIMEOUT:
\nname: Persistence timeout
\ndefault: 30
\ndescription: This controls how long the persistent connection will remain idle before it is destroyed.
\nenv: [{name: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT}]
\nini:
\n– {key: connect_timeout, section: persistent_connection}
\ntype: integer
\nPERSISTENT_CONNECT_RETRY_TIMEOUT:
\nname: Persistence connection retry timeout
\ndefault: 15
\ndescription: This contorls the retry timeout for presistent connection to connect to the local domain socket.
\nenv: [{name: ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT}]
\nini:
\n– {key: connect_retry_timeout, section: persistent_connection}
\ntype: integer
\nPERSISTENT_COMMAND_TIMEOUT:
\nname: Persistence command timeout
\ndefault: 10
\ndescription: This controls the amount of time to wait for response from remote device before timing out presistent connection.
\nenv: [{name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT}]
\nini:
\n– {key: command_timeout, section: persistent_connection}
\ntype: int
\nPLAYBOOK_VARS_ROOT:
\nname: playbook vars files root
\ndefault: top
\nversion_added: “2.4.1”
\ndescription:
\n– This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars\/group_vars
\n– The “top“ option follows the traditional behaviour of using the top playbook in the chain to find the root directory.
\n– The “bottom“ option follows the 2.4.0 behaviour of using the current playbook to find the root directory.
\n– The “all“ option examines from the first parent to the current playbook.
\nenv: [{name: ANSIBLE_PLAYBOOK_VARS_ROOT}]
\nini:
\n– {key: playbook_vars_root, section: defaults}
\nchoices: [ top, bottom, all ]
\nRETRY_FILES_ENABLED:
\nname: Retry files
\ndefault: True
\ndescription: This controls whether a failed Ansible playbook should create a .retry file.
\nenv: [{name: ANSIBLE_RETRY_FILES_ENABLED}]
\nini:
\n– {key: retry_files_enabled, section: defaults}
\ntype: bool
\nRETRY_FILES_SAVE_PATH:
\nname: Retry files path
\ndefault: ~
\ndescription: This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.
\nenv: [{name: ANSIBLE_RETRY_FILES_SAVE_PATH}]
\nini:
\n– {key: retry_files_save_path, section: defaults}
\ntype: path
\nSHOW_CUSTOM_STATS:
\nname: Display custom stats
\ndefault: False
\ndescription: ‘This adds the custom stats set via the set_stats plugin to the default output’
\nenv: [{name: ANSIBLE_SHOW_CUSTOM_STATS}]
\nini:
\n– {key: show_custom_stats, section: defaults}
\ntype: bool
\nSTRING_TYPE_FILTERS:
\nname: Filters to preserve strings
\ndefault: [string, to_json, to_nice_json, to_yaml, ppretty, json]
\ndescription:
\n– “This list of filters avoids ‘type conversion’ when templating variables”
\n– Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.
\nenv: [{name: ANSIBLE_STRING_TYPE_FILTERS}]
\nini:
\n– {key: dont_type_filters, section: jinja2}
\ntype: list
\nSYSTEM_WARNINGS:
\nname: System warnings
\ndefault: True
\ndescription:
\n– Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts)
\n– These may include warnings about 3rd party packages or other conditions that should be resolved if possible.
\nenv: [{name: ANSIBLE_SYSTEM_WARNINGS}]
\nini:
\n– {key: system_warnings, section: defaults}
\ntype: boolean
\nUSE_PERSISTENT_CONNECTIONS:
\nname: Persistence
\ndefault: False
\ndescription: Toggles the use of persistence for connections.
\nenv: [{name: ANSIBLE_USE_PERSISTENT_CONNECTIONS}]
\nini:
\n– {key: use_persistent_connections, section: defaults}
\ntype: boolean
\nVARIABLE_PRECEDENCE:
\nname: Group variable precedence
\ndefault: [‘all_inventory’, ‘groups_inventory’, ‘all_plugins_inventory’, ‘all_plugins_play’, ‘groups_plugins_inventory’, ‘groups_plugins_play’]
\ndescription: Allows to change the group variable precedence merge order.
\nenv: [{name: ANSIBLE_PRECEDENCE}]
\nini:
\n– {key: precedence, section: defaults}
\ntype: list
\nversion_added: “2.4”
\nYAML_FILENAME_EXTENSIONS:
\nname: Valid YAML extensions
\ndefault: [“.yml”, “.yaml”, “.json”]
\ndescription:
\n– “Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these.”
\n– ‘This affects vars_files, include_vars, inventory and vars plugins among others.’
\nenv:
\n– name: ANSIBLE_YAML_FILENAME_EXT
\nini:
\n– section: defaults
\nkey: yaml_valid_extensions
\ntype: list
\n…<\/p>\n<\/details>\n\u4f7f\u7528\u8fd9\u4e9b\u4eba\uff0c\u4f1a\u53d8\u6210\u8fd9\u6837\u3002\u8ddf\u9884\u60f3\u7684\u4e00\u6837\u3002<\/p>\n
$ ansible-playbook -i hosts echo-sd.yml\r\n\r\n\uff3f\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\uff3f\r\n\uff1e\u3000PLAY [localhost]\u3000\uff1c\r\n\uffe3Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^\uffe3\r\n\r\n\r\n\uff3f\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\uff3f\r\n\uff1e\u3000TASK [Gathering Facts]\u3000\uff1c\r\n\uffe3Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^\uffe3\r\n\r\nok: [localhost]\r\n\r\n\uff3f\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\uff3f\r\n\uff1e\u3000TASK [Display message]\u3000\uff1c\r\n\uffe3Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^\uffe3\r\n\r\nok: [localhost] => {\r\n \"msg\": \"\u7a81\u7136\u306e\u6b7b\"\r\n}\r\n\r\n\uff3f\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\u4eba\uff3f\r\n\uff1e\u3000PLAY RECAP\u3000\uff1c\r\n\uffe3Y^Y^Y^Y^Y^Y^Y^\uffe3\r\n\r\nlocalhost : ok=2 changed=0 unreachable=0 failed=0\r\n<\/code><\/pre>\ncowsay\u7684\u7248\u672c\u611f\u89c9\u5f88\u5947\u602a\uff0c\u4f46\u662fecho-sd\u7248\u5c31\u6709\u70b9…\u5435\u95f9\u5427\u3002\u8f93\u51fa\u58f0\u97f3\u5f88\u5435\u3002
\n\u867d\u7136\u6700\u521d\u7684\u76ee\u6807\u8fbe\u5230\u4e86\uff0c\u4f46\u6211\u7279\u522b\u6ca1\u6709\u559c\u60a6\u800c\u611f\u5230\u56f0\u6270\u3002<\/p>\n
\u89e3\u91ca<\/h2>\n
\u6211\u60f3\u89e3\u91ca\u4e00\u4e0b\u4e0eecho-sd\u5316\u76f8\u5173\u7684\u90e8\u5206\u3002<\/p>\n
\u6d41\u7a0b\u5904\u7406<\/h3>\n
\u5728 display.py \u4e2d\uff0c\u4f1a\u5c06\u4efb\u52a1\u6267\u884c\u65f6\u7684\u6d88\u606f\u8f93\u51fa\u5230\u5c4f\u5e55\u4e0a\uff0c\u4f46\u5bf9\u4e8e cowsay\uff0c\u901a\u5e38\u4f1a\u6309\u7167\u4ee5\u4e0b\u6d41\u7a0b\u53bb\u8bfb\u53d6\u548c\u6267\u884c\u3002<\/p>\n
\n- \n
\u8bfb\u53d6<\/ol>\n<\/li>\n<\/ol>\n\u786e\u5b9acowsay\u8def\u5f84
\n\u6392\u9664cowsay\u89d2\u8272<\/p>\n
\u6267\u884c<\/p>\n
\u8f93\u51facowsay\u7684\u6a2a\u5e45<\/p>\n
\u8ba9\u6211\u4eec\u786e\u8ba4\u6bcf\u4e2a\u5904\u7406\u8fc7\u7a0b\uff0c\u5e76\u5c06\u5176\u66ff\u6362\u4e3aecho-sd\uff0c\u8fc8\u5411\u5b9e\u73b0 \u3002<\/p>\n
\u52a0\u8f7d<\/h3>\n
\u5728Ansible\u542f\u52a8\u65f6\uff0c\u4f1a\u52a0\u8f7d\u5404\u79cd\u6a21\u5757\uff0c\u5176\u4e2d\u5305\u62ecDisplay\u6a21\u5757\uff0c\u7136\u540e\u6267\u884cinit\u5904\u7406\u3002<\/p>\n
def<\/span> __init__<\/span>(<\/span>self<\/span>,<\/span> verbosity<\/span>=<\/span>0<\/span>):<\/span>\r\n\r\n (<\/span>\u7565<\/span>)<\/span>\r\n\r\n # cowsay\u306e\u5b9f\u884c\u30d1\u30b9\u3092\u683c\u7d0d\u3059\u308b\u5909\u6570\r\n<\/span> self<\/span>.<\/span>b_cowsay<\/span> =<\/span> None<\/span>\r\n\r\n # cowsay\u30ad\u30e3\u30e9\u30af\u30bf\u3092\u30b3\u30f3\u30d5\u30a3\u30b0\u304b\u3089\u8aad\u307f\u8fbc\u3080\r\n<\/span> self<\/span>.<\/span>noncow<\/span> =<\/span> C<\/span>.<\/span>ANSIBLE_COW_SELECTION<\/span>\r\n\r\n # cowsay\u306e\u5b9f\u884c\u30d1\u30b9\u3092\u6c7a\u5b9a\r\n<\/span> self<\/span>.<\/span>set_cowsay_info<\/span>()<\/span>\r\n\r\n # \u30b3\u30f3\u30d5\u30a3\u30b0\u8a2d\u5b9a\u3068\u5408\u308f\u305b\u3066\u4f7f\u7528\u53ef\u80fd\u306acowsay\u30ad\u30e3\u30e9\u30af\u30bf\u3092\u6c7a\u5b9a\r\n<\/span> if<\/span> self<\/span>.<\/span>b_cowsay<\/span>:<\/span>\r\n try<\/span>:<\/span>\r\n # cowsay -l\u30b3\u30de\u30f3\u30c9\u304b\u3089\u74b0\u5883\u4e0a\u4f7f\u7528\u53ef\u80fd\u306acowsay\u30ad\u30e3\u30e9\u30af\u30bf\u3092\u53d6\u5f97\r\n<\/span> cmd<\/span> =<\/span> subprocess<\/span>.<\/span>Popen<\/span>([<\/span>self<\/span>.<\/span>b_cowsay<\/span>,<\/span> \"-l\"<\/span>],<\/span> stdout<\/span>=<\/span>subprocess<\/span>.<\/span>PIPE<\/span>,<\/span> stderr<\/span>=<\/span>subprocess<\/span>.<\/span>PIPE<\/span>)<\/span>\r\n (<\/span>out<\/span>,<\/span> err<\/span>)<\/span> =<\/span> cmd<\/span>.<\/span>communicate<\/span>()<\/span>\r\n self<\/span>.<\/span>cows_available<\/span> =<\/span> set<\/span>([<\/span>to_text<\/span>(<\/span>c<\/span>)<\/span> for<\/span> c<\/span> in<\/span> out<\/span>.<\/span>split<\/span>()])<\/span>\r\n\r\n # \u4f7f\u7528\u53ef\u80fd\u306a\u3082\u306e\u306e\u3046\u3061\u3001\u30db\u30ef\u30a4\u30c8\u30ea\u30b9\u30c8\u3067\u3082\u6307\u5b9a\u3055\u308c\u305f\u30ad\u30e3\u30e9\u30af\u30bf\u306e\u307f\u3092\u629c\u304d\u51fa\u3059\r\n<\/span> if<\/span> C<\/span>.<\/span>ANSIBLE_COW_WHITELIST<\/span>:<\/span>\r\n self<\/span>.<\/span>cows_available<\/span> =<\/span> set<\/span>(<\/span>C<\/span>.<\/span>ANSIBLE_COW_WHITELIST<\/span>).<\/span>intersection<\/span>(<\/span>self<\/span>.<\/span>cows_available<\/span>)<\/span>\r\n except<\/span>:<\/span>\r\n # cowsay -l\u30b3\u30de\u30f3\u30c9\u304c\u5b9f\u884c\u3067\u304d\u306a\u3044\u306a\u3069\u3001\u4f55\u3089\u304b\u306e\u4f8b\u5916\u304c\u8d77\u304d\u305f\u3089cowsay\u3057\u306a\u3044\u3088\u3046\u306b\u3059\u308b\r\n<\/span> self<\/span>.<\/span>b_cowsay<\/span> =<\/span> False<\/span>\r\n\r\n (<\/span>\u7565<\/span>)<\/span>\r\n<\/code><\/pre>\n\u901a\u8fc7 ANSIBLE_COW_WHITELIST \uff0c\u53ef\u4ee5\u6307\u5b9a\u8981\u4f7f\u7528\u7684\u5b57\u7b26\uff0c\u5c31\u50cf\u8fd9\u6837\u7684\u64cd\u4f5c\u4e00\u6837\u3002
\n\u6267\u884c\u8def\u5f84\u4f1a\u5728 set_cowsay_info() \u4e2d\u8fdb\u884c\u8bbe\u7f6e\uff0c\u5c31\u50cf\u8fd9\u6837\u5b50\u3002<\/p>\n
# \u63a2\u7d22\u3059\u308bcowsay\u5b9f\u884c\u30d1\u30b9\u306e\u30ea\u30b9\u30c8\r\n<\/span>b_COW_PATHS<\/span> =<\/span> (<\/span>\r\n b<\/span>\"\/usr\/bin\/cowsay\"<\/span>,<\/span>\r\n b<\/span>\"\/usr\/games\/cowsay\"<\/span>,<\/span>\r\n b<\/span>\"\/usr\/local\/bin\/cowsay\"<\/span>,<\/span> # BSD path for cowsay\r\n<\/span> b<\/span>\"\/opt\/local\/bin\/cowsay\"<\/span>,<\/span> # MacPorts path for cowsay\r\n<\/span>)<\/span>\r\n\r\n(<\/span>\u7565<\/span>)<\/span>\r\n\r\n def<\/span> set_cowsay_info<\/span>(<\/span>self<\/span>):<\/span>\r\n # ANSIBLE_NOCOWS\u3067\u7121\u52b9\u5316\u3055\u308c\u3066\u3044\u306a\u3051\u308c\u3070\u5b9f\u884c\u30d1\u30b9\u3092\u30bb\u30c3\u30c8\u3059\u308b\r\n<\/span> if<\/span> not<\/span> C<\/span>.<\/span>ANSIBLE_NOCOWS<\/span>:<\/span>\r\n\r\n # b_COW_PATHS\u306b\u542b\u307e\u308c\u308b\u3082\u306e\u306e\u3046\u3061\u3001\u5b58\u5728\u3059\u308b\u3082\u306e\u3092b_cowsay\u306b\u30bb\u30c3\u30c8\r\n<\/span> for<\/span> b_cow_path<\/span> in<\/span> b_COW_PATHS<\/span>:<\/span>\r\n if<\/span> os<\/span>.<\/span>path<\/span>.<\/span>exists<\/span>(<\/span>