ansible-console

Консоль REPL для выполнения задач Ansible.

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

Синопсис

usage: ansible-console [-h] [--version] [-v] [-b]
                    [--become-method BECOME_METHOD]
                    [--become-user BECOME_USER] [-K] [-i INVENTORY]
                    [--list-hosts] [-l SUBSET] [-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] [--vault-id VAULT_IDS]
                    [--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
                    [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
                    [-e EXTRA_VARS] [--task-timeout TASK_TIMEOUT] [--step]
                    [pattern]

Описание

REPL, позволяющий запускать задачи ad-hoc для выбранного инвентаря из удобной оболочки с встроенной автозавершением (на основе ansible-shell от dominis).

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

• cd [pattern]: изменение хоста/группы (можно использовать шаблоны хостов, например: app*.dc*:!app01*)
• list: вывод списка доступных хостов в текущем каталоге
• list groups: вывод списка групп, включенных в текущий каталог
• become: переключение флага become
• !: принудительно использовать модуль shell вместо модуля ansible (!yum update -y)
• verbosity [num]: установка уровня подробности вывода
• forks [num]: установка количества вилок (forks)
• become_user [user]: установка become_user
• remote_user [user]: установка remote_user
• become_method [method]: установка метода повышения привилегий
• check [bool]: переключение режима проверки (check mode)
• diff [bool]: переключение режима отображения различий (diff mode)
• timeout [integer]: установка таймаута задач в секундах (0 для отключения)
• help [command/module]: отображение документации для команды или модуля
• exit: выход из ansible-console

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

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

запрос пароля для vault

--become-method <BECOME_METHOD>

используемый метод повышения привилегий (по умолчанию sudo), используйте 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)

--step

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

--syntax-check

проверка синтаксиса playbook, но не выполнение

--task-timeout <TASK_TIMEOUT>

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

--vault-id

используемый идентификатор vault

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

файл пароля vault

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

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

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

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