модуль vmware.vmware_rest.vcenter_vm – Создает виртуальную машину.

bios_uuid

string

128-битный UUID SMBIOS виртуальной машины, представленный в виде шестнадцатеричной строки в формате «12345678-abcd-1234-cdef-123456789abc».

Если не задано, значение будет сгенерировано.

boot

dictionary

Конфигурация загрузки.

Если не задано, будут использоваться значения по умолчанию, специфичные для гостевой системы.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы микропрограммного обеспечения для виртуальной машины. ([‘present’])

- Допустимые значения:

- BIOS

- EFI

- efi_legacy_boot (bool): флаг, указывающий, следует ли использовать режим устаревшей загрузки EFI.

Если не задано, по умолчанию используется значение, рекомендуемое для гостевой ОС и поддерживаемое версией виртуального оборудования. ([‘present’])

- network_protocol (str): этот параметр определяет допустимые протоколы сетевой загрузки, поддерживаемые при загрузке виртуальной машины с микропрограммным обеспечением EFI по сети. ([‘present’])

- Допустимые значения:

- IPV4

- IPV6

- delay (int): задержка в миллисекундах перед началом процесса загрузки микропрограммного обеспечения при включении виртуальной машины. Эту задержку можно использовать, чтобы предоставить пользователям время для подключения к консоли виртуальной машины и входа в режим настройки BIOS.

Если не задано, значение по умолчанию — 0. ([‘present’])

- retry (bool): флаг, указывающий, должна ли виртуальная машина автоматически повторять процесс загрузки после сбоя.

Если не задано, значение по умолчанию — false. ([‘present’])

- retry_delay (int): задержка в миллисекундах перед повторной попыткой загрузки после сбоя; применяется только, если retry равно true.

Если не задано, значение по умолчанию — 10000. ([‘present’])

- enter_setup_mode (bool): флаг, указывающий, должен ли процесс загрузки микропрограммного обеспечения автоматически перейти в режим настройки при следующей загрузке виртуальной машины. Обратите внимание: после перехода виртуальной машины в режим настройки этому флагу автоматически присваивается значение false.

Если не задано, значение не изменяется. ([‘present’])

boot_devices

list / elements=dictionary

Конфигурация загрузочных устройств.

Если не задано, будет использоваться последовательность загрузки, специфичная для сервера.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы устройств, которые можно использовать в качестве загрузочных. ([‘present’])

Этот ключ обязателен при [‘present’].

- Допустимые значения:

- CDROM

- DISK

- ETHERNET

- FLOPPY

cdroms

list / elements=dictionary

Список CD-ROM-устройств.

Если не задано, устройства CD-ROM созданы не будут.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы адаптеров хост-шины, которые можно использовать для подключения CD-ROM к виртуальной машине. ([‘present’])

- Допустимые значения:

- IDE

- SATA

- ide (dict): адрес для подключения устройства к виртуальному адаптеру IDE.

Если не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- primary (boolean): флаг, указывающий, следует ли подключить устройство к первичному или вторичному адаптеру IDE виртуальной машины.

Если не задано, сервер выберет адаптер со свободным подключением. Если свободных подключений IDE нет, запрос будет отклонен.

- master (boolean): флаг, указывающий, должно ли устройство быть ведущим или ведомым на адаптере IDE.

Если не задано, сервер выберет доступный тип подключения. Если свободных подключений IDE нет, запрос будет отклонен.

- sata (dict): адрес для подключения устройства к виртуальному адаптеру SATA.

Если не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- bus (integer): номер шины адаптера, к которому следует подключить устройство.

- unit (integer): номер устройства.

Если не задано, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен.

- backing (dict): физический ресурс, используемый виртуальным устройством CD-ROM.

Если не задано, по умолчанию автоматически определяется подходящее устройство хоста. ([‘present’])

- Допустимые ключи:

- type (string): этот параметр определяет допустимые типы ресурсов для виртуального устройства CD-ROM.

Допустимые значения этого поля:

- CLIENT_DEVICE

- HOST_DEVICE

- ISO_FILE

- iso_file (string): путь к файлу образа, используемому в качестве ресурса виртуального устройства CD-ROM.

Это поле необязательное и имеет значение только тогда, когда значение type равно ISO_FILE.

- host_device (string): имя устройства, используемого в качестве ресурса виртуального устройства CD-ROM.

Если не задано, виртуальное устройство CD-ROM будет настроено на автоматическое обнаружение подходящего устройства хоста.

- device_access_type (string): этот параметр определяет допустимые типы доступа к устройству для физического ресурса виртуального устройства CD-ROM.

Допустимые значения этого поля:

- EMULATION

- PASSTHRU

- PASSTHRU_EXCLUSIVE

- start_connected (bool): флаг, указывающий, должно ли виртуальное устройство подключаться при каждом включении виртуальной машины.

Если не задано, по умолчанию используется значение false. ([‘present’])

- allow_guest_control (bool): флаг, указывающий, может ли гостевая система подключать и отключать устройство.

Если не задано, по умолчанию используется значение false. ([‘present’])

cpu

dictionary

Конфигурация ЦП.

