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

Это ключевые слова, доступные для общих объектов playbook.

• Плей
• Роль
• Блок
• Задача

Плей

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

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

См. также

Режим проверки («сухая прогонка»)

connection

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

См. также

Использование плагинов подключения

debugger

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

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

gather_subset

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

gather_timeout

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

handlers

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

hosts

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

ignore_errors

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

max_fail_percentage

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

module_defaults

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

name

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

no_log

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

order

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

port

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

post_tasks

Список задач, которые должны быть выполнены после раздела задач.

pre_tasks

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

remote_user

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

roles

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

run_once

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

serial

Явно определяет, как Ansible группирует выполнение текущего плей на целевых хостах плей

См. также

Размер партии при обновлении

strategy

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

tags

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

tasks

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

vars

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

vars_files

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

vars_prompt

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

vault_password

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

Роль

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

Булево значение, контролирующее выполнение задачи в режиме «проверки».

См. также

Режим проверки («сухой запуск»)

connection

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

См. также

Использование плагинов подключения

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

module_defaults

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

name

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

no_log

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

port

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

remote_user

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

run_once

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

tags

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

vars

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

when

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

Блок

always

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

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

block

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

check_mode

Булево значение, контролирующее выполнение задачи в режиме «проверки».

См. также

Режим проверки («сухой запуск»)

connection

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

См. также

Использование плагинов подключения

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

module_defaults

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

name

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

no_log

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

port

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

remote_user

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

rescue

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

run_once

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

tags

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

vars

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

when

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

Задача

action

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

any_errors_fatal

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

args

УСТЕРЕЖДЁН, альтернативный способ добавления аргументов в задачу. Принимает словарь, в котором ключи соответствуют параметрам, а значения — им.

async

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

become

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

become_flags

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

become_method

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

become_user

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

changed_when

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

check_mode

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

См. также

Режим проверки («сухой запуск»)

connection

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

См. также

Использование плагинов подключения

debugger

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

failed_when

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

ignore_errors

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

local_action

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

loop

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

loop_control

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

См. также

Управление циклом

module_defaults

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

name

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

no_log

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

notify

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

poll

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

port

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

register

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

remote_user

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

retries

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

run_once

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

tags

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

until

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

vars

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

when

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

with_<lookup_plugin>

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