Справочник по Ansible CLI

На этой странице представлены один или несколько примеров использования каждого инструмента командной строки Ansible с добавлением некоторых общих флагов и ссылкой на полную документацию для команды. Эта страница предоставляет быстрое напоминание о некоторых распространённых случаях использования, но она может быть устаревшей или неполной, или тем и другим. Для получения канонической документации следуйте ссылкам на страницы CLI.

ansible-playbook
ansible-galaxy
- Установка коллекций
- Установка ролей
ansible
- Выполнение произвольных команд
ansible-doc

ansible-playbook

ansible-playbook -i /path/to/my_inventory_file -u my_connection_user -k -f 3 -T 30 -t my_tag -M /path/to/my_modules -b -K my_playbook.yml

Loads my_playbook.yml from the current working directory and:

-i - использует my_inventory_file в указанном пути для инвентаризации, чтобы соответствовать шаблону.
-u - подключается по SSH как my_connection_user.
-k - запрашивает пароль, который затем используется для аутентификации SSH.
-f - выделяет 3 вилки.
-T - устанавливает таймаут в 30 секунд.
-t - выполняет только задачи, помеченные меткой тега my_tag.
-M - загружает локальные модули из /path/to/my/modules.
-b - выполняется с повышенными привилегиями (использует become).
-K - запрашивает у пользователя пароль для повышения привилегий.

См. ansible-playbook для подробной документации.

ansible-galaxy

Установка коллекций

Установка одной коллекции:

ansible-galaxy collection install mynamespace.mycollection

Загружает mynamespace.mycollection с конфигурированного сервера Galaxy (galaxy.ansible.com по умолчанию).

Установка списка коллекций:

ansible-galaxy collection install -r requirements.yml

Загружает список коллекций, указанный в файле requirements.yml.

Список всех установленных коллекций:

ansible-galaxy collection list

Установка ролей

Установка роли с именем example.role:

ansible-galaxy role install example.role

# SNIPPED_OUTPUT
- extracting example.role to /home/user/.ansible/roles/example.role
- example.role was installed successfully

Список всех установленных ролей:

ansible-galaxy role list

См. ansible-galaxy для подробной документации.

ansible

Выполнение произвольных команд

Установка пакета

ansible localhost -m ansible.builtin.apt -a "name=apache2 state=present" -b -K

Выполняет ansible localhost на вашей локальной системе. - name=apache2 state=present - устанавливает пакет apache2 на системе на базе Debian. - -b - использует become для выполнения с повышенными привилегиями. - -m - указывает имя модуля. - -K - запрашивает пароль для повышения привилегий.

localhost | SUCCESS => {
"cache_update_time": 1709959287,
"cache_updated": false,
"changed": false
#...

ansible-doc

Показать имена плагинов и файлы их исходных кодов:

ansible-doc -F
#...

Показать доступные плагины:

ansible-doc -t module -l
#...

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/command_guide/cheatsheet.html