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

Описание
Требования
Параметры
Примеры
Возвращаемые значения
Статус

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
libvirt-python

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
autostart boolean добавлен в 2.3	Варианты: no yes	Запуск ВМ при запуске хоста.
command -	Варианты: create define destroy freemem get_xml info list_vms nodeinfo pause shutdown start status stop undefine unpause virttype	Помимо управления состоянием, доступны различные неидемпотентные команды.
name -		Имя управляемой гостевой ВМ. Обратите внимание, что ВМ должна быть предварительно определена с помощью xml. Этот параметр обязателен, если command не `list_vms`.
state -	Варианты: destroyed paused running shutdown	Обратите внимание, что могут быть некоторые задержки при запросах состояния, такие как `shutdown`, так как они относятся только к состояниям ВМ. После запуска гостя, она может быть недоступна сразу.
uri -	Значение по умолчанию: "qemu:///system"	URI подключения libvirt.
xml -		XML-документ, используемый с командой define. Должен содержать исходный XML-контент, используя `lookup`. XML не может ссылаться на файл.

Примеры

# 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 строка	успех	Состояние ВМ, включая запущенную, аварийную, приостановленную и выключенную. Пример: успех

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Команда разработчиков 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.7/modules/virt_module.html