Ключевые слова плейбука

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

Логическое значение, определяющее, используется ли повышение привилегий при выполнении задачи. Реализуется плагином become. См. раздел Плагины become.

Путь к исполняемому файлу, используемому для повышения привилегий. Реализуется плагином become. См. раздел Плагины become.

Строка с флагом или флагами, передаваемыми программе повышения привилегий, когда become имеет значение True.

Метод повышения привилегий (например, sudo или su).

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

Логическое значение, определяющее, выполняется ли задача обычным образом или не вносит изменений в целевую систему и пытается сообщить, что было бы сделано (режим проверки/пробный запуск). См. раздел Проверка задач: режим проверки и режим различий.

Список пространств имён коллекций для поиска модулей, плагинов и ролей. См. раздел Использование коллекций в плейбуке

Позволяет изменить плагин подключения, используемый для выполнения задач на целевом узле. См. раздел Использование плагинов подключения.

Включает отладку задач в зависимости от состояния результата задачи. См. раздел Отладка задач.

Включает или отключает возврат задачами информации о различиях.

Словарь, преобразуемый в переменные окружения, передаваемые задаче при выполнении. Его можно использовать ТОЛЬКО с модулями. Он не поддерживается плагинами других типов, самим Ansible или его конфигурацией: он лишь задаёт переменные для кода, отвечающего за выполнение задачи. Не рекомендуется передавать таким способом конфиденциальные данные.

Задаёт параметр fact path для плагина сбора фактов, управляемого параметром gather_facts.

Принудительно выполняет уведомлённые обработчики на узлах, даже если во время выполнения плейбука на них произошёл сбой. Не сработает, если сбой произошёл в самом плейбуке.

Логическое значение, определяющее, будет ли плейбук автоматически запускать задачу «setup» для сбора фактов об узлах.

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

Позволяет задать время ожидания для плагина сбора фактов, управляемого параметром gather_facts.

Раздел с задачами, рассматриваемыми как обработчики. Обычно они не выполняются, а запускаются только после уведомления по завершении каждого раздела задач. Поле listen обработчика нельзя шаблонизировать.

Список групп, узлов или шаблон узлов, преобразуемый в список целевых узлов плейбука.

Логическое значение, позволяющее игнорировать сбои задач и продолжать выполнение плейбука. Не влияет на ошибки подключения.

Логическое значение, позволяющее игнорировать сбои задач, вызванные недоступностью узла, и продолжать выполнение плейбука. Не влияет на другие ошибки задач (см. ignore_errors), но полезно для групп нестабильных или временных узлов.

Можно использовать для прерывания выполнения, если сбой произошёл на заданном проценте узлов в текущей группе. Работает только со стратегиями linear и производными от linear.

Задаёт значения параметров модулей по умолчанию.

Идентификатор. Можно использовать в документации или в задачах и обработчиках.

Логическое значение, управляющее раскрытием информации.

Управляет сортировкой узлов при выполнении плейбука. Возможные значения: inventory (по умолчанию), sorted, reverse_sorted, reverse_inventory и shuffle.

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

Список задач, выполняемых после раздела задач.

Список задач, выполняемых перед ролями.

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

Список ролей, импортируемых в плейбук

Логическое значение, отключающее цикл по узлам и принудительно запускающее задачу на первом доступном узле; затем все результаты и факты применяются ко всем активным узлам той же группы.

Позволяет явно задать, как Ansible разбивает выполнение текущего плейбука на целевых узлах на группы. См. раздел Настройка размера группы с помощью serial.

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

Теги, применяемые к задаче или включённым задачам. Позволяют выбирать подмножества задач из командной строки.

Основной список задач для выполнения в плейбуке. Они выполняются после ролей и перед post_tasks.

Ограничивает количество параллельно выполняемых задач на уровне задачи, блока и плейбука. Не зависит от параметров forks и serial, но не может превышать заданные ими ограничения. Например, если forks равен 10, а throttle — 15, параллельно будут обрабатываться не более 10 узлов.

Ограничение времени выполнения действия задачи. Если оно превышено, Ansible прерывает процесс. Время ожидания не включает шаблонизацию и циклы.

НЕ ДОКУМЕНТИРОВАНО!!

Словарь/карта переменных

Список файлов с переменными, подключаемыми к плейбуку.

Список переменных, значения которых запрашиваются у пользователя.

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

Логическое значение, определяющее, используется ли повышение привилегий при выполнении задачи. Реализуется плагином become. См. раздел Плагины become.

Путь к исполняемому файлу, используемому для повышения привилегий. Реализуется плагином become. См. раздел Плагины become.

Строка с флагом или флагами, передаваемыми программе повышения привилегий, когда become имеет значение True.

Метод повышения привилегий (например, sudo или su).

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

Логическое значение, определяющее, выполняется ли задача обычным образом или не вносит изменений в целевую систему и пытается сообщить, что было бы сделано (режим проверки/пробный запуск). См. раздел Проверка задач: режим проверки и режим различий.