Если не задано, будут использоваться значения по умолчанию, специфичные для гостевой системы.

Допустимые атрибуты:

- count (int): новое количество ядер ЦП. Количество ядер ЦП в виртуальной машине должно быть кратно количеству ядер на сокет.

Допустимый диапазон количества ЦП ограничен настроенной гостевой операционной системой и версией виртуального оборудования виртуальной машины.

Если виртуальная машина запущена, количество ядер ЦП можно увеличить, только если hot_add_enabled равно true, и уменьшить, только если hot_remove_enabled равно true.

Если не задано, значение не изменяется. ([‘present’])

- cores_per_socket (int): новое количество ядер ЦП на сокет. Количество ядер ЦП в виртуальной машине должно быть кратно количеству ядер на сокет.

Если не задано, значение не изменяется. ([‘present’])

- hot_add_enabled (bool): флаг, указывающий, разрешено ли добавление ЦП во время работы виртуальной машины.

Это поле можно изменять, только если виртуальная машина выключена.

Если не задано, значение не изменяется. ([‘present’])

- hot_remove_enabled (bool): флаг, указывающий, разрешено ли удаление ЦП во время работы виртуальной машины.

Это поле можно изменять, только если виртуальная машина выключена.

Если не задано, значение не изменяется. ([‘present’])

datastore

string

Идентификатор хранилища данных, в котором хранится состояние конфигурации виртуальной машины.

Если не задано, параметр path также должен быть не задан, а параметр datastore_path должен быть задан.

При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификатор ресурса, возвращаемого vmware.vmware_rest.vcenter_datastore_info.

datastore_path

string

Путь к хранилищу данных для файла конфигурации виртуальной машины в формате «[имя хранилища данных] путь». Например: «[storage1] Test-VM/Test-VM.vmx».

Если не задано, должны быть заданы оба параметра: datastore и path.

disconnect_all_nics

boolean

Указывает, следует ли отключить все сетевые адаптеры целевой виртуальной машины от сети

Если не задано, состояние подключения всех сетевых адаптеров целевой виртуальной машины будет таким же, как у исходной виртуальной машины.

Варианты:

• false
• true

disks

list / elements=dictionary

Карта переноса отдельных дисков.

Если не задано, все диски будут перенесены в хранилище данных, указанное в поле datastore для

При передаче клиентами значения этой структуры в качестве параметра ключ в карте полей должен содержать идентификатор ресурса, возвращаемого vmware.vmware_rest.vcenter_vm_hardware_disk.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы адаптеров хост-шины, которые можно использовать для подключения виртуального устройства хранения к виртуальной машине. ([‘present’])

- Допустимые значения:

- IDE

- NVME

- SATA

- SCSI

- ide (dict): адрес для подключения устройства к виртуальному адаптеру IDE.

Если не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- primary (boolean): флаг, указывающий, следует ли подключить устройство к первичному или вторичному адаптеру IDE виртуальной машины.

Если не задано, сервер выберет адаптер со свободным подключением. Если свободных подключений IDE нет, запрос будет отклонен.

- master (boolean): флаг, указывающий, должно ли устройство быть ведущим или ведомым на адаптере IDE.

Если не задано, сервер выберет доступный тип подключения. Если свободных подключений IDE нет, запрос будет отклонен.

- scsi (dict): адрес для подключения устройства к виртуальному адаптеру SCSI.

Если не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- bus (integer): номер шины адаптера, к которому следует подключить устройство.

- unit (integer): номер устройства.

Если не задано, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен.

- sata (dict): адрес для подключения устройства к виртуальному адаптеру SATA.

Если не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- bus (integer): номер шины адаптера, к которому следует подключить устройство.

- unit (integer): номер устройства.

Если не задано, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен.

- nvme (dict): адрес для подключения устройства к виртуальному адаптеру NVMe.

Если не задано, сервер выберет доступный адрес; если доступных адресов нет, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- bus (integer): номер шины адаптера, к которому следует подключить устройство.

- unit (integer): номер устройства.

Если не задано, сервер выберет доступный номер устройства на указанном адаптере. Если на адаптере нет свободных подключений, запрос будет отклонен.

- backing (dict): существующий физический ресурс виртуального диска. Необходимо указать ровно один из параметров: backing или new_vmdk.

Если не задано, виртуальный диск не будет подключен к существующему ресурсу. ([‘present’])

- Допустимые ключи:

- type (string): этот параметр определяет допустимые типы ресурсов для виртуального диска.

Допустимое значение этого поля:

- VMDK_FILE

- vmdk_file (string): путь к файлу VMDK, используемому виртуальным диском.

Это поле необязательное и имеет значение только тогда, когда значение type равно VMDK_FILE.

- new_vmdk (dict): параметры создания нового ресурса VMDK для виртуального диска. Необходимо указать ровно один из параметров: backing или new_vmdk.

Если не задано, новый ресурс VMDK создан не будет. ([‘present’])

- Допустимые ключи:

- name (string): базовое имя файла VMDK. Имя не должно содержать расширение файла «.vmdk».

Если не задано, сервер выберет имя (на основе имени виртуальной машины).

