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

Краткое описание
- Требования
Параметры
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Краткое описание

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

Требования

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

python >= 2.6
libvirt-python

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
autostart bool (добавлено в 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.
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. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

Команда разработчиков Ansible
Michael DeHaan
Seth Vidal

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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