Список пространств имён коллекций для поиска модулей, плагинов и ролей. См. раздел Использование коллекций в плейбуке

Позволяет изменить плагин подключения, используемый для выполнения задач на целевом узле. См. раздел Использование плагинов подключения.

Включает отладку задач в зависимости от состояния результата задачи. См. раздел Отладка задач.

Логическое значение, позволяющее применять факты к делегированному узлу вместо inventory_hostname.

Узел, на котором выполняется задача вместо целевого узла (inventory_hostname). Для задачи также будут использоваться переменные подключения делегированного узла.

Включает или отключает возврат задачами информации о различиях.

Словарь, преобразуемый в переменные окружения, передаваемые задаче при выполнении. Его можно использовать ТОЛЬКО с модулями. Он не поддерживается плагинами других типов, самим Ansible или его конфигурацией: он лишь задаёт переменные для кода, отвечающего за выполнение задачи. Не рекомендуется передавать таким способом конфиденциальные данные.

Логическое значение, позволяющее игнорировать сбои задач и продолжать выполнение плейбука. Не влияет на ошибки подключения.

Логическое значение, позволяющее игнорировать сбои задач, вызванные недоступностью узла, и продолжать выполнение плейбука. Не влияет на другие ошибки задач (см. ignore_errors), но полезно для групп нестабильных или временных узлов.

Задаёт значения параметров модулей по умолчанию.

Идентификатор. Можно использовать в документации или в задачах и обработчиках.

Логическое значение, управляющее раскрытием информации.

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

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

Логическое значение, отключающее цикл по узлам и принудительно запускающее задачу на первом доступном узле; затем все результаты и факты применяются ко всем активным узлам той же группы.

Теги, применяемые к задаче или включённым задачам. Позволяют выбирать подмножества задач из командной строки.

Ограничивает количество параллельно выполняемых задач на уровне задачи, блока и плейбука. Не зависит от параметров forks и serial, но не может превышать заданные ими ограничения. Например, если forks равен 10, а throttle — 15, параллельно будут обрабатываться не более 10 узлов.

Ограничение времени выполнения действия задачи. Если оно превышено, Ansible прерывает процесс. Время ожидания не включает шаблонизацию и циклы.

Словарь/карта переменных

Условное выражение, определяющее, будет ли выполнена итерация задачи.

Список задач в блоке, которые выполняются независимо от того, произошла ли в блоке ошибка.

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

Логическое значение, определяющее, используется ли повышение привилегий при выполнении задачи. Реализуется плагином become. См. раздел Плагины become.

Путь к исполняемому файлу, используемому для повышения привилегий. Реализуется плагином become. См. раздел Плагины become.

Строка с флагом или флагами, передаваемыми программе повышения привилегий, когда become имеет значение True.

Метод повышения привилегий (например, sudo или su).

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

Список задач в блоке.

Логическое значение, определяющее, выполняется ли задача обычным образом или не вносит изменений в целевую систему и пытается сообщить, что было бы сделано (режим проверки/пробный запуск). См. раздел Проверка задач: режим проверки и режим различий.

Список пространств имён коллекций для поиска модулей, плагинов и ролей. См. раздел Использование коллекций в плейбуке

Позволяет изменить плагин подключения, используемый для выполнения задач на целевом узле. См. раздел Использование плагинов подключения.

Включает отладку задач в зависимости от состояния результата задачи. См. раздел Отладка задач.

Логическое значение, позволяющее применять факты к делегированному узлу вместо inventory_hostname.

Узел, на котором выполняется задача вместо целевого узла (inventory_hostname). Для задачи также будут использоваться переменные подключения делегированного узла.

Включает или отключает возврат задачами информации о различиях.

Словарь, преобразуемый в переменные окружения, передаваемые задаче при выполнении. Его можно использовать ТОЛЬКО с модулями. Он не поддерживается плагинами других типов, самим Ansible или его конфигурацией: он лишь задаёт переменные для кода, отвечающего за выполнение задачи. Не рекомендуется передавать таким способом конфиденциальные данные.

Логическое значение, позволяющее игнорировать сбои задач и продолжать выполнение плейбука. Не влияет на ошибки подключения.

Логическое значение, позволяющее игнорировать сбои задач, вызванные недоступностью узла, и продолжать выполнение плейбука. Не влияет на другие ошибки задач (см. ignore_errors), но полезно для групп нестабильных или временных узлов.

Задаёт значения параметров модулей по умолчанию.

Идентификатор. Можно использовать в документации или в задачах и обработчиках.

Логическое значение, управляющее раскрытием информации.

Список обработчиков, которые нужно уведомить, когда задача возвращает статус «changed=True».

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

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

Список задач в блоке, выполняемых при ошибке задачи в основном списке блока.

Логическое значение, отключающее цикл по узлам и принудительно запускающее задачу на первом доступном узле; затем все результаты и факты применяются ко всем активным узлам той же группы.

