ansible-console

Синтаксис

usage: ansible-console [-h] [--version] [-v] [-b]
                    [--become-method BECOME_METHOD]
                    [--become-user BECOME_USER]
                    [-K | --become-password-file BECOME_PASSWORD_FILE]
                    [-i INVENTORY] [--list-hosts] [-l SUBSET]
                    [--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]
                    [-C] [-D] [--vault-id VAULT_IDS]
                    [-J | --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 задачи против выбранного инвентаря из удобной оболочки с встроенной автодополнением (на основе dominis’ ansible-shell).

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

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

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

--become-method <BECOME_METHOD>

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

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

Файл пароля для become

--become-user <BECOME_USER>

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

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

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

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

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

--task-timeout <TASK_TIMEOUT>

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

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

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

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

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

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

-v, --verbose

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

АРГУМЕНТЫ

host-pattern

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

Окружение

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

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-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1)