ansible-playbook

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

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

Описание

usage: ansible-playbook [-h] [--version] [-v] [-k]
                     [--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] [--force-handlers]
                     [--flush-cache] [-b] [--become-method BECOME_METHOD]
                     [--become-user BECOME_USER] [-K] [-t TAGS]
                     [--skip-tags SKIP_TAGS] [-C] [--syntax-check] [-D]
                     [-i INVENTORY] [--list-hosts] [-l SUBSET]
                     [-e EXTRA_VARS] [--vault-id VAULT_IDS]
                     [--ask-vault-pass | --vault-password-file VAULT_PASSWORD_FILES]
                     [-f FORKS] [-M MODULE_PATH] [--list-tasks]
                     [--list-tags] [--step] [--start-at-task START_AT_TASK]
                     playbook [playbook ...]

Описание

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

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

--ask-vault-pass

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

--become-method <BECOME_METHOD>

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

--become-user <BECOME_USER>

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

--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

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

--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

добавление двоеточием разделённого пути к библиотеке модулей (по умолчанию=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)

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

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

-b, --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>

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

-t, --tags

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

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

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

-v, --verbose

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

Окружение

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

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

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

Файлы

/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-playbook(1), ansible-pull(1), ansible-vault(1),