Ключевые слова Playbook

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

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

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

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

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

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

Логическое значение, определяющее, выполняется ли задача в режиме «проверки». См. Проверка задач: режим проверки и режим сравнения.

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

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

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

Переключатель, определяющий, возвращает ли задача информацию ‘diff’.

Словарь, который преобразуется в переменные среды для предоставления задаче при выполнении. Это МОЖЕТ быть использовано только с модулями. Это не поддерживается для других типов плагинов, Ansible или его конфигурации; оно просто устанавливает переменные для кода, ответственного за выполнение задачи. Не рекомендуется использовать для передачи конфиденциальных данных.

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

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

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

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

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

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

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

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

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

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

Указывает значения параметров по умолчанию для модулей.

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

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

Управляет сортировкой хостов при выполнении плей. Возможные значения: 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).

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

Булево значение, определяющее, выполняется ли задача в режиме проверки. См. Проверка задач: режим check и режим diff.

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

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

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

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

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

Переключатель для включения или выключения возврата информации ‘diff’ в задаче.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Какой метод повышения привилегий использовать (например, sudo или su).

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

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

Логическое значение, определяющее, выполняется ли задача в режиме «проверки». Смотрите Проверка задач: режим check и diff.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Лимит времени для выполнения задачи. При превышении этого лимита Ansible прервёт и завершит задачу с ошибкой.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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