Модуль community.vmware.vmware_deploy_ovf – Развертывает виртуальную машину VMware из файла OVF или OVA, размещённого на файловой системе или HTTP-сервере

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware.

Для использования в плейбуке укажите: community.vmware.vmware_deploy_ovf.

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

Обзор

Этот модуль может быть использован для развертывания виртуальной машины VMware из файла OVF или OVA, размещённого на файловой системе или HTTP-сервере

Параметры

Параметр	Комментарии
allow_duplicates boolean	Разрешить дублирование имён ВМ. ESXi разрешает, vCenter может не разрешить. Варианты: `false` `true` ← (по умолчанию)
cluster string	Кластер для развертывания. Обязательный параметр, если `esxi_hostname` не задан и `hostname` задан для сервера vCenter. `esxi_hostname` и `cluster` являются взаимоисключающими параметрами.
datacenter string	Центр обработки данных для развертывания. По умолчанию: `"ha-datacenter"`
datastore string	Хранилище данных для развертывания. По умолчанию: `"datastore1"`
deployment_option string	Ключ выбранного варианта развертывания.
disk_provisioning string	Тип виртуализации дисков. Варианты: `"flat"` `"eagerZeroedThick"` `"monolithicSparse"` `"twoGbMaxExtentSparse"` `"twoGbMaxExtentFlat"` `"thin"` ← (по умолчанию) `"sparse"` `"thick"` `"seSparse"` `"monolithicFlat"`
enable_hidden_properties boolean добавлен в community.vmware 3.11.0	Включить свойства источника, помеченные как `ovf:userConfigurable=false`. Варианты: `false` ← (по умолчанию) `true`
esxi_hostname string	Имя хоста ESXi, где будет выполняться виртуальная машина. Обязательный параметр, если `cluster` не задан и `hostname` задан для сервера vCenter. `esxi_hostname` и `cluster` являются взаимоисключающими параметрами.
fail_on_spec_warnings boolean	Принимать предупреждения OVF Import Spec как ошибки. Варианты: `false` ← (по умолчанию) `true`
folder string	Абсолютный путь к папке для размещения виртуальной машины. Если не указано, используется значение `datacenter.vmFolder`. Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
inject_ovf_env boolean	Принудительно вставить заданные свойства в среду OVF и ввести их через VMware Tools. Варианты: `false` ← (по умолчанию) `true`
name string	Имя ВМ для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может представлять проблему.
networks dictionary	Сопоставление имени сети OVF с именем сети vCenter. По умолчанию: `{"VM Network": "VM Network"}`
ovf aliases: ova path	Путь к файлу OVF или OVA для развертывания. Требуется, если `url` не задан. `ovf` и `url` являются взаимоисключающими параметрами.
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`

END_OF_DOCUMENT_MARKER

power_on boolean	Включить виртуальную машину после создания? Варианты: `false` `true` ← (по умолчанию)
properties dictionary	Присваивание значений свойствам, найденным в OVF в виде пар ключ-значение.
proxy_host string	Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
resource_pool string	Пул ресурсов для развертывания. По умолчанию: `"Resources"`
url string добавлен в community.vmware 3.9.0	URL файла OVA для развертывания. Требуется, если `ovf` не задан. `url` и `ovf` — взаимоисключающие параметры.
username aliases: admin, user string	Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение при невалидных сертификатах SSL. Установите в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
wait boolean	Ожидать включения хоста. Варианты: `false` `true` ← (по умолчанию)
wait_for_ip_address boolean	Ожидать, пока vCenter обнаружит IP-адрес для ВМ. Для этого требуется vmware-tools (vmtoolsd), чтобы правильно работать после создания. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Для использования https в качестве источника необходимо включить в брандмауэр входящий порт 443
Все модули требуют доступ к API для записи и поэтому не поддерживаются в бесплатной лицензии ESXi.
Все имена переменных и объектов VMware чувствительны к регистру.

Примеры

- community.vmware.vmware_deploy_ovf:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    ovf: /path/to/ubuntu-16.04-amd64.ovf
    wait_for_ip_address: true
  delegate_to: localhost

# Deploys a new VM named 'NewVM' in specific datacenter/cluster, with network mapping taken from variable and using ova template from an absolute path
- community.vmware.vmware_deploy_ovf:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: Datacenter1
    cluster: Cluster1
    datastore: vsandatastore
    name: NewVM
    networks: "{u'VM Network':u'{{ ProvisioningNetworkLabel }}'}"
    power_on: false
    ovf: /absolute/path/to/template/mytemplate.ova
  delegate_to: localhost

- community.vmware.vmware_deploy_ovf:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: Datacenter1
    esxi_hostname: test-server
    datastore: test-datastore
    ovf: /path/to/ubuntu-16.04-amd64.ovf
  delegate_to: localhost

- community.vmware.vmware_deploy_ovf:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    url: https://cloud-images.ubuntu.com/releases/xenial/release/ubuntu-16.04-server-cloudimg-amd64.ova
    wait_for_ip_address: true
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
instance dictionary	метаданные о новой виртуальной машине Возвращается: всегда Пример: `"None"`

Авторы

Александр Никитин (@ihumster)
Мэтт Марц (@sivel)

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

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