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-password | --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 playbook, представляющих собой систему конфигурации и многоузлового развертывания. Для получения дополнительной информации посетите страницу проекта (https://docs.ansible.com).

Общие опции

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

запрашивает пароль vault

--become-method <BECOME_METHOD>

метод повышения привилегий (по умолчанию — sudo), используйте 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-pass-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),