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

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

Описание

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

Требования

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

python >= 2.6
libvirt-python

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
autostart boolean	Варианты: 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`, так как они относятся только к состояниям ВМ. После запуска гостя, он может быть не сразу доступен. state и command взаимоисключающие, за исключением случая command=list_vms. В этом случае будут перечислены все ВМ в указанном состоянии.
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:///"

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

# setting autostart on a qemu VM (default uri)
- name: set autostart for a VM
  virt:
    name: foo
    autostart: yes

# Defining a VM and making is autostart with host. VM will be off after this task
- name: define vm from xml and set autostart
  virt:
    command: define
    xml: "{{ lookup('template', 'vm_template.xml.j2') }}"
    autostart: yes

# Listing VMs
- name: list all VMs
  virt:
    command: list_vms
  register: all_vms

- name: list only running VMs
  virt:
    command: list_vms
    state: running
  register: running_vms

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

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

Ключ	Возвращаемое значение	Описание
list_vms list	success	Список определенных на удаленной системе ВМ Пример: ['build.example.org', 'dev.example.org']
status string	success	Статус ВМ, включая running, crashed, paused и shutdown Пример: success

Статус

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

Авторы

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

Подсказка

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

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