virt - Управление виртуальными машинами, поддерживаемыми libvirt

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
- Статус

Описание

Управление виртуальными машинами, поддерживаемыми libvirt.

Требования (к хосту, на котором выполняется модуль)

python >= 2.6
libvirt-python

Параметры

параметр	обязательный	значение по умолчанию	возможные значения	комментарии
autostart (добавлено в 2.3)	нет		True False	запуск ВМ при запуске хоста
command	нет		create status start stop pause unpause shutdown undefine destroy get_xml freemem list_vms info nodeinfo virttype define	Помимо управления состоянием, доступны различные неидемпотентные команды. См. примеры
name	да			имя управляемой гостевой ВМ. Обратите внимание, что ВМ должна быть предварительно определена с помощью xml.
state	нет	нет	running shutdown destroyed paused	Обратите внимание, что могут быть некоторые задержки при запросах состояния, например, `shutdown`, поскольку они относятся только к состояниям ВМ. После запуска гостя, он может быть недоступен сразу же.
uri	нет	qemu:///system		uri подключения libvirt
xml	нет			XML-документ, используемый с командой define

Примеры

# a playbook task line:
- virt:
    name: alpha
    state: running

# /usr/bin/ansible invocations
# ansible host -m virt -a "name=alpha command=status"
# ansible host -m virt -a "name=alpha command=get_xml"
# ansible host -m virt -a "name=alpha command=create uri=lxc:///"

---
# a playbook example of defining and launching an LXC guest
tasks:
  - name: define vm
    virt:
        name: foo
        command: define
        xml: "{{ lookup('template', 'container-template.xml.j2') }}"
        uri: 'lxc:///'
  - name: start vm
    virt:
        name: foo
        state: running
        uri: 'lxc:///'

Возвращаемые значения

Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:

имя	описание	возвращается	тип	пример
list_vms	Список определенных на удаленной системе ВМ	успех	словарь	['build.example.org', 'dev.example.org']
status	Статус ВМ, среди running, crashed, paused и shutdown	успех	строка	успех

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Для помощи в разработке модулей, если вы заинтересованы, прочитайте Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/virt_module.html