文書の表示以前のリビジョンバックリンク文書の先頭へ この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。 ====== Ansible ====== {{:linux:ansible_logo.svg?300|Ansible Logo}}\\ [[git>gilbarbara/logos/|GitHub - gilbarbara/logos: A huge collection of SVG logos]]\\ 公式: [[https://www.ansible.com/|Ansible is Simple IT Automation]] [[gtr>https://www.ansible.com/|翻訳]]\\ ソースコード: [[git>ansible/ansible|GitHub - ansible/ansible: Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. https://docs.ansible.com.]] [[gtr>https://github.com/ansible/ansible|翻訳]]\\ ドキュメント: [[https://docs.ansible.com/|Ansible Documentation]] [[gtr>https://docs.ansible.com/|翻訳]]\\ Ansible（アンシブル）は、プロビジョニング、構成管理、アプリケーションのデプロイメント、オーケストレーション、その他多くのITプロセスを自動化する、オープンソースのIT自動化ツールである。他の単純な管理ツールと違い、Ansibleのユーザー (システム管理者、開発者、アーキテクトなど) は、ソフトウェアのインストール、日常的に行うタスクの自動化、インフラストラクチャのプロビジョニング、セキュリティとコンプライアンスの向上、システムへのパッチ適用、組織全体での自動化の共有に、Ansibleの自動化を使用できる。\\ [[wwjp>Ansible_(ソフトウェア)|Ansible (ソフトウェア) - Wikiwand]] より\\ ===== インストール ===== 公式: [[https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html|Installing Ansible — Ansible Documentation]] [[gtr>https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html|翻訳]]\\ ==== pipx によるインストール ==== [[python:pipx|pipx - 分離環境での Python アプリケーションのインストールと実行]] が必要である🤔\\ フルインストール、または、ミニマルインストールの何れかでインストールする。\\ ※以降の手順ではフルインストールを前提にしている。\\ **Ansible のフルインストール**\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> install <font color="#75507B">--include-deps</font> ansible </pre></html></WRAP> <WRAP color_result><html><pre> installed package <b>ansible</b> <b>9.2.0</b>, installed using Python 3.12.1 These apps are now globally available - ansible - ansible-community - ansible-config - ansible-connection - ansible-console - ansible-doc - ansible-galaxy - ansible-inventory - ansible-playbook - ansible-pull - ansible-test - ansible-vault done! ✨ 🌟 ✨ </pre></html></WRAP> </WRAP> **Ansible のミニマルインストール**\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> install ansible-core </pre></html></WRAP> <WRAP color_result><html><pre> installed package <b>ansible-core</b> <b>2.16.3</b>, installed using Python 3.12.1 These apps are now globally available - ansible - ansible-config - ansible-connection - ansible-console - ansible-doc - ansible-galaxy - ansible-inventory - ansible-playbook - ansible-pull - ansible-test - ansible-vault done! ✨ 🌟 ✨ </pre></html></WRAP> </WRAP> **動作確認**\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">ansible</font> <font color="#75507B">--version</font> </pre></html></WRAP> <WRAP color_result><html><pre> ansible [core 2.16.3] config file = None configured module search path = ['/home/tomoyan/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] ansible python module location = /home/tomoyan/.local/share/pipx/venvs/ansible/lib64/python3.12/site-packages/ansible ansible collection location = /home/tomoyan/.ansible/collections:/usr/share/ansible/collections executable location = /home/tomoyan/.local/bin/ansible python version = 3.12.1 (main, Dec 18 2023, 00:00:00) [GCC 13.2.1 20231205 (Red Hat 13.2.1-6)] (/home/tomoyan/.local/share/pipx/venvs/ansible/bin/python) jinja version = 3.1.3 libyaml = True </pre></html></WRAP> </WRAP> <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">ansible-community</font> <font color="#75507B">--version</font> </pre></html></WRAP> <WRAP color_result><html><pre> Ansible community version 9.2.0 </pre></html></WRAP> </WRAP> **Ansible コマンドのシェル補完を追加**\\ <WRAP color_term> <WRAP color_command><html><pre><font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> inject <font color="#75507B">--include-apps</font> ansible argcomplete </pre></html></WRAP> <WRAP color_result><html><pre> ⚠️ Note: activate-global-python-argcomplete was already on your PATH at /usr/bin/activate-global-python-argcomplete ⚠️ Note: python-argcomplete-check-easy-install-script was already on your PATH at /usr/bin/python-argcomplete-check-easy-install-script ⚠️ Note: register-python-argcomplete was already on your PATH at /usr/bin/register-python-argcomplete installed package <b>argcomplete</b> <b>3.2.2</b>, installed using Python 3.12.1 These apps are now globally available - activate-global-python-argcomplete - ansible - ansible-community - ansible-config - ansible-connection - ansible-console - ansible-doc - ansible-galaxy - ansible-inventory - ansible-playbook - ansible-pull - ansible-test - ansible-vault - python-argcomplete-check-easy-install-script - register-python-argcomplete done! ✨ 🌟 ✨ injected package <b>argcomplete</b> into venv <b>ansible</b> done! ✨ 🌟 ✨ </pre></html></WRAP> </WRAP> <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">bash</font> $ activate-global-python-argcomplete --user </pre></html></WRAP> <WRAP color_result><html><pre> Argcomplete was installed in a virtual environment. Defaulting to user installation. Adding shellcode to /home/tomoyan/.zshenv... Added. Adding shellcode to /home/tomoyan/.bash_completion... Added. Please restart your shell or source the installed file to activate it. </pre></html></WRAP> </WRAP> **Ansible の特定バージョンをインストールする場合**\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> install ansible-core==2.16.3 </pre></html></WRAP> </WRAP> **アンインストールする場合**\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> uninstall ansible <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> uninstall ansible-core </pre></html></WRAP> </WRAP> ==== dnf によるインストール ==== 公式: [[https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html#id3|Installing Ansible on Fedora Linux - Installing Ansible on specific operating systems — Ansible Documentation]] [[gtr>https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html#id3|翻訳]]\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06"><u style="text-decoration-style:single">sudo</u></font> <font color="#4E9A06">dnf</font> install ansible <font color="#75507B">-y</font> </pre></html></WRAP> <WRAP color_result_long><html><pre> メタデータの期限切れの最終確認: 0:00:21 前の 2024年02月08日 09時28分11秒 に実施しました。 依存関係が解決しました。 ============================================================================================================== パッケージ アーキテクチャー バージョン リポジトリー サイズ ============================================================================================================== インストール: <font color="#4E9A06"><b>ansible </b></font> noarch 9.1.0-1.fc39 updates 48 M 依存関係のインストール: <font color="#4E9A06"><b>ansible-core </b></font> noarch 2.16.2-2.fc39 updates 3.7 M <font color="#4E9A06"><b>libdnf5 </b></font> x86_64 5.1.11-1.fc39 updates 930 k <font color="#4E9A06"><b>python3-jinja2 </b></font> noarch 3.1.3-1.fc39 updates 507 k <font color="#4E9A06"><b>python3-resolvelib </b></font> noarch 0.5.5-9.fc39 fedora 42 k 弱い依存関係のインストール: <font color="#4E9A06"><b>python3-libdnf5 </b></font> x86_64 5.1.11-1.fc39 updates 1.5 M トランザクションの概要 ============================================================================================================== インストール 6 パッケージ ダウンロードサイズの合計: 54 M インストール後のサイズ: 484 M パッケージのダウンロード: (1/6): python3-resolvelib-0.5.5-9.fc39.noarch.rpm 151 kB/s | 42 kB 00:00 (2/6): libdnf5-5.1.11-1.fc39.x86_64.rpm 306 kB/s | 930 kB 00:03 (3/6): python3-jinja2-3.1.3-1.fc39.noarch.rpm 198 kB/s | 507 kB 00:02 (4/6): ansible-core-2.16.2-2.fc39.noarch.rpm 600 kB/s | 3.7 MB 00:06 (5/6): python3-libdnf5-5.1.11-1.fc39.x86_64.rpm 153 kB/s | 1.5 MB 00:09 (6/6): ansible-9.1.0-1.fc39.noarch.rpm 2.0 MB/s | 48 MB 00:24 -------------------------------------------------------------------------------------------------------------- 合計 2.1 MB/s | 54 MB 00:26 トランザクションの確認を実行中 トランザクションの確認に成功しました。 トランザクションのテストを実行中 トランザクションのテストに成功しました。 トランザクションを実行中 準備 : 1/1 インストール中 : python3-jinja2-3.1.3-1.fc39.noarch 1/6 インストール中 : libdnf5-5.1.11-1.fc39.x86_64 2/6 インストール中 : python3-libdnf5-5.1.11-1.fc39.x86_64 3/6 インストール中 : python3-resolvelib-0.5.5-9.fc39.noarch 4/6 インストール中 : ansible-core-2.16.2-2.fc39.noarch 5/6 インストール中 : ansible-9.1.0-1.fc39.noarch 6/6 scriptletの実行中: ansible-9.1.0-1.fc39.noarch 6/6 検証 : python3-resolvelib-0.5.5-9.fc39.noarch 1/6 検証 : ansible-9.1.0-1.fc39.noarch 2/6 検証 : ansible-core-2.16.2-2.fc39.noarch 3/6 検証 : libdnf5-5.1.11-1.fc39.x86_64 4/6 検証 : python3-jinja2-3.1.3-1.fc39.noarch 5/6 検証 : python3-libdnf5-5.1.11-1.fc39.x86_64 6/6 インストール済み: ansible-9.1.0-1.fc39.noarch ansible-core-2.16.2-2.fc39.noarch libdnf5-5.1.11-1.fc39.x86_64 python3-jinja2-3.1.3-1.fc39.noarch python3-libdnf5-5.1.11-1.fc39.x86_64 python3-resolvelib-0.5.5-9.fc39.noarch 完了しました! </pre></html></WRAP> </WRAP> ===== 更新 ===== <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">pipx</font> upgrade <font color="#75507B">--include-injected</font> ansible </pre></html></WRAP> </WRAP> ===== ansible.cfg 設定ファイルの生成 ===== 公式: [[https://docs.ansible.com/ansible/latest/installation_guide/intro_configuration.html|Configuring Ansible — Ansible Documentation]] [[gtr>https://docs.ansible.com/ansible/latest/installation_guide/intro_configuration.html|翻訳]]\\ <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">ansible-config</font> init <font color="#75507B">--disabled</font> <font color="#75507B">-t</font> all <font color="#3465A4"><b>></b></font> ansible.cfg </pre></html></WRAP> </WRAP> <WRAP color_term> <WRAP color_command><html><pre> <font color="#FF8700"><b>$</b></font> <font color="#4E9A06">cat</font> <u style="text-decoration-style:single">ansible.cfg</u> </pre></html></WRAP> <WRAP color_mincode_long><code autoconf> [defaults] # (boolean) 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. ;action_warnings=True # (list) Accept list of cowsay templates that are 'safe' to use, set to empty list if you want to enable all installed templates. ;cowsay_enabled_stencils=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 # (string) Specify a custom cowsay path or swap in your cowsay implementation of choice ;cowpath= # (string) This allows you to chose a specific cowsay stencil for the banners or use 'random' to cycle through them. ;cow_selection=default # (boolean) This option forces color mode even when running without a TTY or the "nocolor" setting is True. ;force_color=False # (path) The default root path for Ansible config files on the controller. ;home=~/.ansible # (boolean) This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information. ;nocolor=False # (boolean) If you have cowsay installed but want to avoid the 'cows' (why????), use this. ;nocows=False # (boolean) Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors. ;any_errors_fatal=False # (path) 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. ;become_password_file= # (pathspec) Colon separated paths in which Ansible will search for Become Plugins. ;become_plugins={{ ANSIBLE_HOME ~ "/plugins/become:/usr/share/ansible/plugins/become" }} # (string) Chooses which cache plugin to use, the default 'memory' is ephemeral. ;fact_caching=memory # (string) Defines connection or path information for the cache plugin ;fact_caching_connection= # (string) Prefix to use for cache plugin files/tables ;fact_caching_prefix=ansible_facts # (integer) Expiration timeout for the cache plugin data ;fact_caching_timeout=86400 # (list) 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. ;callbacks_enabled= # (string) When a collection is loaded that does not support the running Ansible version (with the collection metadata key `requires_ansible`). ;collections_on_ansible_version_mismatch=warning # (pathspec) 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" }}'``. ;collections_path={{ ANSIBLE_HOME ~ "/collections:/usr/share/ansible/collections" }} # (boolean) A boolean to enable or disable scanning the sys.path for installed collections ;collections_scan_sys_path=True # (path) The password file to use for the connection plugin. --connection-password-file. ;connection_password_file= # (pathspec) Colon separated paths in which Ansible will search for Action Plugins. ;action_plugins={{ ANSIBLE_HOME ~ "/plugins/action:/usr/share/ansible/plugins/action" }} # (boolean) When enabled, this option allows lookup plugins (whether used in variables as ``{{lookup('foo')}}`` or as a loop as with_foo) to return data that is not marked 'unsafe'. # By default, such data is marked as unsafe to prevent the templating engine from evaluating any jinja2 templating language, as this could represent a security risk. This option is provided to allow for backward compatibility, however users should first consider adding allow_unsafe=True to any lookups which may be expected to contain data which may be run through the templating engine late ;allow_unsafe_lookups=False # (boolean) 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. ;ask_pass=False # (boolean) This controls whether an Ansible playbook should prompt for a vault password. ;ask_vault_pass=False # (pathspec) Colon separated paths in which Ansible will search for Cache Plugins. ;cache_plugins={{ ANSIBLE_HOME ~ "/plugins/cache:/usr/share/ansible/plugins/cache" }} # (pathspec) Colon separated paths in which Ansible will search for Callback Plugins. ;callback_plugins={{ ANSIBLE_HOME ~ "/plugins/callback:/usr/share/ansible/plugins/callback" }} # (pathspec) Colon separated paths in which Ansible will search for Cliconf Plugins. ;cliconf_plugins={{ ANSIBLE_HOME ~ "/plugins/cliconf:/usr/share/ansible/plugins/cliconf" }} # (pathspec) Colon separated paths in which Ansible will search for Connection Plugins. ;connection_plugins={{ ANSIBLE_HOME ~ "/plugins/connection:/usr/share/ansible/plugins/connection" }} # (boolean) 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. ;debug=False # (string) This indicates the command to use to spawn a shell under 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. ;executable=/bin/sh # (string) This option allows you to globally configure a custom path for 'local_facts' for the implied :ref:`ansible_collections.ansible.builtin.setup_module` task when using fact gathering. # If not set, it will fallback to the default from the ``ansible.builtin.setup`` module: ``/etc/ansible/facts.d``. # This does **not** affect user defined tasks that use the ``ansible.builtin.setup`` module. # The real action being created by the implicit task is currently ``ansible.legacy.gather_facts`` module, which then calls the configured fact modules, by default this will be ``ansible.builtin.setup`` for POSIX systems but other platforms might have different defaults. ;fact_path= # (pathspec) Colon separated paths in which Ansible will search for Jinja2 Filter Plugins. ;filter_plugins={{ ANSIBLE_HOME ~ "/plugins/filter:/usr/share/ansible/plugins/filter" }} # (boolean) 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. ;force_handlers=False # (integer) Maximum number of forks Ansible will use to execute tasks on target hosts. ;forks=5 # (string) 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. ;gathering=implicit # (list) Set the `gather_subset` option for the :ref:`ansible_collections.ansible.builtin.setup_module` task in the implicit fact gathering. See the module documentation for specifics. # It does **not** apply to user defined ``ansible.builtin.setup`` tasks. ;gather_subset= # (integer) Set the timeout in seconds for the implicit fact gathering, see the module documentation for specifics. # It does **not** apply to user defined :ref:`ansible_collections.ansible.builtin.setup_module` tasks. ;gather_timeout= # (string) 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) non portable, 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 really needed and 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'**. ;hash_behaviour=replace # (pathlist) Comma separated list of Ansible inventory sources ;inventory=/etc/ansible/hosts # (pathspec) Colon separated paths in which Ansible will search for HttpApi Plugins. ;httpapi_plugins={{ ANSIBLE_HOME ~ "/plugins/httpapi:/usr/share/ansible/plugins/httpapi" }} # (float) This sets the interval (in seconds) of Ansible internal processes polling each other. Lower values improve performance with large playbooks at the expense of extra CPU load. Higher values are more suitable for Ansible usage in automation scenarios, when UI responsiveness is not required but CPU usage might be a concern. # The default corresponds to the value hardcoded in Ansible <= 2.1 ;internal_poll_interval=0.001 # (pathspec) Colon separated paths in which Ansible will search for Inventory Plugins. ;inventory_plugins={{ ANSIBLE_HOME ~ "/plugins/inventory:/usr/share/ansible/plugins/inventory" }} # (string) 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 :) ;jinja2_extensions=[] # (boolean) This option preserves variable types during template operations. ;jinja2_native=False # (boolean) 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``. ;keep_remote_files=False # (boolean) 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``. ;bin_ansible_callbacks=False # (tmppath) Temporary directory for Ansible to use on the controller. ;local_tmp={{ ANSIBLE_HOME ~ "/tmp" }} # (list) List of logger names to filter out of the log file ;log_filter= # (path) File to which Ansible will log on the controller. When empty logging is disabled. ;log_path= # (pathspec) Colon separated paths in which Ansible will search for Lookup Plugins. ;lookup_plugins={{ ANSIBLE_HOME ~ "/plugins/lookup:/usr/share/ansible/plugins/lookup" }} # (string) Sets the macro for the 'ansible_managed' variable available for :ref:`ansible_collections.ansible.builtin.template_module` and :ref:`ansible_collections.ansible.windows.win_template_module`. This is only relevant for those two modules. ;ansible_managed=Ansible managed # (string) This sets the default arguments to pass to the ``ansible`` adhoc binary if no ``-a`` is specified. ;module_args= # (string) Compression scheme to use when transferring Python modules to the target. ;module_compression=ZIP_DEFLATED # (string) Module to use with the ``ansible`` AdHoc command, if none is specified via ``-m``. ;module_name=command # (pathspec) Colon separated paths in which Ansible will search for Modules. ;library={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }} # (pathspec) Colon separated paths in which Ansible will search for Module utils files, which are shared by modules. ;module_utils={{ ANSIBLE_HOME ~ "/plugins/module_utils:/usr/share/ansible/plugins/module_utils" }} # (pathspec) Colon separated paths in which Ansible will search for Netconf Plugins. ;netconf_plugins={{ ANSIBLE_HOME ~ "/plugins/netconf:/usr/share/ansible/plugins/netconf" }} # (boolean) Toggle Ansible's display and logging of task details, mainly used to avoid security disclosures. ;no_log=False # (boolean) 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. ;no_target_syslog=False # (raw) What templating should return as a 'null' value. When not set it will let Jinja2 decide. ;null_representation= # (integer) 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. ;poll_interval=15 # (path) 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. ;private_key_file= # (boolean) 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. # Included roles only make their variables public at execution, unlike imported roles which happen at playbook compile time. ;private_role_vars=False # (integer) Port to use in remote connections, when blank it will use the connection plugin default. ;remote_port= # (string) Sets the login user for the target machines # When blank it uses the connection plugin's default, normally the user currently executing Ansible. ;remote_user= # (pathspec) Colon separated paths in which Ansible will search for Roles. ;roles_path={{ ANSIBLE_HOME ~ "/roles:/usr/share/ansible/roles:/etc/ansible/roles" }} # (string) 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 :ref:`callback_plugins` for a list of available options. ;stdout_callback=default # (string) Set the default strategy used for plays. ;strategy=linear # (pathspec) Colon separated paths in which Ansible will search for Strategy Plugins. ;strategy_plugins={{ ANSIBLE_HOME ~ "/plugins/strategy:/usr/share/ansible/plugins/strategy" }} # (boolean) Toggle the use of "su" for tasks. ;su=False # (string) Syslog facility to use when Ansible logs to the remote target ;syslog_facility=LOG_USER # (pathspec) Colon separated paths in which Ansible will search for Terminal Plugins. ;terminal_plugins={{ ANSIBLE_HOME ~ "/plugins/terminal:/usr/share/ansible/plugins/terminal" }} # (pathspec) Colon separated paths in which Ansible will search for Jinja2 Test Plugins. ;test_plugins={{ ANSIBLE_HOME ~ "/plugins/test:/usr/share/ansible/plugins/test" }} # (integer) This is the default timeout for connection plugins to use. ;timeout=10 # (string) Can be any connection plugin available to your ansible installation. # There is also a (DEPRECATED) special 'smart' option, that will toggle between 'ssh' and 'paramiko' depending on controller OS and ssh versions. ;transport=ssh # (boolean) 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. ;error_on_undefined_vars=True # (pathspec) Colon separated paths in which Ansible will search for Vars Plugins. ;vars_plugins={{ ANSIBLE_HOME ~ "/plugins/vars:/usr/share/ansible/plugins/vars" }} # (string) 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. ;vault_encrypt_identity= # (string) The label to use for the default vault id label in cases where a vault id label is not provided ;vault_identity=default # (list) A list of vault-ids to use by default. Equivalent to multiple --vault-id args. Vault-ids are tried in order. ;vault_identity_list= # (string) If true, decrypting vaults with a vault id will only try the password from the matching vault-id ;vault_id_match=False # (path) 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. ;vault_password_file= # (integer) Sets the default verbosity, equivalent to the number of ``-v`` passed in the command line. ;verbosity=0 # (boolean) Toggle to control the showing of deprecation warnings ;deprecation_warnings=True # (boolean) Toggle to control showing warnings related to running devel ;devel_warning=True # (boolean) 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 which have sensitive values See How do I keep secret data in my playbook? for more information. ;display_args_to_stdout=False # (boolean) Toggle to control displaying skipped task/host entries in a task in the default callback ;display_skipped_hosts=True # (string) Root docsite URL used to generate docs URLs in warning/error text; must be an absolute URL with valid scheme and trailing slash. ;docsite_root_url=https://docs.ansible.com/ansible-core/ # (pathspec) Colon separated paths in which Ansible will search for Documentation Fragments Plugins. ;doc_fragment_plugins={{ ANSIBLE_HOME ~ "/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments" }} # (string) 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. ;duplicate_dict_key=warn # (boolean) 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 when # a task is failed on unreachable. Use the debugger keyword for more flexibility. ;enable_task_debugger=False # (boolean) Toggle to allow missing handlers to become a warning instead of an error when notifying. ;error_on_missing_handler=True # (list) 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). ;facts_modules=smart # (boolean) Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host ;host_key_checking=True # (boolean) 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, these will have an `ansible_` prefix. ;inject_facts_as_vars=True # (string) 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), ``auto_silent``, ``auto_legacy``, and ``auto_legacy_silent``. All discovery modes employ a lookup table to use the included system Python (on distributions known to include one), falling back to a fixed ordered list of well-known Python interpreter locations if a platform-specific default is not available. 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`` or ``auto_legacy_silent``. The value of ``auto_legacy`` provides all the same behavior, but for backwards-compatibility with older Ansible releases that always defaulted to ``/usr/bin/python``, will use that interpreter if present. ;interpreter_python=auto # (boolean) If 'false', invalid attributes for a task will result in warnings instead of errors ;invalid_task_attribute_failed=True # (boolean) Toggle to control showing warnings related to running a Jinja version older than required for jinja2_native ;jinja2_native_warning=True # (boolean) 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. ;localhost_warning=True # (int) Maximum size of files to be considered for diff display ;max_diff_size=104448 # (list) List of extensions to ignore when looking for modules to load # This is for rejecting script and binary module fallback extensions ;module_ignore_exts={{(REJECT_EXTS + ('.yaml', '.yml', '.ini'))}} # (bool) 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 ;module_strict_utf8_response=True # (list) TODO: write it ;network_group_modules=eos, nxos, ios, iosxr, junos, enos, ce, vyos, sros, dellos9, dellos10, dellos6, asa, aruba, aireos, bigip, ironware, onyx, netconf, exos, voss, slxos # (boolean) Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviours in which a plugin loaded in previous plays would be unexpectedly 'sticky'. This setting allows to return to that behaviour. ;old_plugin_cache_clear=False # (path) A number of non-playbook CLIs have a ``--playbook-dir`` argument; this sets the default value for it. ;playbook_dir= # (string) This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars ;playbook_vars_root=top # (path) A path to configuration for filtering which plugins installed on the system are allowed to be used. # See :ref:`plugin_filtering_config` for details of the filter file's format. # The default is /etc/ansible/plugin_filters.yml ;plugin_filters_cfg= # (string) 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. ;python_module_rlimit_nofile=0 # (bool) This controls whether a failed Ansible playbook should create a .retry file. ;retry_files_enabled=False # (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. ;retry_files_save_path= # (str) This setting can be used to optimize vars_plugin usage depending on user's inventory size and play selection. ;run_vars_plugins=demand # (bool) This adds the custom stats set via the set_stats plugin to the default output ;show_custom_stats=False # (string) Action to take when a module parameter value is converted to a string (this does not affect variables). For string parameters, values such as '1.00', "['a', 'b',]", and 'yes', 'y', etc. will be converted by the YAML parser unless fully quoted. # Valid options are 'error', 'warn', and 'ignore'. # Since 2.8, this option defaults to 'warn' but will change to 'error' in 2.12. ;string_conversion_action=warn # (boolean) Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts) # These may include warnings about 3rd party packages or other conditions that should be resolved if possible. ;system_warnings=True # (boolean) 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, False will not honor ignore_errors. ;task_debugger_ignore_errors=True # (integer) Set the maximum time (in seconds) that a task can run for. # If set to 0 (the default) there is no timeout. ;task_timeout=0 # (string) Make ansible transform invalid characters in group names supplied by inventory sources. ;force_valid_group_names=never # (boolean) Toggles the use of persistence for connections. ;use_persistent_connections=False # (bool) 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. ;validate_action_group_metadata=True # (list) Accept list for variable plugins that require it. ;vars_plugins_enabled=host_group_vars # (list) Allows to change the group variable precedence merge order. ;precedence=all_inventory, groups_inventory, all_plugins_inventory, all_plugins_play, groups_plugins_inventory, groups_plugins_play # (string) The salt to use for the vault encryption. If it is not provided, a random salt will be used. ;vault_encrypt_salt= # (bool) Force 'verbose' option to use stderr instead of stdout ;verbose_to_stderr=False # (integer) 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. ;win_async_startup_timeout=5 # (list) 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. ;yaml_valid_extensions=.yml, .yaml, .json # (bool) Toggle to control displaying markers when running in check mode. # The markers are C(DRY RUN) at the beginning and ending of playbook execution (when calling C(ansible-playbook --check)) and C(CHECK MODE) as a suffix at every play and task that is run in check mode. ;check_mode_markers=False # (bool) Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT) ;display_failed_stderr=False # (bool) Toggle to control displaying 'ok' task/host results in a task ;display_ok_hosts=True # (bool) Configure the result format to be more readable # When O(result_format) is set to V(yaml) this option defaults to V(True), and defaults to V(False) when configured to V(json). # Setting this option to V(True) will force V(json) and V(yaml) results to always be pretty printed regardless of verbosity. # When set to V(True) and used with the V(yaml) result format, this option will modify module responses in an attempt to produce a more human friendly output at the expense of correctness, and should not be relied upon to aid in writing variable manipulations or conditionals. For correctness, set this option to V(False) or set O(result_format) to V(json). ;callback_format_pretty= # (str) Define the task result format used in the callback output. # These formats do not cause the callback to emit valid JSON or YAML formats. # The output contains these formats interspersed with other non-machine parsable data. ;callback_result_format=json # (bool) This adds output that shows when a task is started to execute for each host ;show_per_host_start=False # (bool) When a task fails, display the path to the file containing the failed task and the line number. This information is displayed automatically for every task when running with C(-vv) or greater verbosity. ;show_task_path_on_failure=False # (list) list of users to be expected to have admin privileges. This is used by the controller to determine how to share temporary files between the remote user and the become user. ;admin_users=root, toor # (string) Directory in which ansible will keep async job information ;async_dir=~/.ansible_async # (string) Checked when Ansible needs to execute a module as a different user. # If setfacl and chown both fail and do not let the different user access the module's files, they will be chgrp'd to this group. # In order for this to work, the remote_user and become_user must share a common group and this setting must be set to that group. ;common_remote_group= # (string) Temporary directory to use on targets when executing tasks. ;remote_tmp=~/.ansible/tmp # (list) List of valid system temporary directories on the managed machine for Ansible to validate O(remote_tmp) against, when specific permissions are needed. These must be world readable, writable, and executable. This list should only contain directories which the system administrator has pre-created with the proper ownership and permissions otherwise security issues can arise. # When O(remote_tmp) is required to be a system temp dir and it does not match any in the list, the first one from the list will be used instead. ;system_tmpdirs=/var/tmp, /tmp # (boolean) This makes the temporary files created on the machine world-readable and will issue a warning instead of failing the task. # It is useful when becoming an unprivileged user. ;allow_world_readable_tmpfiles=False [privilege_escalation] # (boolean) Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method ;agnostic_become_prompt=True # (boolean) This setting controls if become is skipped when remote user and become user are the same. I.E root sudo to root. # If executable, it will be run and the resulting stdout will be used as the password. ;become_allow_same_user=False # (boolean) Toggles the use of privilege escalation, allowing you to 'become' another user after login. ;become=False # (boolean) Toggle to prompt for privilege escalation password. ;become_ask_pass=False # (string) executable to use for privilege escalation, otherwise Ansible will depend on PATH ;become_exe= # (string) Flags to pass to the privilege escalation executable. ;become_flags= # (string) Privilege escalation method to use when `become` is enabled. ;become_method=sudo # (string) The user your login/remote user 'becomes' when using privilege escalation, most systems will use 'root' when no user is specified. ;become_user=root [persistent_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. ;ansible_connection_path= # (int) This controls the amount of time to wait for response from remote device before timing out persistent connection. ;command_timeout=30 # (integer) This controls the retry timeout for persistent connection to connect to the local domain socket. ;connect_retry_timeout=15 # (integer) This controls how long the persistent connection will remain idle before it is destroyed. ;connect_timeout=30 # (path) Path to socket to be used by the connection persistence system. ;control_path_dir={{ ANSIBLE_HOME ~ "/pc" }} [connection] # (boolean) 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. ;pipelining=False [colors] # (string) Defines the color to use on 'Changed' task status ;changed=yellow # (string) Defines the default color to use for ansible-console ;console_prompt=white # (string) Defines the color to use when emitting debug messages ;debug=dark gray # (string) Defines the color to use when emitting deprecation messages ;deprecate=purple # (string) Defines the color to use when showing added lines in diffs ;diff_add=green # (string) Defines the color to use when showing diffs ;diff_lines=cyan # (string) Defines the color to use when showing removed lines in diffs ;diff_remove=red # (string) Defines the color to use when emitting error messages ;error=red # (string) Defines the color to use for highlighting ;highlight=white # (string) Defines the color to use when showing 'OK' task status ;ok=green # (string) Defines the color to use when showing 'Skipped' task status ;skip=cyan # (string) Defines the color to use on 'Unreachable' status ;unreachable=bright red # (string) Defines the color to use when emitting verbose messages. i.e those that show with '-v's. ;verbose=blue # (string) Defines the color to use when emitting warning messages ;warn=bright purple [selinux] # (boolean) This setting causes libvirt to connect to lxc containers by passing --noseclabel to virsh. This is necessary when running on systems which do not have SELinux. ;libvirt_lxc_noseclabel=False # (list) Some filesystems do not support safe operations and/or return inconsistent errors, this setting makes Ansible 'tolerate' those in the list w/o causing fatal errors. # Data corruption may occur and writes are not always verified when a filesystem is in the list. ;special_context_filesystems=fuse, nfs, vboxsf, ramfs, 9p, vfat [diff] # (bool) Configuration toggle to tell modules to show differences when in 'changed' status, equivalent to ``--diff``. ;always=False # (integer) How many lines of context to show when displaying the differences between files. ;context=3 [galaxy] # (path) The directory that stores cached responses from a Galaxy server. # This is only used by the ``ansible-galaxy collection install`` and ``download`` commands. # Cache files inside this dir will be ignored if they are world writable. ;cache_dir={{ ANSIBLE_HOME ~ "/galaxy_cache" }} # (bool) whether ``ansible-galaxy collection install`` should warn about ``--collections-path`` missing from configured :ref:`collections_paths` ;collections_path_warning=True # (path) Collection skeleton directory to use as a template for the ``init`` action in ``ansible-galaxy collection``, same as ``--collection-skeleton``. ;collection_skeleton= # (list) patterns of files to ignore inside a Galaxy collection skeleton directory ;collection_skeleton_ignore=^.git$, ^.*/.git_keep$ # (bool) Disable GPG signature verification during collection installation. ;disable_gpg_verify=False # (bool) 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. ;display_progress= # (path) Configure the keyring used for GPG signature verification during collection installation and verification. ;gpg_keyring= # (boolean) 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. ;ignore_certs= # (list) 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. ;ignore_signature_status_codes= # (str) 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. ;required_valid_signature_count=1 # (path) Role skeleton directory to use as a template for the ``init`` action in ``ansible-galaxy``/``ansible-galaxy role``, same as ``--role-skeleton``. ;role_skeleton= # (list) patterns of files to ignore inside a Galaxy role or collection skeleton directory ;role_skeleton_ignore=^.git$, ^.*/.git_keep$ # (string) URL to prepend when roles don't specify the full URI, assume they are referencing this server as the source. ;server=https://galaxy.ansible.com # (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 :ref:`galaxy_server_config` for more details on how to define a Galaxy server. # The order of servers in this list is used to as the order in which a collection is resolved. # Setting this config option will ignore the :ref:`galaxy_server` config option. ;server_list= # (int) The default timeout for Galaxy API calls. Galaxy servers that don't configure a specific timeout will fall back to this value. ;server_timeout=60 # (path) Local path to galaxy access token file ;token_path={{ ANSIBLE_HOME ~ "/galaxy_token" }} [inventory] # (string) This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it ;host_pattern_mismatch=warning # (boolean) 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. ;any_unparsed_is_failed=False # (bool) Toggle to turn on inventory caching. # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`. # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory configuration. # This message will be removed in 2.16. ;cache=False # (string) The plugin for caching inventory. # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`. # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. # This message will be removed in 2.16. ;cache_plugin= # (string) The inventory cache connection. # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`. # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. # This message will be removed in 2.16. ;cache_connection= # (string) The table prefix for the cache plugin. # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`. # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. # This message will be removed in 2.16. ;cache_prefix=ansible_inventory_ # (string) Expiration timeout for the inventory cache plugin data. # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`. # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. # This message will be removed in 2.16. ;cache_timeout=3600 # (list) List of enabled inventory plugins, it also determines the order in which they are used. ;enable_plugins=host_list, script, auto, yaml, ini, toml # (bool) Controls if ansible-inventory will accurately reflect Ansible's view into inventory or its optimized for exporting. ;export=False # (list) List of extensions to ignore when using a directory as an inventory source ;ignore_extensions={{(REJECT_EXTS + ('.orig', '.ini', '.cfg', '.retry'))}} # (list) List of patterns to ignore when using a directory as an inventory source ;ignore_patterns= # (bool) If 'true' it is a fatal error if every single potential inventory source fails to parse, otherwise this situation will only attract a warning. ;unparsed_is_failed=False # (boolean) 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. ;inventory_unparsed_warning=True [netconf_connection] # (string) 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. ;ssh_config= [paramiko_connection] # (boolean) TODO: write it ;host_key_auto_add=False # (boolean) TODO: write it ;look_for_keys=True # (float) Configures, in seconds, the amount of time to wait for the SSH banner to be presented. This option is supported by paramiko version 1.15.0 or newer. ;banner_timeout=30 # (boolean) Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host ;host_key_checking=True # (int) Remote port to connect to. ;remote_port=22 # (string) Path to private key file to use for authentication. ;private_key_file= # (string) Proxy information for running the connection via a jumphost # Also this plugin will scan 'ssh_args', 'ssh_extra_args' and 'ssh_common_args' from the 'ssh' plugin settings for proxy information if set. ;proxy_command= # (boolean) SUDO usually requires a PTY, True to give a PTY and False to not give a PTY. ;pty=True # (boolean) Save the host keys to a file ;record_host_keys=True # (string) User to login/authenticate as # Can be set from the CLI via the C(--user) or C(-u) options. ;remote_user= # (int) Number of seconds until the plugin gives up on failing to establish a TCP connection. ;timeout=10 # (boolean) Whether or not to enable RSA SHA2 algorithms for pubkeys and hostkeys # On paramiko versions older than 2.9, this only affects hostkeys # For behavior matching paramiko<2.9 set this to V(False) ;use_rsa_sha2_algorithms=True [jinja2] # (list) 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. ;dont_type_filters=string, to_json, to_nice_json, to_yaml, to_nice_yaml, ppretty, json [tags] # (list) default list of tags to run in your plays, Skip Tags has precedence. ;run= # (list) default list of tags to skip in your plays, has precedence over Run Tags ;skip= [runas_become_plugin] # (string) Options to pass to runas, a space delimited list of k=v pairs ;flags= # (string) password ;password= # (string) User you 'become' to execute the task ;user= [su_become_plugin] # (string) Su executable ;executable=su # (string) Options to pass to su ;flags= # (string) Password to pass to su ;password= # (string) User you 'become' to execute the task ;user=root # (list) List of localized strings to match for prompt detection # If empty we'll use the built in one # Do NOT add a colon (:) to your custom entries. Ansible adds a colon at the end of each prompt; if you add another one in your string, your prompt will fail with a "Timeout" error. ;localized_prompts= [sudo_become_plugin] # (string) Sudo executable ;executable=sudo # (string) Options to pass to sudo ;flags=-H -S -n # (string) Password to pass to sudo ;password= # (string) User you 'become' to execute the task ;user=root [callback_tree] # (path) directory that will contain the per host JSON files. Also set by the C(--tree) option when using adhoc. ;directory=~/.ansible/tree [ssh_connection] # (string) Only used in parsing ProxyCommand for use in this plugin. ;ssh_args= # (string) Only used in parsing ProxyCommand for use in this plugin. ;ssh_common_args= # (string) Only used in parsing ProxyCommand for use in this plugin. ;ssh_extra_args= # (string) This is the location to save SSH's ControlPath sockets, it uses SSH's variable substitution. # Since 2.3, if null (default), ansible will generate a unique hash. Use ``%(directory)s`` to indicate where to use the control dir path setting. # Before 2.3 it defaulted to ``control_path=%(directory)s/ansible-ssh-%%h-%%p-%%r``. # Be aware that this setting is ignored if C(-o ControlPath) is set in ssh args. ;control_path= # (string) This sets the directory to use for ssh control path if the control path setting is null. # Also, provides the ``%(directory)s`` variable for the control path setting. ;control_path_dir=~/.ansible/cp # (boolean) Determines if SSH should check host keys. ;host_key_checking=True # (boolean) Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers. # This can result in a very significant performance improvement when enabled. # However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default. ;pipelining=False # (string) PKCS11 SmartCard provider such as opensc, example: /usr/local/lib/opensc-pkcs11.so # Requires sshpass version 1.06+, sshpass must support the -P option. ;pkcs11_provider= # (integer) Number of attempts to connect. # Ansible retries connections only if it gets an SSH error with a return code of 255. # Any errors with return codes other than 255 indicate an issue with program execution. ;retries=0 # (string) This defines the location of the scp binary. It defaults to V(scp) which will use the first binary available in $PATH. ;scp_executable=scp # (string) Extra exclusive to the C(scp) CLI ;scp_extra_args= # (string) Preferred method to use when transferring files over SSH. # When set to V(smart), Ansible will try them until one succeeds or they all fail. # If set to V(True), it will force 'scp', if V(False) it will use 'sftp'. # For OpenSSH >=9.0 you must add an additional option to enable scp (C(scp_extra_args="-O")) # This setting will overridden by O(ssh_transfer_method) if set. ;scp_if_ssh=smart # (bool) TODO: write it ;sftp_batch_mode=True # (string) This defines the location of the sftp binary. It defaults to V(sftp) which will use the first binary available in $PATH. ;sftp_executable=sftp # (string) Extra exclusive to the C(sftp) CLI ;sftp_extra_args= # (string) This defines the location of the SSH binary. It defaults to V(ssh) which will use the first SSH binary available in $PATH. # This option is usually not required, it might be useful when access to system SSH is restricted, or when using SSH wrappers to connect to remote hosts. ;ssh_executable=ssh # (string) Preferred method to use when transferring files over ssh # Setting to 'smart' (default) will try them in order, until one succeeds or they all fail # For OpenSSH >=9.0 you must add an additional option to enable scp (scp_extra_args="-O") # Using 'piped' creates an ssh pipe with C(dd) on either side to copy the data ;transfer_method= # (string) Password prompt that sshpass should search for. Supported by sshpass 1.06 and up. # Defaults to C(Enter PIN for) when pkcs11_provider is set. ;sshpass_prompt= # (integer) This is the default amount of time we will wait while establishing an SSH connection. # It also controls how long we can wait to access reading the connection once established (select on the socket). ;timeout=10 # (bool) add -tt to ssh commands to force tty allocation. ;usetty=True [winrm] # (list) A list of environment variables to pass through to C(kinit) when getting the Kerberos authentication ticket. # By default no environment variables are passed through and C(kinit) is run with a blank slate. # The environment variable C(KRB5CCNAME) cannot be specified here as it's used to store the temp Kerberos ticket used by WinRM. ;kinit_env_vars= [inventory_plugins] # (bool) Merge extra vars into the available variables for composition (highest precedence). ;use_extra_vars=False [inventory_plugin_script] # (boolean) Toggle display of stderr even when script was successful ;always_show_stderr=True [inventory_plugin_yaml] # (list) list of 'valid' extensions for files containing YAML ;yaml_valid_extensions=.yaml, .yml, .json [url_lookup] # (string) String of file system path to CA cert bundle to use ;ca_path= # (list) SSL/TLS Ciphers to use for the request # When a list is provided, all ciphers are joined in order with C(:) # See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT) for more details. # The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions ;ciphers= # (string) String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information ;follow_redirects=urllib2 # (boolean) Whether or not to set "cache-control" header with value "no-cache" ;force=False # (boolean) Force basic authentication ;force_basic_auth=False # (string) User-Agent to use in the request. The default was changed in 2.11 to V(ansible-httpget). ;agent=ansible-httpget # (float) How long to wait for the server to send data before giving up ;timeout=10 # (string) String of file system path to unix socket file to use when establishing connection to the provided url ;unix_socket= # (list) A list of headers to not attach on a redirected request ;unredirected_headers= # (boolean) Use GSSAPI handler of requests # As of Ansible 2.11, GSSAPI credentials can be specified with O(username) and O(password). ;use_gssapi=False # (boolean) Determining whether to use credentials from ``~/.netrc`` file # By default .netrc is used with Basic authentication headers # When set to False, .netrc credentials are ignored ;use_netrc=True [powershell] # (string) Directory in which ansible will keep async job information. # Before Ansible 2.8, this was set to C(remote_tmp + "\.ansible_async"). ;async_dir=%USERPROFILE%\.ansible_async # (string) Temporary directory to use on targets when copying files to the host. ;remote_tmp=%TEMP% [vars_host_group_vars] # (str) Control when this vars plugin may be executed. # Setting this option to V(all) will run the vars plugin after importing inventory and whenever it is demanded by a task. # Setting this option to V(task) will only run the vars plugin whenever it is demanded by a task. # Setting this option to V(inventory) will only run the vars plugin after parsing inventory. # If this option is omitted, the global C(RUN_VARS_PLUGINS) configuration is used to determine when to execute the vars plugin. ;stage= </code></WRAP> </WRAP> ==== 設定ファイルの検索順序 ==== 公式: [[https://docs.ansible.com/ansible/latest/reference_appendices/config.html|Ansible Configuration Settings — Ansible Documentation]] [[gtr>https://docs.ansible.com/ansible/latest/reference_appendices/config.html|翻訳]]\\ * <html><code>ANSIBLE_CONFIG</code></html> (環境変数が設定されている場合) * <html><code>ansible.cfg</code></html> (現在のディレクトリ内) * <html><code>~/.ansible.cfg</code></html> (ホームディレクトリ内) * <html><code>/etc/ansible/ansible.cfg</code></html> ===== Ansible playbooks ===== 公式: [[https://docs.ansible.com/ansible/latest/playbook_guide/index.html|Using Ansible playbooks — Ansible Documentation]] [[gtr>https://docs.ansible.com/ansible/latest/playbook_guide/index.html|翻訳]]\\ 公式: [[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks.html|Working with playbooks — Ansible Documentation]] [[gtr>https://docs.ansible.com/ansible/latest/playbook_guide/playbooks.html|翻訳]]\\ サンプル: [[git>ansible/ansible-examples|ansible/ansible-examples: A few starter examples of ansible playbooks, to show features and how they work together. See http://galaxy.ansible.com for example roles from the Ansible community for deploying many popular applications.]]\\ テンプレート: [[https://jinja.palletsprojects.com/en/latest/templates/|Template Designer Documentation — Jinja Documentation]] [[gtr>https://jinja.palletsprojects.com/en/latest/templates/|翻訳]]\\ [[https://jinja.palletsprojects.com/en/latest/|Jinja — Jinja Documentation]] [[gtr>https://jinja.palletsprojects.com/en/latest/|翻訳]]\\ ====== Ansible AWX ====== 公式: [[git>ansible/awx|GitHub - ansible/awx: AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is one of the upstream projects for Red Hat Ansible Automation Platform.]] [[gtr>https://github.com/ansible/awx|翻訳]]\\ ドキュメント: [[rtd>https://ansible.readthedocs.io/projects/awx/en/latest/index.html|Ansible AWX Documentation — Ansible AWX community documentation]] [[gtr>https://ansible.readthedocs.io/projects/awx/en/latest/index.html|翻訳]]\\ ====== 参考文献 ====== [[https://www.redhat.com/ja/technologies/management/ansible/compare-awx-vs-ansible-automation-platform|Ansible、AWX、Ansible Automation Platform を理解する]]\\ linux/ansible.txt 最終更新: 2024/03/08 11:04by ともやん
ともやん ともやん