ansible-playbook

Выполняет Ansible playbook, выполняя определённые задачи на целевых хостах.

• Обзор
• Описание
• Общие параметры
• Окружение
• Файлы
• Автор
• Авторские права
• См. также

Обзор

ansible-playbook [options] playbook.yml [playbook2 ...]

Описание

Инструмент для запуска Ansible playbooks, являющихся системой конфигурации и многоузлового развертывания. Дополнительную информацию см. на странице проекта (https://docs.ansible.com).

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

--ask-su-pass

запрос пароля su (устарело, используйте become)

--ask-sudo-pass

запрос пароля sudo (устарело, используйте become)

--ask-vault-pass

запрос пароля vault

--become-method <BECOME_METHOD>

метод повышения привилегий (по умолчанию=sudo), допустимые значения: [ sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas | pmrun | enable | machinectl ]

--become-user <BECOME_USER>

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

--flush-cache

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

--force-handlers

выполнять обработчики даже при ошибке задачи

--list-hosts

выводит список соответствующих хостов; ничего больше не выполняет

--list-tags

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

--list-tasks

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

--private-key, --key-file

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

--scp-extra-args <SCP_EXTRA_ARGS>

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

--sftp-extra-args <SFTP_EXTRA_ARGS>

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

--skip-tags

выполнять только те playbook'и и задачи, теги которых не соответствуют этим значениям

--ssh-common-args <SSH_COMMON_ARGS>

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

--ssh-extra-args <SSH_EXTRA_ARGS>

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

--start-at-task <START_AT_TASK>

начать playbook с задачи с таким именем

--step

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

--syntax-check

провести синтаксическую проверку playbook, но не запускать его

--vault-id

идентификатор vault для использования

--vault-password-file

файл пароля vault

--version

отобразить номер версии программы и выйти

-C, --check

не вносить изменений; вместо этого попытаться спрогнозировать некоторые изменения, которые могут произойти

-D, --diff

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

-K, --ask-become-pass

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

-M, --module-path

добавить двоеточием разделяемые пути к библиотеке модулей (по умолчанию=[‘/root/.ansible/plugins/modules’, ‘/usr/share/ansible/plugins/modules’])

-R <SU_USER>, --su-user <SU_USER>

выполнять операции с su как этим пользователем (по умолчанию=None) (устарело, используйте become)

-S, --su

выполнять операции с su (устарело, используйте become)

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

переопределить тайм-аут подключения в секундах (по умолчанию=10)

-U <SUDO_USER>, --sudo-user <SUDO_USER>

желаемый пользователь sudo (по умолчанию=root) (устарело, используйте become)

-b, --become

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

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

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

-e, --extra-vars

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

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

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

-h, --help

отобразить это сообщение справки и выйти

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

указать путь к инвентарю или список хостов, разделённых запятыми. –inventory-file устарел

-k, --ask-pass

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

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

дальнейшее ограничение выбранных хостов дополнительным шаблоном

-s, --sudo

выполнять операции с sudo (nopasswd) (устарело, используйте become)

-t, --tags

выполнять только те playbook'и и задачи, которые помечены этими тегами

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

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

-v, --verbose

развернутый режим (-vvv для более подробной информации, -vvvv для включения отладки подключения)

Окружение

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

ANSIBLE_CONFIG – Переопределить файл конфигурации ansible по умолчанию

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

Файлы

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

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

Автор

Ansible изначально был написан Майклом ДеХааном.

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

Авторские права

Авторские права © 2017 Red Hat, Inc | Ansible.

Ansible выпущен под лицензией GPLv3.

См. также

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