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

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

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

Игра

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

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

См. также

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

collections

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

connection

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

См. также

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

debugger

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

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

gather_subset

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

gather_timeout

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

handlers

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

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

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

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

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

См. также

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

collections

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

connection

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

См. также

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

debugger

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

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

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

vars

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

when

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

Блок

always

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

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

block

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

check_mode

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

См. также

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

collections

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

connection

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

См. также

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

debugger

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

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

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

rescue

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

run_once

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

tags

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

vars

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

when

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

Задача

action

Действие (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

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

См. также

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

collections

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

connection

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

См. также

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

debugger

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

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

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

vars

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

when

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

with_<lookup_plugin>

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