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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 ошибками. Варианты: `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. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
inject_ovf_env boolean	Принудительно добавить указанные свойства в среду OVF и передать их через VMware Tools. Варианты: `false` ← (по умолчанию) `true`
name string	Имя виртуальной машины, с которой нужно работать. Имена виртуальных машин в vCenter не обязательно уникальны, что может привести к проблемам.
networks dictionary	`key: value` сопоставление имени сети OVF с именем сети vCenter. По умолчанию: `{"VM Network": "VM Network"}`
ovf псевдонимы: ova path	Путь к файлу OVF или OVA для развертывания. Обязательный параметр, если не задан `url`. `ovf` и `url` — взаимоисключающие параметры.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
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 псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 чувствительны к регистру.
Модули могут использовать библиотеку Python «requests», которая по умолчанию не использует хранилище системных сертификатов. Можно указать хранилище сертификатов, задав переменную среды REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может привести к тому, что в некоторых случаях значение «false» параметра «validate_certs» будет проигнорировано. Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- 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"`

Авторы

Alexander Nikitin (@ihumster)
Matt Martz (@sivel)

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

© 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/vmware/vmware_deploy_ovf_module.html