- capacity (integer): емкость ресурса виртуального диска в байтах.

Если не задано, используется емкость по умолчанию, специфичная для гостевой системы.

- storage_policy (object): структура storage_policy_spec содержит сведения о политике хранения, которая будет связана с файлом VMDK.

Если не задано, применяется политика хранения по умолчанию для целевого хранилища данных (если применимо). В настоящее время политика хранения по умолчанию поддерживается только для хранилищ данных на основе объектов: VVol и vSAN. Для хранилищ данных, не основанных на объектах, если параметр не задан, с файлом VMDK не будет связана никакая политика хранения.

disks_to_remove

list / elements=string

Набор дисков для удаления.

Если не задано, будут скопированы все диски. Если тот же идентификатор указан в disks_to_update, будет возвращена ошибка InvalidArgument.

При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификатор ресурса, возвращаемого vmware.vmware_rest.vcenter_vm_hardware_disk.

disks_to_update

dictionary

Карта дисков для обновления.

Если не задано, все диски будут скопированы в хранилище данных, указанное в поле datastore для. Если тот же идентификатор указан в disks_to_remove, будет выдана ошибка InvalidArgument.

При передаче клиентами значения этой структуры в качестве параметра ключ в карте полей должен содержать идентификатор ресурса, возвращаемого vmware.vmware_rest.vcenter_vm_hardware_disk.

floppies

list / elements=dictionary

Список дисководов гибких дисков.

Если не задано, дисководы гибких дисков созданы не будут.

Допустимые атрибуты:

- backing (dict): физический ресурс виртуального дисковода гибких дисков.

Если не задано, по умолчанию автоматически определяется подходящее устройство хоста. ([‘present’])

- Допустимые ключи:

- type (string): этот параметр определяет допустимые типы ресурсов для виртуального дисковода гибких дисков.

Допустимые значения этого поля:

- CLIENT_DEVICE

- HOST_DEVICE

- IMAGE_FILE

- image_file (string): путь к файлу образа, используемому в качестве ресурса виртуального дисковода гибких дисков.

Это поле необязательное и имеет значение только тогда, когда значение type равно IMAGE_FILE.

- host_device (string): имя устройства, используемого в качестве ресурса виртуального дисковода гибких дисков.

Если не задано, виртуальный дисковод гибких дисков будет настроен на автоматическое обнаружение подходящего устройства хоста.

- start_connected (bool): флаг, указывающий, должно ли виртуальное устройство подключаться при каждом включении виртуальной машины.

Если не задано, по умолчанию используется значение false. ([‘present’])

- allow_guest_control (bool): флаг, указывающий, может ли гостевая система подключать и отключать устройство.

Если не задано, по умолчанию используется значение false. ([‘present’])

guest_customization_spec

dictionary

Спецификация настройки гостевой системы, применяемая к виртуальной машине после ее развертывания.

Если не задано, гостевая операционная система не настраивается после клонирования.

Допустимые атрибуты:

- name (str): имя спецификации настройки.

Если не задано, настройка гостевой системы не выполняется. ([‘clone’])

guest_OS

string

Перечисляемый тип GuestOS определяет допустимые типы гостевых операционных систем, используемые при настройке виртуальной машины. Обязателен при state=[‘present’]

Варианты:

