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

Это ключевые слова, доступные для общих объектов playbook. Ключевые слова являются одним из нескольких источников для настройки поведения Ansible. Подробнее о приоритете каждого источника см. в разделе Управление поведением Ansible: правила приоритета.

• Play
• Роль
• Блок
• Задача

Play

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

check_mode

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

collections

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

Примечание

Задачи в роли не наследуют значение collections из Play. Чтобы роль искала список коллекций, используйте ключевое слово collections в meta/main.yml внутри роли.

connection

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

debugger

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

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

gather_subset

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

gather_timeout

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

handlers

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

hosts

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

ignore_errors

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

ignore_unreachable

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

max_fail_percentage

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

module_defaults

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

name

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

no_log

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

order

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

port

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

post_tasks

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

pre_tasks

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

remote_user

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

roles

Список ролей, которые необходимо импортировать в Play.

run_once

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

serial

Явно определяет, как Ansible группирует выполнение текущего Play на целевом узле Play.

См. также

Установка размера партии с помощью serial

strategy

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

tags

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

tasks

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

throttle

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

timeout

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

vars

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

vars_files

Список файлов, содержащих переменные, которые необходимо включить в Play.

vars_prompt

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

Роль

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

check_mode

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

collections

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

Примечание

Задачи внутри роли не наследуют значение collections из книги выполнения. Чтобы роль искала список коллекций, используйте ключевое слово collections в meta/main.yml внутри роли.

connection

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

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

ignore_unreachable

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

module_defaults

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

name

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

no_log

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

port

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

remote_user

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

run_once

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

tags

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

throttle

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

timeout

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

vars

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

when

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

Блок

always

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

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

block

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

check_mode

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

collections

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

Примечание

Задачи внутри роли не наследуют значение collections от playbook. Чтобы роль искала список коллекций, используйте ключевое слово collections в meta/main.yml внутри роли.

connection

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

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

ignore_unreachable

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

module_defaults

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

name

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

no_log

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

port

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

remote_user

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

rescue

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

run_once

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

tags

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

throttle

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

timeout

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

vars

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

when

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

Задача

action

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

any_errors_fatal

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

args

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

async

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

changed_when

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

check_mode

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

collections

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

Примечание

Задачи внутри роли не наследуют значение collections из книги сценариев. Чтобы роль искала список коллекций, используйте ключевое слово collections в meta/main.yml внутри роли.

connection

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

debugger

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

failed_when

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

ignore_errors

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

ignore_unreachable

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

local_action

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

loop

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

loop_control

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

См. также

Добавление управления циклами

module_defaults

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

name

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

no_log

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

notify

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

poll

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

port

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

register

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

remote_user

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

retries

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

run_once

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

tags

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

throttle

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

timeout

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

until

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

vars

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

when

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

with_<lookup_plugin>

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