Теги, применяемые к задаче или включённым задачам. Позволяют выбирать подмножества задач из командной строки.

Ограничивает количество параллельно выполняемых задач на уровне задачи, блока и плейбука. Не зависит от параметров forks и serial, но не может превышать заданные ими ограничения. Например, если forks равен 10, а throttle — 15, параллельно будут обрабатываться не более 10 узлов.

Ограничение времени выполнения действия задачи. Если оно превышено, Ansible прерывает процесс. Время ожидания не включает шаблонизацию и циклы.

Словарь/карта переменных

Условное выражение, определяющее, будет ли выполнена итерация задачи.

«Действие», которое нужно выполнить для задачи; обычно оно соответствует модулю C или плагину action.

Принудительно передать необработанные ошибки задач на любом узле всем узлам и завершить play.

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

Асинхронное выполнение задачи, если C(action) поддерживает этот режим; значение задаёт максимальное время выполнения в секундах.

Логическое значение, определяющее, используется ли повышение привилегий при выполнении задачи. Реализуется плагином become. См. Плагины become.

Путь к исполняемому файлу, используемому для повышения привилегий. Реализуется плагином become. См. Плагины become.

Строка с флагами, передаваемыми программе повышения привилегий, когда become имеет значение True.

Метод повышения привилегий (например, sudo или su).

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

Условное выражение, переопределяющее обычный статус задачи «изменено».

Логическое значение, определяющее, выполняется ли задача обычным образом или не вносит изменения в целевой узел и пытается сообщить, что было бы сделано (режим проверки/пробный запуск). См. Проверка задач: режим проверки и режим различий.

Список пространств имён коллекций для поиска модулей, плагинов и ролей. См. Использование коллекций в playbook

Позволяет изменить плагин подключения, используемый для выполнения задач на целевом узле. См. Использование плагинов подключения.

Включает отладку задач в зависимости от состояния результата задачи. См. Отладка задач.

Количество секунд задержки между повторами. Этот параметр используется только вместе с until.

Логическое значение, позволяющее применять факты к делегированному узлу вместо inventory_hostname.

Узел, на котором выполняется задача вместо целевого узла (inventory_hostname). Для задачи также будут использоваться переменные подключения делегированного узла.

Переключатель, определяющий, будут ли задачи возвращать информацию о «различиях».

Словарь, преобразуемый в переменные среды, которые передаются задаче при выполнении. Эту возможность МОЖНО использовать ТОЛЬКО с модулями. Она не поддерживается другими типами плагинов, самим Ansible или его конфигурацией и лишь задаёт переменные для кода, отвечающего за выполнение задачи. Не рекомендуется использовать этот способ для передачи конфиденциальных данных.

Условное выражение, переопределяющее обычный статус задачи «ошибка».

Логическое значение, позволяющее игнорировать ошибки задач и продолжать выполнение play. Не влияет на ошибки подключения.

Логическое значение, позволяющее игнорировать ошибки задач, вызванные недоступностью узла, и продолжать выполнение play. Не влияет на другие ошибки задач (см. ignore_errors), но полезно для групп нестабильных или временных узлов.

То же, что и action, но также подразумевает delegate_to: localhost

Принимает список, по которому выполняется итерация задачи, сохраняя каждый элемент списка в переменную item (настраивается через loop_control)

Несколько ключей позволяют изменить или настроить поведение цикла в задаче. См. Добавление элементов управления в циклы.

Задаёт значения параметров модулей по умолчанию.

Идентификатор. Может использоваться в документации, задачах или обработчиках.

Логическое значение, управляющее раскрытием информации.

Список обработчиков, которым отправляется уведомление, когда задача возвращает статус «changed=True».

Задаёт интервал опроса в секундах для асинхронных задач (по умолчанию 10 с).

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

Имя переменной, в которой будут храниться статус задачи и данные, возвращённые модулем.

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

Количество повторов до прекращения попыток в цикле until. Этот параметр используется только вместе с until.

Логическое значение, отключающее цикл по узлам и заставляющее задачу попытаться выполниться на первом доступном узле, а затем применить все результаты и факты ко всем активным узлам в том же пакете.

Теги, применяемые к задаче или включённым задачам; позволяют выбирать подмножества задач из командной строки.

Ограничивает число одновременных запусков задач на уровне задачи, блока и playbook. Этот параметр не зависит от значений forks и serial, но не может превышать установленные ими ограничения. Например, если forks равен 10, а throttle установлен в 15, параллельно будут обрабатываться не более 10 узлов.

Ограничение времени выполнения действия задачи; если оно превышено, Ansible прервёт процесс. Тайм-аут не включает шаблонизацию и циклы.

Это ключевое слово подразумевает «цикл retries», который выполняется, пока не будет выполнено указанное здесь условие или не будет достигнут предел retries.

Словарь/отображение переменных

Условное выражение, определяющее, будет ли выполнена итерация задачи.

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