• "ALMALINUX_64"
• "AMAZONLINUX2_64"
• "AMAZONLINUX3_64"
• "ASIANUX_3"
• "ASIANUX_3_64"
• "ASIANUX_4"
• "ASIANUX_4_64"
• "ASIANUX_5_64"
• "ASIANUX_7_64"
• "ASIANUX_8_64"
• "ASIANUX_9_64"
• "CENTOS"
• "CENTOS_6"
• "CENTOS_64"
• "CENTOS_6_64"
• "CENTOS_7"
• "CENTOS_7_64"
• "CENTOS_8_64"
• "CENTOS_9_64"
• "COREOS_64"
• "CRXPOD_1"
• "DARWIN"
• "DARWIN_10"
• "DARWIN_10_64"
• "DARWIN_11"
• "DARWIN_11_64"
• "DARWIN_12_64"
• "DARWIN_13_64"
• "DARWIN_14_64"
• "DARWIN_15_64"
• "DARWIN_16_64"
• "DARWIN_17_64"
• "DARWIN_18_64"
• "DARWIN_19_64"
• "DARWIN_20_64"
• "DARWIN_21_64"
• "DARWIN_22_64"
• "DARWIN_23_64"
• "DARWIN_64"
• "DEBIAN_10"
• "DEBIAN_10_64"
• "DEBIAN_11"
• "DEBIAN_11_64"
• "DEBIAN_12"
• "DEBIAN_12_64"
• "DEBIAN_4"
• "DEBIAN_4_64"
• "DEBIAN_5"
• "DEBIAN_5_64"
• "DEBIAN_6"
• "DEBIAN_6_64"
• "DEBIAN_7"
• "DEBIAN_7_64"
• "DEBIAN_8"
• "DEBIAN_8_64"
• "DEBIAN_9"
• "DEBIAN_9_64"
• "DOS"
• "ECOMSTATION"
• "ECOMSTATION_2"
• "FEDORA"
• "FEDORA_64"
• "FREEBSD"
• "FREEBSD_11"
• "FREEBSD_11_64"
• "FREEBSD_12"
• "FREEBSD_12_64"
• "FREEBSD_13"
• "FREEBSD_13_64"
• "FREEBSD_14"
• "FREEBSD_14_64"
• "FREEBSD_64"
• "GENERIC_LINUX"
• "MANDRAKE"
• "MANDRIVA"
• "MANDRIVA_64"
• "NETWARE_4"
• "NETWARE_5"
• "NETWARE_6"
• "NLD_9"
• "OES"
• "OPENSERVER_5"
• "OPENSERVER_6"
• "OPENSUSE"
• "OPENSUSE_64"
• "ORACLE_LINUX"
• "ORACLE_LINUX_6"
• "ORACLE_LINUX_64"
• "ORACLE_LINUX_6_64"
• "ORACLE_LINUX_7"
• "ORACLE_LINUX_7_64"
• "ORACLE_LINUX_8_64"
• "ORACLE_LINUX_9_64"
• "OS2"
• "OTHER"
• "OTHER_24X_LINUX"
• "OTHER_24X_LINUX_64"
• "OTHER_26X_LINUX"
• "OTHER_26X_LINUX_64"
• "OTHER_3X_LINUX"
• "OTHER_3X_LINUX_64"
• "OTHER_4X_LINUX"
• "OTHER_4X_LINUX_64"
• "OTHER_5X_LINUX"
• "OTHER_5X_LINUX_64"
• "OTHER_64"
• "OTHER_6X_LINUX"
• "OTHER_6X_LINUX_64"
• "OTHER_LINUX"
• "OTHER_LINUX_64"
• "REDHAT"
• "RHEL_2"
• "RHEL_3"
• "RHEL_3_64"
• "RHEL_4"
• "RHEL_4_64"
• "RHEL_5"
• "RHEL_5_64"
• "RHEL_6"
• "RHEL_6_64"
• "RHEL_7"
• "RHEL_7_64"
• "RHEL_8_64"
• "RHEL_9_64"
• "ROCKYLINUX_64"
• "SJDS"
• "SLES"
• "SLES_10"
• "SLES_10_64"
• "SLES_11"
• "SLES_11_64"
• "SLES_12"
• "SLES_12_64"
• "SLES_15_64"
• "SLES_16_64"
• "SLES_64"
• "SOLARIS_10"
• "SOLARIS_10_64"
• "SOLARIS_11_64"
• "SOLARIS_6"
• "SOLARIS_7"
• "SOLARIS_8"
• "SOLARIS_9"
• "SUSE"
• "SUSE_64"
• "TURBO_LINUX"
• "TURBO_LINUX_64"
• "UBUNTU"
• "UBUNTU_64"
• "UNIXWARE_7"
• "VMKERNEL"
• "VMKERNEL_5"
• "VMKERNEL_6"
• "VMKERNEL_65"
• "VMKERNEL_7"
• "VMKERNEL_8"
• "VMWARE_PHOTON_64"
• "WINDOWS_11_64"
• "WINDOWS_12_64"
• "WINDOWS_7"
• "WINDOWS_7_64"
• "WINDOWS_7_SERVER_64"
• "WINDOWS_8"
• "WINDOWS_8_64"
• "WINDOWS_8_SERVER_64"
• "WINDOWS_9"
• "WINDOWS_9_64"
• "WINDOWS_9_SERVER_64"
• "WINDOWS_HYPERV"
• "WINDOWS_SERVER_2019"
• "WINDOWS_SERVER_2021"
• "WINDOWS_SERVER_2025"
• "WIN_2000_ADV_SERV"
• "WIN_2000_PRO"
• "WIN_2000_SERV"
• "WIN_31"
• "WIN_95"
• "WIN_98"
• "WIN_LONGHORN"
• "WIN_LONGHORN_64"
• "WIN_ME"
• "WIN_NET_BUSINESS"
• "WIN_NET_DATACENTER"
• "WIN_NET_DATACENTER_64"
• "WIN_NET_ENTERPRISE"
• "WIN_NET_ENTERPRISE_64"
• "WIN_NET_STANDARD"
• "WIN_NET_STANDARD_64"
• "WIN_NET_WEB"
• "WIN_NT"
• "WIN_VISTA"
• "WIN_VISTA_64"
• "WIN_XP_HOME"
• "WIN_XP_PRO"
• "WIN_XP_PRO_64"

hardware_version

string

Перечисляемый тип version определяет допустимые версии виртуального оборудования для виртуальной машины. См. https://kb.vmware.com/s/article/1003746 (Версии оборудования виртуальных машин (1003746)).

Варианты:

• "VMX_03"
• "VMX_04"
• "VMX_06"
• "VMX_07"
• "VMX_08"
• "VMX_09"
• "VMX_10"
• "VMX_11"
• "VMX_12"
• "VMX_13"
• "VMX_14"
• "VMX_15"
• "VMX_16"
• "VMX_17"
• "VMX_18"
• "VMX_19"
• "VMX_20"
• "VMX_21"

memory

dictionary

