ansible

Определение и выполнение отдельной задачи «playbook» на наборе хостов

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

Синопсис

usage: ansible [-h] [--version] [-v] [-b] [--become-method BECOME_METHOD]
            [--become-user BECOME_USER] [-K] [-i INVENTORY] [--list-hosts]
            [-l SUBSET] [-P POLL_INTERVAL] [-B SECONDS] [-o] [-t TREE] [-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] [-C] [--syntax-check] [-D]
            [-e EXTRA_VARS] [--vault-id VAULT_IDS]
            [--ask-vault-pass | --vault-password-file VAULT_PASSWORD_FILES]
            [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
            [-a MODULE_ARGS] [-m MODULE_NAME]
            pattern

Описание

является чрезвычайно простым инструментом/фреймворком/API для выполнения «удаленных задач». Эта команда позволяет определить и выполнить одну задачу «playbook» на наборе хостов

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

--ask-vault-pass

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

--become-method <BECOME_METHOD>

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

--become-user <BECOME_USER>

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

--list-hosts

выводит список соответствующих хостов; ничего больше не выполняется

--playbook-dir <BASEDIR>

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

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

--ssh-common-args <SSH_COMMON_ARGS>

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

--ssh-extra-args <SSH_EXTRA_ARGS>

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

--syntax-check

выполнить проверку синтаксиса playbook, но не выполнять его

--vault-id

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

--vault-password-file

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

--version

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

-B <SECONDS>, --background <SECONDS>

выполнение асинхронно, завершение с ошибкой через X секунд (по умолчанию=N/A)

-C, --check

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

-D, --diff

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

-K, --ask-become-pass

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

-M, --module-path

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

-P <POLL_INTERVAL>, --poll <POLL_INTERVAL>

установка интервала опроса при использовании -B (по умолчанию=15)

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

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

-a <MODULE_ARGS>, --args <MODULE_ARGS>

аргументы модуля

-b, --become

выполнение операций с использованием 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>

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

-m <MODULE_NAME>, --module-name <MODULE_NAME>

имя модуля для выполнения (по умолчанию=command)

-o, --one-line

сжатие вывода

-t <TREE>, --tree <TREE>

запись лога в эту директорию

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