community.general.vmadm – Управление виртуальными машинами и зонами SmartOS.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в книге задач, укажите: community.general.vmadm.
Обзор
- Управление виртуальными машинами SmartOS через vmadm(1M).
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| archive_on_delete boolean |
| При включенном параметре, набор данных зоны будет смонтирован на /zones/archive при удалении. |
| autoboot boolean |
| Будет ли виртуальная машина запущена при перезагрузке системы. |
| boot string | Установить порядок загрузки для виртуальных машин KVM. | |
| brand string |
| Тип виртуальной машины. Параметр bhyve был добавлен в community.general 0.2.0. |
| cpu_cap integer | Устанавливает ограничение на количество времени использования ЦП виртуальной машиной. Используйте 0 для отсутствия ограничения. | |
| cpu_shares integer | Устанавливает ограничение на количество квот CPU-времени в планировщике с долями (FSS) для виртуальной машины. Это ограничение относительно всех других виртуальных машин в системе. | |
| cpu_type string |
| Управление типом виртуального процессора, предоставляемого виртуальным машинам KVM. |
| customer_metadata dictionary | Метаданные, которые будут установлены и связаны с этой виртуальной машиной, содержащие изменяемые пользователем ключи. | |
| delegate_dataset boolean |
| Выполнять ли делегирование набора данных ZFS виртуальной машине ОС. |
| disk_driver string | Значение по умолчанию для модели виртуального диска для гостевых KVM-систем. | |
| disks list / elements=string | Список дисков для добавления. Допустимые свойства документированы в vmadm(1M). | |
| dns_domain string | Значение домена для /etc/hosts. | |
| docker boolean |
| Для изображений Docker требуется включение этого флага вместе с параметром brand, установленным на lx. |
| filesystems list / elements=string | Монтировать дополнительные файловые системы в виртуальную машину ОС. | |
| firewall_enabled boolean |
| Включает брандмауэр, позволяя применять правила fwadm(1M). |
| force boolean |
| Принудительное выполнение определённого действия (например, остановка или удаление виртуальной машины). |
| fs_allowed string | Список файловых систем, которые разрешено монтировать в этой зоне (через запятую). | |
| hostname string | Имя хоста зоны/виртуальной машины. | |
| image_uuid string | UUID образа. | |
| indestructible_delegated boolean |
| Добавляет @indestructible снимок к делегированным наборам данных. |
| indestructible_zoneroot boolean |
| Добавляет @indestructible снимок к zoneroot. |
| internal_metadata dictionary | Метаданные, которые будут установлены и связаны с этой виртуальной машиной, содержащие ключи, сгенерированные оператором. | |
| internal_metadata_namespace string | Список пространств имён, которые будут установлены как только для internal_metadata; эти пространства имён будут взяты из internal_metadata, а не из customer_metadata. | |
| kernel_version string | Версия ядра для эмуляции для LX виртуальных машин. | |
| limit_priv string | Установить (разделенные запятыми) список привилегий, которые разрешено использовать зоне. | |
| maintain_resolvers boolean |
| Резолверы в /etc/resolv.conf будут обновлены при обновлении свойства resolvers. |
| max_locked_memory integer | Общий объём памяти (в МБ) на хосте, который может быть заблокирован этой виртуальной машиной. | |
| max_lwps integer | Максимальное количество лёгких процессов, которые разрешено запускать этой виртуальной машине. | |
| max_physical_memory integer | Максимальный объём физической памяти (в МБ) на хосте, которую разрешено использовать виртуальной машине. | |
| max_swap integer | Максимальный объём виртуальной памяти (в МБ), которую разрешено использовать виртуальной машине. | |
| mdata_exec_timeout integer | Таймаут в секундах (или 0 для отключения) для сервиса svc:/smartdc/mdata:execute, который выполняет пользовательские скрипты в зоне. | |
| name string | Имя виртуальной машины. vmadm(1M) использует это как необязательное имя. псевдонимы: alias | |
| nic_driver string | Значение по умолчанию для модели виртуального сетевого адаптера для гостевых KVM-систем. | |
| nics list / elements=string | Список сетевых адаптеров для добавления. Допустимые свойства документированы в vmadm(1M). | |
| nowait boolean |
| Считать предоставление завершённым, когда виртуальная машина впервые запускается, а не когда она перезагружается. |
| 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 означает, что зона будет создана, если она ещё не существует, а затем будет остановлена. |
| tmpfs integer | Объём памяти (в МБ), который будет доступен в виртуальной машине для файловой системы /tmp. | |
| uuid string | UUID виртуальной машины. Может быть полным UUID или * для всех виртуальных машин. | |
| vcpus integer | Количество виртуальных процессоров для гостевой KVM-системы. | |
| vga string | Укажите эмуляцию VGA, используемую виртуальными машинами KVM. | |
| virtio_txburst integer | Количество пакетов, которое может быть отправлено за один сброс очереди отправки tx сетевых адаптеров virtio. | |
| virtio_txtimer integer | Таймаут (в наносекундах) для таймера TX сетевых адаптеров virtio. | |
| vnc_password string | Пароль, необходимый для подключения к VNC. По умолчанию пароль не установлен. Обратите внимание, что его можно прочитать из глобальной зоны. | |
| vnc_port integer | TCP-порт для прослушивания сервером VNC. Или задайте 0 для случайного порта, или -1 для отключения. | |
| zfs_data_compression string | Указывает алгоритм сжатия, используемый для набора данных зоны этой виртуальной машины. Этот параметр действует только на делегированные наборы данных. |
| zfs_data_recsize integer | Рекомендуемый размер блока (степень двойки) для файлов в файловой системе делегированной подсистемы данных. | |
| zfs_filesystem_limit integer | Максимальное количество файловых систем, которое может иметь ВМ. | |
| zfs_io_priority integer | Приоритет ограничения ввода-вывода относительно других ВМ. | |
| zfs_root_compression string | Указывает алгоритм сжатия, используемый для корневой подсистемы данных этой ВМ. Этот параметр действует только на подсистему данных zoneroot. | |
| zfs_root_recsize integer | Рекомендуемый размер блока (степень двойки) для файлов в файловой системе корневой подсистемы данных. | |
| zfs_snapshot_limit integer | Количество снимков, которое может иметь ВМ. | |
| zpool string | Пул ZFS, в котором будет создана подсистема данных зоны ВМ. |
Примеры
- name: Create SmartOS zone
community.general.vmadm:
brand: joyent
state: present
alias: fw_zone
image_uuid: 95f265b8-96b2-11e6-9597-972f3af4b6d5
firewall_enabled: yes
indestructible_zoneroot: yes
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 string | При обращении к ВМ по псевдониму. | Псевдоним управляемой ВМ. Пример: dns-zone |
| state string | success | Состояние целевого объекта после выполнения. Пример: running |
| uuid string | всегда | UUID управляемой ВМ. Пример: b217ab0b-cf57-efd8-cd85-958d0b80be33 |
Авторы
- Jasper Lievisse Adriaanse (@jasperla)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/vmadm_module.html