Конфигурация памяти.

Если не задано, будут использоваться значения по умолчанию, специфичные для гостевой системы.

Допустимые атрибуты:

- size_MiB (int): новый размер памяти в мебибайтах.

Допустимый диапазон размеров памяти ограничен настроенной гостевой операционной системой и версией виртуального оборудования виртуальной машины.

Если виртуальная машина запущена, это значение можно изменить, только если hot_add_enabled равно true, а новый размер памяти должен соответствовать ограничениям, заданным параметром hot_add_increment_size_mib и

Если не задано, значение не изменяется. ([‘present’])

- hot_add_enabled (bool): флаг, указывающий, следует ли разрешить добавление памяти во время работы виртуальной машины.

Некоторые гостевые операционные системы могут потреблять больше ресурсов или работать менее эффективно при запуске на оборудовании, поддерживающем добавление памяти во время работы машины.

Это поле можно изменять, только если виртуальная машина выключена.

Если не задано, значение не изменяется. ([‘present’])

name

string

Имя виртуальной машины.

Если не задано, будет использовано отображаемое имя из файла конфигурации виртуальной машины.

nics

list / elements=dictionary

Список Ethernet-адаптеров.

Если не задано, Ethernet-адаптеры создаваться не будут.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы эмуляции виртуального Ethernet-адаптера. ([‘present’])

- Допустимые значения:

- E1000

- E1000E

- PCNET32

- VMXNET

- VMXNET2

- VMXNET3

- upt_compatibility_enabled (bool): флаг, указывающий, включена ли совместимость Universal Pass-Through (UPT) для этого виртуального Ethernet-адаптера.

Если не задано, UPT не будет включен для вновь созданного виртуального Ethernet-адаптера. ([‘present’])

- mac_type (str): этот параметр определяет допустимые источники MAC-адреса для виртуального Ethernet-адаптера. ([‘present’])

- Допустимые значения:

- ASSIGNED

- GENERATED

- MANUAL

- mac_address (str): MAC-адрес.

Обходной путь для PR1459647 ([‘present’])

- pci_slot_number (int): адрес виртуального Ethernet-адаптера на шине PCI. Если адрес PCI недопустим, сервер изменит его при запуске виртуальной машины или горячем добавлении устройства.

Если не задано, сервер выберет доступный адрес при включении виртуальной машины. ([‘present’])

- wake_on_lan_enabled (bool): флаг, указывающий, включена ли функция Wake-on-LAN для этого виртуального Ethernet-адаптера.

Если не задано, по умолчанию используется значение false. ([‘present’])

- backing (dict): физический ресурс, обеспечивающий работу виртуального Ethernet-адаптера.

Если не задано, система может попытаться найти подходящий ресурс. Если подходящий ресурс не найден, запрос завершится ошибкой. ([‘present’])

- Допустимые ключи:

- type (string): этот параметр определяет допустимые типы ресурсов, обеспечивающих работу виртуального Ethernet-адаптера.

Допустимые значения для этого поля:

- DISTRIBUTED_PORTGROUP

- HOST_DEVICE

- OPAQUE_NETWORK

- STANDARD_PORTGROUP

- network (string): идентификатор сети, обеспечивающей работу виртуального Ethernet-адаптера.

Это поле необязательное и имеет значение, только если type равен STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP или OPAQUE_NETWORK.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_network_info.

- distributed_port (string): ключ распределенного виртуального порта, обеспечивающего работу виртуального Ethernet-адаптера. В зависимости от типа Portgroup порт можно указать с помощью этого поля. Если тип Portgroup — early-binding (также называемый static), порт назначается при настройке Ethernet-адаптера для его использования. Порт может быть назначен автоматически или явно, в зависимости от значения этого поля. Если тип Portgroup — ephemeral, порт создается и назначается виртуальной машине при ее включении и подключении Ethernet-адаптера. Это поле нельзя указать, поскольку до использования свободных портов не существует.

Можно использовать для указания порта, если сеть, заданная в поле network, является статической или early-binding распределенной Portgroup. Если не задано, порт будет автоматически назначен Ethernet-адаптеру согласно политике, определяемой типом Portgroup.

- start_connected (bool): флаг, указывающий, должно ли виртуальное устройство подключаться при каждом включении виртуальной машины.

Если не задано, по умолчанию используется значение false. ([‘present’])

- allow_guest_control (bool): флаг, указывающий, может ли гостевая система подключать и отключать устройство.

Если не задано, по умолчанию используется значение false. ([‘present’])

nics_to_update

dictionary

Сопоставление сетевых адаптеров для обновления.

Если не задано, сетевые адаптеры обновляться не будут.

Если клиент передает значение этой структуры в качестве параметра, ключ в карте полей должен быть идентификатором ресурса, возвращенного методом vmware.vmware_rest.vcenter_vm_hardware_ethernet.

nvme_adapters

list / elements=dictionary

Список адаптеров NVMe.

Если не задано, будут созданы все адаптеры, необходимые для подключения устройств хранения виртуальной машины; сюда входят устройства, для которых явно указан адаптер шины NVMe, а также устройства, для которых адаптер шины не указан, если предпочтительный тип адаптера гостевой системы — NVMe.

