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

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

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

Плей

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

check_mode

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

collections

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

Примечание

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

connection

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

debugger

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

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 выполняет текущий плей на целевом узле плей.

См. также

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

strategy

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

tags

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

tasks

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

throttle

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

timeout

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

vars

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

vars_files

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

vars_prompt

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

Роль

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

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

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

run_once

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

tags

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

throttle

Ограничение количества одновременных запусков задач на уровне задачи, блока и playbook. Это независимо от параметров 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

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

Примечание

Задачи внутри роли не наследуют значение 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

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

rescue

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

run_once

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

tags

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

throttle

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

timeout

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

vars

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

when

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

Задача

action

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

any_errors_fatal

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

args

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

async

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

become

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

become_exe

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

become_flags

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

become_method

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

become_user

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

changed_when

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

check_mode

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

collections

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

Примечание

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

connection

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

debugger

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

failed_when

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

ignore_errors

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

ignore_unreachable

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

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

throttle

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

timeout

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

until

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

vars

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

when

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

with_<lookup_plugin>

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