community.general.vmadm – Управление виртуальными машинами и зонами SmartOS.
Примечание
Этот плагин входит в состав коллекции community.general (версия 1.3.2).
Для установки используйте: 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 | Устанавливает ограничение на количество долей ЦП планировщика справедливого распределения (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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/vmadm_module.html