Допустимые атрибуты:

- bus (int): номер шины NVMe.

Если не задано, сервер выберет доступный номер шины; если доступных номеров нет, запрос завершится ошибкой. ([‘present’])

- pci_slot_number (int): адрес адаптера NVMe на шине PCI.

Если не задано, сервер выберет доступный адрес при включении виртуальной машины. ([‘present’])

parallel_ports

list / elements=dictionary

Список параллельных портов.

Если не задано, параллельные порты создаваться не будут.

Допустимые атрибуты:

- backing (dict): физический ресурс, обеспечивающий работу виртуального параллельного порта.

Если не задано, по умолчанию выполняется автоматическое обнаружение подходящего устройства хоста. ([‘present’])

- Допустимые ключи:

- type (string): этот параметр определяет допустимые типы ресурсов, обеспечивающих работу виртуального параллельного порта.

Допустимые значения для этого поля:

- FILE

- HOST_DEVICE

- file (string): путь к файлу, который будет использоваться в качестве ресурса виртуального параллельного порта.

Это поле необязательное и имеет значение, только если type равен FILE.

- host_device (string): имя устройства, которое будет использоваться в качестве ресурса виртуального параллельного порта.

Если не задано, виртуальный параллельный порт будет настроен на автоматическое обнаружение подходящего устройства хоста.

- start_connected (bool): флаг, указывающий, должно ли виртуальное устройство подключаться при каждом включении виртуальной машины.

Если не задано, по умолчанию используется значение false. ([‘present’])

- allow_guest_control (bool): флаг, указывающий, может ли гостевая система подключать и отключать устройство.

Если не задано, по умолчанию используется значение false. ([‘present’])

parallel_ports_to_update

dictionary

Сопоставление параллельных портов для обновления.

Если не задано, параллельные порты обновляться не будут.

Если клиент передает значение этой структуры в качестве параметра, ключ в карте полей должен быть идентификатором ресурса, возвращенного методом vmware.vmware_rest.vcenter_vm_hardware_parallel.

path

string

