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

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

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

Игра

accelerate

УСТАРЕЛО, установите в True, чтобы использовать плагин подключения accelerate.

accelerate_ipv6

УСТАРЕЛО, установите в True, чтобы принудительно заставить плагин accelerate использовать ipv6 для подключения.

accelerate_port

УСТАРЕЛО, установите значение для переопределения используемого порта для подключения accelerate.

always_run

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

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

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

См. также

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

connection

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

См. также

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

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

gather_subset

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

gather_timeout

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

handlers

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

hosts

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

ignore_errors

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

max_fail_percentage

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

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

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

vault_password

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

Роль

always_run

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

any_errors_fatal

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

become

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

become_flags

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

become_method

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

become_user

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

check_mode

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

См. также

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

connection

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

См. также

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

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

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

См. также

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

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

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

check_mode

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

См. также

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

connection

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

См. также

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

delay

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

failed_when

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

ignore_errors

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

local_action

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

loop_control

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

См. также

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

name

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

no_log

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

notify

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

poll

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

port

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

register

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

remote_user

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

retries

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

run_once

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

tags

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

until

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

vars

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

when

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

with_<lookup_plugin>

with_ — это способ определения циклов; он может использовать любой доступный плагин поиска для генерации списка элементов