virt — Управление виртуальными машинами, поддерживаемыми libvirt
Описание
- Управление виртуальными машинами, поддерживаемыми libvirt.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- libvirt-python
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
autostart
(добавлено в 2.3)
|
|
Запуск ВМ при запуске хоста.
|
| command |
|
Помимо управления состоянием, доступны различные неидемпотентные команды.
|
|
name
обязательно
|
имя управляемой гостевой ВМ. Обратите внимание, что ВМ должна быть предварительно определена с помощью xml.
|
|
| state |
|
Обратите внимание, что могут быть некоторые задержки при запросах состояния, такие как
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
словарь
|
success |
Список ВМ, определенных на удаленной системе
Пример:
['build.example.org', 'dev.example.org']
|
|
status
строка
|
success |
Состояние ВМ, среди работающих, аварийных, приостановленных и выключенных
Пример:
success
|
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Команда Ansible Core
- 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.5/modules/virt_module.html