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

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

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

Play

always_run

УСТАРЕВШЕЕ, принудительно выполняет задачу даже в режиме проверки. Используйте директиву check_mode вместо этого.

any_errors_fatal

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

become

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

become_flags

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

become_method

Метод эскалации привилегий (например, sudo или su).

become_user

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

check_mode

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

См. также

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

connection

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

См. также

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

debugger

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

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

gather_subset

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

gather_timeout

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

handlers

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

hosts

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

ignore_errors

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

max_fail_percentage

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

name

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

no_log

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

order

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

port

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

post_tasks

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

pre_tasks

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

remote_user

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

roles

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

run_once

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

serial

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

См. также

Размер группы для инкрементального обновления

strategy

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

tags

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

tasks

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

vars

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

vars_files

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

vars_prompt

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

vault_password

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

Роль

always_run

УСТЕРЕЖДЁН, принудительно выполняет задачу даже в режиме проверки. Используйте директиву check_mode вместо неё.

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

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

environment

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

ignore_errors

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

name

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

no_log

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

port

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

remote_user

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

run_once

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

tags

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

vars

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

when

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

Блок

always

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

always_run

УСТЕРЕЖДЁН, принудительно выполняет задачу даже в режиме проверки. Используйте директиву check_mode вместо неё.

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

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

environment

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

ignore_errors

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

name

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

no_log

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

port

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

remote_user

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

rescue

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

run_once

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

tags

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

vars

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

when

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

Задача

action

Выполняемое ‘действие’ для задачи, обычно преобразуется в C(модуль) или плагин действия.

always_run

УСТЕРЕЖДЁННЫЙ, принудительно запускает задачу даже в режиме проверки. Используйте директиву check_mode вместо этого.

any_errors_fatal

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

args

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

async

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

become

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

become_flags

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

become_method

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

become_user

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

changed_when

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

check_mode

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

См. также

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

connection

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

См. также

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

debugger

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

failed_when

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

ignore_errors

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

local_action

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

loop

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

loop_control

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

См. также

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

name

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

no_log

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

notify

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

poll

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

port

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

register

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

remote_user

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

retries

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

run_once

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

tags

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

until

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

vars

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

when

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

with_<lookup_plugin>

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