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]
                    [--flush-cache] [--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, позволяющая выполнять разовые задачи для выбранного инвентаря из удобной оболочки со встроенным автодополнением команд клавишей табуляции (основана на ansible-shell dominis).

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

• cd [pattern]: изменить хост/группу (можно использовать шаблоны хостов, например: app*.dc*:!app01*)
• list: вывести список доступных хостов в текущем пути
• list groups: вывести список групп, включённых в текущий путь
• become: переключить флаг повышения привилегий
• !: использовать модуль shell вместо модуля ansible (!yum update -y)
• verbosity [num]: задать уровень подробности вывода
• forks [num]: задать количество процессов-потомков
• become_user [user]: задать пользователя, от имени которого выполняется повышение привилегий
• remote_user [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-user <BECOME_USER>

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

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

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

--flush-cache

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

--list-hosts

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

--playbook-dir <BASEDIR>

Этот инструмент не использует плейбуки, поэтому данный параметр задаёт каталог плейбуков в качестве замены. Он определяет относительный путь для многих функций, включая 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

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

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

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

-e, --extra-vars

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

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

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

-h, --help

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

-i, --inventory, --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

Имя группы в инвентаре, шаблон в стиле glob для выбора хостов в инвентаре или любая комбинация этих вариантов, разделённых запятыми.

Переменные окружения

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

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)