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

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

• Игра
• Роль
• Блок
• Задача

Игра

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

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

См. также

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

connection

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

См. также

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

debugger

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

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

gather_subset

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

gather_timeout

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

handlers

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

hosts

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

ignore_errors

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

ignore_unreachable

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

max_fail_percentage

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

module_defaults

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

name

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

no_log

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

order

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

port

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

post_tasks

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

pre_tasks

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

remote_user

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

roles

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

run_once

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

serial

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

См. также

Размер пакета для обновлений

strategy

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

tags

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

tasks

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

vars

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

vars_files

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

vars_prompt

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

Роль

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

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

См. также

Режим проверки («сухое выполнение»)

connection

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

См. также

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

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

ignore_unreachable

Логический параметр, позволяющий игнорировать недоступные узлы и продолжить выполнение. Это не влияет на другие ошибки задач (см. 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

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

ignore_unreachable

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

module_defaults

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

name

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

no_log

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

port

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

remote_user

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

rescue

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

run_once

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

tags

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

vars

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

when

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

Задача

action

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

any_errors_fatal

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

args

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

async

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

become

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

become_flags

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

become_method

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

become_user

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

changed_when

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

check_mode

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

См. также

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

connection

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

См. также

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

debugger

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

failed_when

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

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

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

until

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

vars

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

when

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

with_<lookup_plugin>

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