Шпаргалка по CLI Ansible

На этой странице приведены один или несколько примеров использования каждой утилиты командной строки 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/command_guide/cheatsheet.html