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

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

• Игровая фаза
• Роль
• Блок
• Задача

Игровая фаза

any_errors_fatal

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

become

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

become_exe

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

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.

throttle

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

vars

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

vars_files

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

vars_prompt

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

Роль

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

Способ повышения привилегий (например, sudo или su).

become_user

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

check_mode

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

См. также

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

collections

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

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

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

run_once

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

tags

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

throttle

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

vars

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

when

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

Блок

always

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

any_errors_fatal

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

become

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

become_exe

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

become_flags

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

become_method

Способ повышения привилегий (например, sudo или su).

become_user

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

block

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

check_mode

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

См. также

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

collections

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

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 хостов.

vars

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

when

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

Задача

action

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

any_errors_fatal

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

args

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

async

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

become

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

become_exe

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

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

Переключатель для возврата информации «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

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

throttle

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

until

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

vars

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

when

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

with_<lookup_plugin>

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