ansible-playbook

Выполняет Ansible playbook, выполняя определённые задачи на целевых хостах.

• Описание
• Описание
• Общие параметры
• Окружение
• Файлы
• Автор
• Лицензия
• См. также

Описание

usage: ansible-playbook [-h] [--version] [-v] [-k]
                     [--private-key PRIVATE_KEY_FILE] [-u REMOTE_USER]
                     [-c CONNECTION] [-T TIMEOUT]
                     [--ssh-common-args SSH_COMMON_ARGS]
                     [--sftp-extra-args SFTP_EXTRA_ARGS]
                     [--scp-extra-args SCP_EXTRA_ARGS]
                     [--ssh-extra-args SSH_EXTRA_ARGS] [--force-handlers]
                     [--flush-cache] [-b] [--become-method BECOME_METHOD]
                     [--become-user BECOME_USER] [-K] [-t TAGS]
                     [--skip-tags SKIP_TAGS] [-C] [--syntax-check] [-D]
                     [-i INVENTORY] [--list-hosts] [-l SUBSET]
                     [-e EXTRA_VARS] [--vault-id VAULT_IDS]
                     [--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
                     [-f FORKS] [-M MODULE_PATH] [--list-tasks]
                     [--list-tags] [--step] [--start-at-task START_AT_TASK]
                     playbook [playbook ...]

Описание

Инструмент для выполнения Ansible playbook, представляющий собой систему конфигурации и многоузлового развертывания. Дополнительную информацию можно найти на домашней странице проекта (https://docs.ansible.com).

Общие параметры

--ask-vault-password, --ask-vault-pass

Запрос пароля хранилища

--become-method <BECOME_METHOD>

Метод повышения привилегий (по умолчанию sudo), используйте ansible-doc -t become -l для отображения допустимых вариантов.

--become-user <BECOME_USER>

Выполнять операции от имени этого пользователя (по умолчанию root)

--flush-cache

Очистить кэш фактов для каждого хоста в инвентаризации

--force-handlers

Выполнить обработчики даже при сбое задачи

--list-hosts

Выводит список сопоставленных хостов; не выполняет никаких других действий

--list-tags

Список всех доступных тегов

--list-tasks

Список всех задач, которые будут выполнены

--private-key <PRIVATE_KEY_FILE>, --key-file <PRIVATE_KEY_FILE>

Использовать этот файл для аутентификации подключения

--scp-extra-args <SCP_EXTRA_ARGS>

Укажите дополнительные аргументы для передачи только в scp (например, -l)

--sftp-extra-args <SFTP_EXTRA_ARGS>

Укажите дополнительные аргументы для передачи только в sftp (например, -f, -l)

--skip-tags

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

--ssh-common-args <SSH_COMMON_ARGS>

Укажите общие аргументы для передачи в sftp/scp/ssh (например, ProxyCommand)

--ssh-extra-args <SSH_EXTRA_ARGS>

Укажите дополнительные аргументы для передачи только в ssh (например, -R)

--start-at-task <START_AT_TASK>

Начать playbook с задачи с этим именем

--step

Пошаговый режим: подтверждать каждую задачу перед выполнением

--syntax-check

Проверка синтаксиса playbook без его выполнения

--vault-id

Идентификатор хранилища для использования

--vault-password-file, --vault-pass-file

Файл пароля хранилища

--version

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

-C, --check

Не вносить изменений, а вместо этого предсказать возможные изменения

-D, --diff

При изменении (небольших) файлов и шаблонов отображать отличия в этих файлах; прекрасно работает с –check

-K, --ask-become-pass

Запрос пароля повышения привилегий

-M, --module-path

Добавить в путь библиотеки модулей двоеточием разделенные пути (по умолчанию ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)

-T <TIMEOUT>, --timeout <TIMEOUT>

Переопределить таймаут подключения в секундах (по умолчанию 10)

-b, --become

Выполнять операции с повышением привилегий (не подразумевает запроса пароля)

-c <CONNECTION>, --connection <CONNECTION>

Тип подключения для использования (по умолчанию smart)

-e, --extra-vars

Установить дополнительные переменные в виде ключ=значение или YAML/JSON, если имя файла начинается с @

-f <FORKS>, --forks <FORKS>

Указать количество параллельных процессов (по умолчанию 5)

-h, --help

Показать это сообщение справки и выйти

-i, --inventory, --inventory-file

Указать путь к файлу инвентаризации или список хостов через запятую. –inventory-file устарел

-k, --ask-pass

Запрос пароля подключения

-l <SUBSET>, --limit <SUBSET>

Дополнительное ограничение выбранных хостов с помощью шаблона

-t, --tags

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

-u <REMOTE_USER>, --user <REMOTE_USER>

Подключиться как этому пользователю (по умолчанию None)

-v, --verbose

Режим подробных сообщений (-vvv для большего количества, -vvvv для включения отладки подключения)

Окружение

Могут быть указаны следующие переменные окружения.

ANSIBLE_CONFIG – Переопределить файл конфигурации ansible по умолчанию

Доступно гораздо больше параметров для большинства опций в ansible.cfg

Файлы

/etc/ansible/ansible.cfg – Файл конфигурации, используется при наличии

~/.ansible.cfg – Пользовательский файл конфигурации, переопределяет конфигурацию по умолчанию, если он присутствует

Автор

Ansible изначально был написан Майклом ДеХааном.

См. файл AUTHORS для полного списка авторов.

Лицензия

Ansible распространяется на условиях лицензии GPLv3+.

См. также

ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1),