ansible-playbook

Краткое описание

usage: ansible-playbook [-h] [--version] [-v] [--private-key PRIVATE_KEY_FILE]
                     [-u REMOTE_USER] [-c CONNECTION] [-T TIMEOUT]
                     [--ssh-common-args SSH_COMMON_ARGS]
                     [--sftp-extra-args SFTP_EXTRA_ARGS]
                     [--scp-extra-args SCP_EXTRA_ARGS]
                     [--ssh-extra-args SSH_EXTRA_ARGS] [-k |
                     --connection-password-file CONNECTION_PASSWORD_FILE]
                     [--force-handlers] [-b]
                     [--become-method BECOME_METHOD]
                     [--become-user BECOME_USER] [-K |
                     --become-password-file BECOME_PASSWORD_FILE] [-t TAGS]
                     [--skip-tags SKIP_TAGS] [-C] [-D] [-i INVENTORY]
                     [--list-hosts] [-l SUBSET] [--flush-cache]
                     [-e EXTRA_VARS] [--vault-id VAULT_IDS] [-J |
                     --vault-password-file VAULT_PASSWORD_FILES] [-f FORKS]
                     [-M MODULE_PATH] [--syntax-check] [--list-tasks]
                     [--list-tags] [--step] [--start-at-task START_AT_TASK]
                     playbook [playbook ...]

Описание

инструмент для запуска плейбуков Ansible — системы конфигурации и развёртывания на нескольких узлах. Дополнительные сведения см. на домашней странице проекта (https://docs.ansible.com).

Общие параметры

--become-method <BECOME_METHOD>

метод повышения привилегий (по умолчанию=sudo); используйте ansible-doc -t become -l, чтобы вывести список допустимых вариантов.

--become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>

Файл с паролем для повышения привилегий

--become-user <BECOME_USER>

выполнять операции от имени этого пользователя (по умолчанию=root)

--connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>

Файл с паролем для подключения

--flush-cache

очистить кэш фактов для каждого узла в инвентаре

--force-handlers

запускать обработчики, даже если задача завершилась с ошибкой

--list-hosts

вывести список подходящих узлов; не выполнять никаких других действий

--list-tags

вывести список всех доступных тегов

--list-tasks

вывести список всех задач, которые будут выполнены

--private-key <PRIVATE_KEY_FILE>, --key-file <PRIVATE_KEY_FILE>

использовать этот файл для аутентификации подключения

--scp-extra-args <SCP_EXTRA_ARGS>

указать дополнительные аргументы только для scp (например, -l)

--sftp-extra-args <SFTP_EXTRA_ARGS>

указать дополнительные аргументы только для sftp (например, -f, -l)

--skip-tags

выполнять только те плейбуки и задачи, теги которых не совпадают с этими значениями. Этот аргумент можно указывать несколько раз.

--ssh-common-args <SSH_COMMON_ARGS>

указать общие аргументы для sftp/scp/ssh (например, ProxyCommand)

--ssh-extra-args <SSH_EXTRA_ARGS>

указать дополнительные аргументы только для ssh (например, -R)

--start-at-task <START_AT_TASK>

начать выполнение плейбука с задачи, название которой совпадает с указанным

--step

пошаговый режим: подтверждать выполнение каждой задачи

--syntax-check

проверить синтаксис плейбука, не выполняя его

--vault-id

идентификатор хранилища, который следует использовать. Этот аргумент можно указывать несколько раз.

--vault-password-file, --vault-pass-file

файл с паролем хранилища

--version

показать номер версии программы, расположение файла конфигурации, настроенный путь поиска модулей, расположение модуля и исполняемого файла, затем завершить работу

-C, --check

не вносить изменения; вместо этого попытаться спрогнозировать возможные изменения

-D, --diff

при изменении небольших файлов и шаблонов показывать различия в них; отлично работает с –check

-J, --ask-vault-password, --ask-vault-pass

запросить пароль хранилища

-K, --ask-become-pass

запросить пароль для повышения привилегий

-M, --module-path

добавить пути, разделённые двоеточиями, в начало библиотеки модулей (по умолчанию={{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }}). Этот аргумент можно указывать несколько раз.

-T <TIMEOUT>, --timeout <TIMEOUT>

переопределить время ожидания подключения в секундах (по умолчанию зависит от подключения)

-b, --become

выполнять операции с повышением привилегий (не подразумевает запрос пароля)

-c <CONNECTION>, --connection <CONNECTION>

тип подключения (по умолчанию=ssh)

-e, --extra-vars

задать дополнительные переменные в формате ключ=значение или YAML/JSON; если указан файл, перед его именем добавьте @. Этот аргумент можно указывать несколько раз.

-f <FORKS>, --forks <FORKS>

указать количество параллельных процессов (по умолчанию=5)

-h, --help

показать это справочное сообщение и завершить работу

-i, --inventory, --inventory-file

указать путь к файлу инвентаря или список узлов, разделённых запятыми. Этот аргумент можно указывать несколько раз.

-k, --ask-pass

запросить пароль для подключения

-l <SUBSET>, --limit <SUBSET>

дополнительно ограничить выбранные узлы указанным шаблоном

-t, --tags

выполнять только плейбуки и задачи с указанными тегами. Этот аргумент можно указывать несколько раз.

-u <REMOTE_USER>, --user <REMOTE_USER>

подключаться от имени этого пользователя (по умолчанию=None)

-v, --verbose

Заставляет Ansible выводить больше отладочных сообщений. Чем больше параметров -v указано, тем подробнее вывод; встроенные плагины поддерживают уровень до -vvvvvv. Рекомендуется начать с -vvv; для отладки подключений может потребоваться -vvvv. Этот аргумент можно указывать несколько раз.

Окружение

Можно указать следующие переменные окружения.

ANSIBLE_INVENTORY – Переопределяет используемый по умолчанию файл инвентаря Ansible

ANSIBLE_LIBRARY – Переопределяет используемый по умолчанию путь к библиотеке модулей Ansible

ANSIBLE_CONFIG – Переопределяет используемый по умолчанию файл конфигурации Ansible

Для большинства параметров в ansible.cfg доступны и многие другие переменные.

Файлы

/etc/ansible/hosts – Файл инвентаря по умолчанию

/etc/ansible/ansible.cfg – Файл конфигурации, используемый при наличии

~/.ansible.cfg – Пользовательский файл конфигурации, переопределяющий конфигурацию по умолчанию, если он существует

Автор

Первоначально Ansible был написан Майклом Дехааном.

Полный список участников см. в файле AUTHORS.

Лицензия

Ansible распространяется на условиях лицензии GPLv3+.

См. также

ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-pull(1), ansible-vault(1)