ansible-playbook

Синопсис

usage: ansible-playbook [-h] [--version] [-v] [--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]
                     [-k | --connection-password-file CONNECTION_PASSWORD_FILE]
                     [--force-handlers] [--flush-cache] [-b]
                     [--become-method BECOME_METHOD]
                     [--become-user BECOME_USER]
                     [-K | --become-password-file BECOME_PASSWORD_FILE]
                     [-t TAGS] [--skip-tags SKIP_TAGS] [-C] [-D]
                     [-i INVENTORY] [--list-hosts] [-l SUBSET]
                     [-e EXTRA_VARS] [--vault-id VAULT_IDS]
                     [-J | --vault-password-file VAULT_PASSWORD_FILES]
                     [-f FORKS] [-M MODULE_PATH] [--syntax-check]
                     [--list-tasks] [--list-tags] [--step]
                     [--start-at-task START_AT_TASK]
                     playbook [playbook ...]

Описание

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

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

--become-method <BECOME_METHOD>

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

--become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>

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

--become-user <BECOME_USER>

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

--connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>

Файл пароля подключения

--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

выполнять только те play и задачи, теги которых не совпадают с этими значениями. Этот аргумент можно указывать несколько раз.

--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 для использования. Этот аргумент можно указывать несколько раз.

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

файл пароля vault

--version

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

-C, --check

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

-D, --diff

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

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

спросить пароль vault

-K, --ask-become-pass

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

-M, --module-path

добавить двоеточием разделенный путь(и) в библиотеку модулей (по умолчанию {{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }}). Этот аргумент можно указывать несколько раз.

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

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

-b, --become

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

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

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

-e, --extra-vars

установить дополнительные переменные как key=value или YAML/JSON, если имя файла начинается с @. Этот аргумент можно указывать несколько раз.

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

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

-h, --help

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

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

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

-k, --ask-pass

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

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

дальнейшее ограничение выбранных хостов дополнительным шаблоном

-t, --tags

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

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

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

-v, --verbose

Принуждает Ansible выводить больше сообщений отладки. Добавление нескольких -v увеличит детализацию, встроенные плагины в настоящее время обрабатывают до -vvvvvv. Достаточным уровнем для начала является -vvv, отладка соединения может потребовать -vvvv. Этот аргумент можно указывать несколько раз.

Среда

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

ANSIBLE_INVENTORY — Переопределение файла инвентаризации ansible по умолчанию

ANSIBLE_LIBRARY — Переопределение пути библиотеки модулей ansible по умолчанию

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

Множество других доступны для большинства параметров в ansible.cfg

Файлы

/etc/ansible/hosts — Файл инвентаризации по умолчанию

/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-pull(1), ansible-vault(1)