Модуль community.general.vmadm — управление виртуальными машинами и зонами SmartOS

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install community.general.

Чтобы использовать ее в плейбуке, укажите: community.general.vmadm.

Обзор
Параметры
Атрибуты
Примеры
Возвращаемые значения

Обзор

Управление виртуальными машинами SmartOS с помощью vmadm(1M).

Параметры

Параметр	Комментарии
archive_on_delete boolean	Если включено, при удалении набор данных зоны монтируется в `/zones/archive`. Варианты: `false` `true`
autoboot boolean	Определяет, будет ли виртуальная машина загружаться при перезагрузке системы. Варианты: `false` `true`
boot string	Задает порядок загрузки для виртуальных машин KVM.
brand string	Тип виртуальной машины. Параметр `bhyve` добавлен в community.general 0.2.0. Варианты: `"joyent"` ← (по умолчанию) `"joyent-minimal"` `"lx"` `"kvm"` `"bhyve"`
cpu_cap integer	Ограничивает объем процессорного времени, которое может использовать виртуальная машина. Укажите `0`, чтобы не задавать ограничение.
cpu_shares integer	Ограничивает число ресурсов процессора для виртуальной машины в планировщике равноправного разделения (FSS). Это ограничение применяется относительно всех остальных виртуальных машин системы.
cpu_type string	Управляет типом виртуального процессора, предоставляемого виртуальным машинам KVM. Варианты: `"qemu64"` ← (по умолчанию) `"host"`
customer_metadata dictionary	Метаданные, которые будут заданы и связаны с этой виртуальной машиной; они содержат ключи, изменяемые пользователем.
delegate_dataset boolean	Делегировать ли набор данных ZFS виртуальной машине с ОС. Варианты: `false` `true`
disk_driver string	Значение по умолчанию для модели виртуального диска гостевых систем KVM.
disks list / elements=dictionary	Список добавляемых дисков; допустимые свойства описаны в vmadm(1M).
dns_domain string	Значение домена для `/etc/hosts`.
docker boolean	Для образов Docker необходимо включить этот флаг и задать для `brand` значение `lx`. Варианты: `false` `true`
filesystems list / elements=dictionary	Подключает дополнительные файловые системы к виртуальной машине с ОС.
firewall_enabled boolean	Включает брандмауэр, позволяя применять правила fwadm(1M). Варианты: `false` `true`
flexible_disk_size integer добавлено в community.general 10.5.0	Задает верхний предел объема дискового пространства, которое экземпляр bhyve может использовать для дисков и их снимков (в МиБ).
force boolean	Принудительно выполняет указанное действие (то есть остановку или удаление виртуальной машины). Варианты: `false` `true`
fs_allowed string	Список типов файловых систем, разделенных запятыми, которые разрешено монтировать в этой зоне.
hostname string	Имя узла зоны/виртуальной машины.
image_uuid string	UUID образа.
indestructible_delegated boolean	Добавляет снимок `@indestructible` к делегированным наборам данных. Варианты: `false` `true`
indestructible_zoneroot boolean	Добавляет снимок `@indestructible` к корневому набору данных зоны. Варианты: `false` `true`
internal_metadata dictionary	Метаданные, которые будут заданы и связаны с этой виртуальной машиной; они содержат ключи, созданные оператором.
internal_metadata_namespace string	Список пространств имен, которые будут заданы как `internal_metadata-only`; эти пространства имен берутся из `internal_metadata`, а не из `customer_metadata`.
kernel_version string	Версия ядра, эмулируемая для виртуальных машин LX.
limit_priv string	Задает список привилегий, разделенных запятыми, которые разрешено использовать зоне.
maintain_resolvers boolean	Серверы разрешения имен в `/etc/resolv.conf` обновляются при изменении свойства `resolvers`. Варианты: `false` `true`
max_locked_memory integer	Общий объем памяти на узле (в МиБ), который может быть заблокирован этой виртуальной машиной.
max_lwps integer	Максимальное число облегченных процессов, которые могут одновременно выполняться в этой виртуальной машине.
max_physical_memory integer	Максимальный объем памяти на узле (в МиБ), который разрешено использовать виртуальной машине.
max_swap integer	Максимальный объем виртуальной памяти (в МиБ), который разрешено использовать виртуальной машине.
mdata_exec_timeout integer	Тайм-аут в секундах (или 0 для отключения) для службы `svc:/smartdc/mdata:execute`, запускающей пользовательские сценарии в зоне.
name псевдонимы: alias string	Имя виртуальной машины. vmadm(1M) использует его как необязательное имя.
nic_driver string	Значение по умолчанию для модели виртуального сетевого интерфейса гостевых систем KVM.
nics list / elements=dictionary	Список добавляемых сетевых интерфейсов; допустимые свойства описаны в vmadm(1M).
nowait boolean	Считать подготовку завершенной при первом запуске виртуальной машины, а не после ее перезагрузки. Варианты: `false` `true`
owner_uuid string добавлено в community.general 10.5.0	Задает UUID владельца виртуальной машины.
qemu_extra_opts string	Дополнительные аргументы командной строки qemu для гостевых систем KVM.
qemu_opts string	Дополнительные аргументы qemu для гостевых систем KVM. Они заменяют аргументы по умолчанию, заданные vmadm(1M), и должны использоваться только для отладки.
quota integer	Квота файловых систем зоны (в МиБ).
ram integer	Объем виртуальной оперативной памяти для гостевой системы KVM (в МиБ).
resolvers list / elements=string	Список серверов разрешения имен, которые будут записаны в `/etc/resolv.conf`.
routes dictionary	Словарь, сопоставляющий адреса назначения с шлюзами; эти данные задаются в виртуальной машине как статические маршруты.
spice_opts string	Дополнительные параметры для виртуальных машин KVM с поддержкой SPICE.
spice_password string	Пароль, необходимый для подключения по SPICE. По умолчанию пароль не задан. Обратите внимание: пароль можно прочитать из глобальной зоны.
state string	Состояние, в котором должна находиться виртуальная машина. Обратите внимание: операции `present`, `stopped` и `restarted` применяются к уже подготовленной виртуальной машине. Значение `present` означает, что виртуальная машина будет создана, если она отсутствует, и переведена в состояние «запущена». Значение `absent` выключает зону перед ее удалением. Значение `stopped` означает, что зона будет создана, если она еще не существует, а затем выключена. Варианты: `"present"` `"running"` ← (по умолчанию) `"absent"` `"deleted"` `"stopped"` `"created"` `"restarted"` `"rebooted"`
tmpfs integer	Объем памяти (в МиБ), доступный в виртуальной машине для файловой системы `/tmp`.
uuid string	UUID виртуальной машины. Может быть полным UUID или `*` для всех виртуальных машин.
vcpus integer	Количество виртуальных процессоров для гостевой системы KVM.
vga string	Задает эмуляцию VGA, используемую виртуальными машинами KVM.
virtio_txburst integer	Количество пакетов, отправляемых за один сброс очереди передачи сетевых интерфейсов virtio.
virtio_txtimer integer	Тайм-аут таймера передачи сетевых интерфейсов virtio (в наносекундах).
vnc_password string	Пароль, необходимый для подключения по VNC. По умолчанию пароль не задан. Обратите внимание: пароль можно прочитать из глобальной зоны.
vnc_port integer	TCP-порт, на котором прослушивает сервер VNC. Укажите `0` для выбора случайного порта или `-1`, чтобы отключить его.
zfs_data_compression string	Задает алгоритм сжатия для набора данных этой виртуальной машины. Этот параметр действует только для делегированных наборов данных.
zfs_data_recsize integer	Рекомендуемый размер блока (степень числа 2) для файлов в файловой системе делегированного набора данных.
zfs_filesystem_limit integer	Максимальное количество файловых систем, которое может иметь виртуальная машина.
zfs_io_priority integer	Приоритет ограничения операций ввода-вывода относительно других виртуальных машин.
zfs_root_compression string	Задает алгоритм сжатия для корневого набора данных этой виртуальной машины. Этот параметр действует только для набора данных zoneroot.
zfs_root_recsize integer	Рекомендуемый размер блока (степень числа 2) для файлов в файловой системе набора данных zoneroot.
zfs_snapshot_limit integer	Количество снимков, которое может иметь виртуальная машина.
zpool string	Пул ZFS, в котором создается набор данных зоны виртуальной машины.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Create SmartOS zone
  community.general.vmadm:
    brand: joyent
    state: present
    alias: fw_zone
    image_uuid: 95f265b8-96b2-11e6-9597-972f3af4b6d5
    firewall_enabled: true
    indestructible_zoneroot: true
    nics:
      - nic_tag: admin
        ip: dhcp
        primary: true
    internal_metadata:
      root_pw: 'secret'
    quota: 1

- name: Delete a zone
  community.general.vmadm:
    alias: test_zone
    state: deleted

- name: Stop all zones
  community.general.vmadm:
    uuid: '*'
    state: stopped

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

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

Ключ	Описание
alias строка	Псевдоним управляемой виртуальной машины. Возвращается: если виртуальная машина указана по псевдониму. Пример: `"dns-zone"`
state строка	Состояние целевого объекта после выполнения. Возвращается: при успешном выполнении Пример: `"running"`
uuid строка	UUID управляемой виртуальной машины. Возвращается: всегда Пример: `"b217ab0b-cf57-efd8-cd85-958d0b80be33"`

Авторы

Jasper Lievisse Adriaanse (@jasperla)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/vmadm_module.html