Путь к файлу конфигурации виртуальной машины в хранилище данных, соответствующем {@link #datastore).

Если не задано, параметр datastore также должен быть не задан, а параметр datastore_path должен быть задан.

placement

dictionary

Сведения о размещении виртуальной машины.

Если это поле не задано, система использует значения исходной виртуальной машины. Если поле задано, для размещения будет использоваться каждое из его значений. Если эти значения указывают на разные места размещения, операция завершится ошибкой. Если эти значения вместе с существующими настройками размещения виртуальной машины указывают на разные места размещения, операция завершится ошибкой.

Допустимые атрибуты:

- folder (str): папка виртуальных машин, в которую следует поместить виртуальную машину.

Если это поле не задано, виртуальная машина останется в текущей папке.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_folder_info. ([‘clone’, ‘instant_clone’, ‘present’, ‘register’, ‘relocate’])

- resource_pool (str): пул ресурсов, в который следует поместить виртуальную машину.

Если это поле не задано, виртуальная машина останется в текущем пуле ресурсов.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_resourcepool_info. ([‘clone’, ‘instant_clone’, ‘present’, ‘register’, ‘relocate’])

- host (str): хост, на котором следует разместить виртуальную машину.

Если заданы и host, и resource_pool, пул ресурсов resource_pool должен принадлежать хосту host.

Если заданы и host, и cluster, хост host должен входить в кластер cluster.

Если это поле не задано и параметр resource_pool не задан, виртуальная машина останется на текущем хосте. Если задан параметр resource_pool, а целевой объект является автономным хостом, будет использован этот хост. Если задан параметр resource_pool, а целевой объект является кластером DRS, хост будет выбран средствами DRS. Если задан параметр resource_pool, а целевой объект является кластером без DRS, будет вызвана ошибка InvalidArgument.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_host_info. ([‘clone’, ‘present’, ‘register’, ‘relocate’])

- cluster (str): кластер, в который следует поместить виртуальную машину.

Если заданы и cluster, и resource_pool, пул ресурсов resource_pool должен принадлежать кластеру cluster.

Если заданы и cluster, и host, хост host должен входить в кластер cluster.

Если указан параметр resource_pool или host, рекомендуется не задавать это поле.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_cluster_info. ([‘clone’, ‘present’, ‘register’, ‘relocate’])

- datastore (str): хранилище данных, в котором должно храниться состояние конфигурации виртуальной машины. Это хранилище также будет использоваться для всех виртуальных дисков, связанных с виртуальной машиной, если для них не задано иное.

Если это поле не задано, виртуальная машина останется в текущем хранилище данных.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_datastore_info. ([‘clone’, ‘instant_clone’, ‘present’, ‘relocate’])

power_on

boolean

Попытаться выполнить power_on после клонирования.

Если не задано, виртуальная машина не будет включена.

Варианты:

• false
• true

sata_adapters

list / elements=dictionary

Список адаптеров SATA.

Если не задано, будут созданы все адаптеры, необходимые для подключения устройств хранения виртуальной машины; сюда входят устройства, для которых явно указан адаптер шины SATA, а также устройства, для которых адаптер шины не указан, если предпочтительный тип адаптера гостевой системы — SATA.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы эмуляции виртуального адаптера SATA. ([‘present’])

- Допустимые значения:

- AHCI

- bus (int): номер шины SATA.

Если не задано, сервер выберет доступный номер шины; если доступных номеров нет, запрос завершится ошибкой. ([‘present’])

- pci_slot_number (int): адрес адаптера SATA на шине PCI.

Если не задано, сервер выберет доступный адрес при включении виртуальной машины. ([‘present’])

scsi_adapters

list / elements=dictionary

Список адаптеров SCSI.

Если не задано, будут созданы все адаптеры, необходимые для подключения устройств хранения виртуальной машины; сюда входят устройства, для которых явно указан адаптер шины SCSI, а также устройства, для которых адаптер шины не указан, если предпочтительный тип адаптера гостевой системы — SCSI. Тип адаптера SCSI будет выбран по умолчанию для соответствующей гостевой системы.

Допустимые атрибуты:

- type (str): этот параметр определяет допустимые типы эмуляции виртуального адаптера SCSI. ([‘present’])

- Допустимые значения:

- BUSLOGIC

- LSILOGIC

- LSILOGICSAS

- PVSCSI

- bus (int): номер шины SCSI.

Если не задано, сервер выберет доступный номер шины; если доступных номеров нет, запрос завершится ошибкой. ([‘present’])

- pci_slot_number (int): адрес адаптера SCSI на шине PCI. Если адрес PCI недопустим, сервер изменит его при запуске виртуальной машины или горячем добавлении устройства.

Если не задано, сервер выберет доступный адрес при включении виртуальной машины. ([‘present’])

- sharing (str): этот параметр определяет допустимые режимы совместного использования шины виртуального адаптера SCSI. ([‘present’])

- Допустимые значения:

- NONE

- PHYSICAL

- VIRTUAL

serial_ports

list / elements=dictionary

Список последовательных портов.

Если не задано, последовательные порты создаваться не будут.

Допустимые атрибуты:

- yield_on_poll (bool): поведение процессора при освобождении ресурсов. Если задано значение true, виртуальная машина будет периодически освобождать процессор, если ее единственная задача — опрос виртуального последовательного порта. Время, необходимое для повторного получения процессора, зависит от степени активности других виртуальных машин на хосте.

Если не задано, по умолчанию используется значение false. ([‘present’])

- backing (dict): физический ресурс, обеспечивающий работу виртуального последовательного порта.

Если не задано, по умолчанию выполняется автоматическое обнаружение подходящего устройства хоста. ([‘present’])

- Допустимые ключи:

- type (string): этот параметр определяет допустимые типы ресурсов, обеспечивающих работу виртуального последовательного порта.

Допустимое значение для этого поля:

- FILE

- HOST_DEVICE

- NETWORK_CLIENT

- NETWORK_SERVER

- PIPE_CLIENT

- PIPE_SERVER

- file (string): путь к файлу, обеспечивающему работу виртуального последовательного порта.

Это поле необязательное и имеет значение, только если type равен FILE.

- host_device (string): имя устройства, обеспечивающего работу виртуального последовательного порта.

Если не задано, виртуальный последовательный порт будет настроен на автоматическое обнаружение подходящего устройства хоста.

- pipe (string): имя канала, обеспечивающего работу виртуального последовательного порта.

Это поле необязательное и имеет значение, только если type равен PIPE_SERVER или PIPE_CLIENT.

- no_rx_loss (boolean): флаг, включающий оптимизированную передачу данных по каналу. Если задано значение true, хост буферизует данные, чтобы предотвратить переполнение. Это позволяет виртуальной машине считывать все данные, переданные по каналу, без потерь.

Если не задано, по умолчанию используется значение false.

- network_location (string): URI, указывающий расположение сетевой службы, обеспечивающей работу виртуального последовательного порта.

- Если type равен NETWORK_SERVER, это поле содержит расположение, используемое клиентами для подключения к этому серверу. Имя хоста в URI должно быть пустым или указывать адрес хоста, на котором запущена виртуальная машина.

- Если type равен NETWORK_CLIENT, это поле содержит расположение, используемое виртуальной машиной для подключения к удаленному серверу.

Это поле необязательное и имеет значение, только если type равен NETWORK_SERVER или NETWORK_CLIENT.

- proxy (string): прокси-служба, обеспечивающая сетевой доступ к ресурсу. Если задано, виртуальная машина устанавливает соединение с прокси-службой и перенаправляет ей трафик.

Если не задано, прокси-служба использоваться не должна.

- start_connected (bool): флаг, указывающий, должно ли виртуальное устройство подключаться при каждом включении виртуальной машины.

Если не задано, по умолчанию используется значение false. ([‘present’])

- allow_guest_control (bool): флаг, указывающий, может ли гостевая система подключать и отключать устройство.

Если не задано, по умолчанию используется значение false. ([‘present’])

serial_ports_to_update

dictionary

Сопоставление последовательных портов для обновления.

Если не задано, последовательные порты обновляться не будут.

Если клиент передает значение этой структуры в качестве параметра, ключ в карте полей должен быть идентификатором ресурса, возвращенного методом vmware.vmware_rest.vcenter_vm_hardware_serial.

session_timeout

float

добавлено в vmware.vmware_rest 2.1.0

Настройки времени ожидания для сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию — 300 с.

source

string

Виртуальная машина, из которой выполняется InstantClone.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_vm_info. Обязательно при state=[‘clone’, ‘instant_clone’]

state

string

Варианты:

• "absent"
• "clone"
• "instant_clone"
• "present" ← (по умолчанию)
• "register"
• "relocate"
• "unregister"

storage_policy

dictionary

Структура storage_policy_spec содержит сведения о политике хранения, которая будет связана с домашним каталогом виртуальной машины (содержащим файлы конфигурации и журналов).

Если параметр не задан, применяется политика хранения по умолчанию для хранилища данных (если она поддерживается). В настоящее время политика хранения по умолчанию поддерживается только для объектных хранилищ данных: VVol и vSAN. Если параметр не задан для объектного хранилища данных, с домашним каталогом виртуальной машины не будет связана политика хранения. Обязательно при state=[‘present’]

Допустимые атрибуты:

- policy (str): идентификатор политики хранения, которая должна быть связана с виртуальной машиной.

Если клиент передает значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_storage_policies_info. ([‘present’])

Этот ключ обязателен при [‘present’].

vcenter_hostname

string / обязательно

Имя хоста или IP-адрес vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_HOST.

vcenter_password

string / обязательно

Пароль vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_PASSWORD.

vcenter_rest_log_file

string

С помощью этого необязательного параметра можно указать расположение файла журнала.

Этот файл будет использоваться для записи взаимодействия по HTTP REST.

Файл будет сохранен на хосте, на котором выполняется модуль.

Если значение не указано в задаче, будет использовано значение

переменной окружения VMWARE_REST_LOG_FILE.

vcenter_username

string / обязательно

Имя пользователя vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_USER.

vcenter_validate_certs

boolean

Разрешает подключение, если SSL-сертификаты недействительны. Если сертификаты не являются доверенными, задайте значение false.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.

Варианты:

• false
• true ← (по умолчанию)

vm

string

Идентификатор виртуальной машины, регистрацию которой следует отменить.

Параметр должен содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_vm_info. Обязательно при state=[‘absent’, ‘relocate’, ‘unregister’]

id

string

MOID ресурса

Возвращается: При успешном выполнении

Пример: "vm-1104"

value

dictionary

Создать мгновенный клон виртуальной машины

Возвращается: При успешном выполнении

Пример: {"boot": {"delay": 0, "enter_setup_mode": 0, "retry": 0, "retry_delay": 10000, "type": "BIOS"}, "boot_devices": [], "cdroms": {"16002": {"allow_guest_control": 0, "backing": {"auto_detect": 1, "device_access_type": "EMULATION", "type": "HOST_DEVICE"}, "label": "CD/DVD drive 1", "sata": {"bus": 0, "unit": 2}, "start_connected": 0, "state": "NOT_CONNECTED", "type": "SATA"}}, "cpu": {"cores_per_socket": 1, "count": 1, "hot_add_enabled": 0, "hot_remove_enabled": 0}, "disks": {"16000": {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm2/test_vm2_2.vmdk"}, "capacity": 16106127360, "label": "Hard disk 1", "sata": {"bus": 0, "unit": 0}, "type": "SATA"}, "16001": {"backing": {"type": "VMDK_FILE", "vmdk_file": "[local] test_vm2/test_vm2_1.vmdk"}, "capacity": 32000000000, "label": "Hard disk 2", "sata": {"bus": 0, "unit": 1}, "type": "SATA"}}, "floppies": {}, "guest_OS": "RHEL_7_64", "hardware": {"upgrade_policy": "NEVER", "upgrade_status": "NONE", "version": "VMX_11"}, "identity": {"bios_uuid": "4231bf8b-3cb4-3a3f-1bfb-18c857ce95b6", "instance_uuid": "5031b322-6030-a020-8e73-1a9ad0fd03ce", "name": "test_vm2"}, "instant_clone_frozen": 0, "memory": {"hot_add_enabled": 1, "hot_add_increment_size_MiB": 128, "hot_add_limit_MiB": 3072, "size_MiB": 1024}, "name": "test_vm2", "nics": {"4000": {"allow_guest_control": 0, "backing": {"network": "network-1095", "network_name": "VM Network", "type": "STANDARD_PORTGROUP"}, "label": "Network adapter 1", "mac_address": "00:50:56:b1:26:0c", "mac_type": "ASSIGNED", "pci_slot_number": 160, "start_connected": 0, "state": "NOT_CONNECTED", "type": "VMXNET3", "upt_compatibility_enabled": 0, "wake_on_lan_enabled": 0}}, "nvme_adapters": {}, "parallel_ports": {}, "power_state": "POWERED_ON", "sata_adapters": {"15000": {"bus": 0, "label": "SATA controller 0", "pci_slot_number": 32, "type": "AHCI"}}, "scsi_adapters": {}, "serial_ports": {}}