community.vmware.vmware_guest_instant_clone модуль – Моментальное клонирование ВМ

Примечание

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

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

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

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

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

Обзор

Этот модуль можно использовать для создания включённого моментального клона виртуальной машины.
community.vmware.vmware_guest модуль необходим для создания ВМ в включённом состоянии, которая будет использоваться как родительская ВМ.
community.vmware.vmware_guest_powerstate модуль также необходим для выключения моментального клона.
Выключенная ВМ в свою очередь будет удалена с помощью community.vmware.vmware_guest модуля.
Таким образом community.vmware.vmware_guest модуль необходим для удаления моментального клона ВМ при создании ВМ в тестовой среде.
Также была добавлена настройка гостевой ОС с параметром guestinfo_vars.
Родительская ВМ должна иметь движок настройки гостевой ОС для настройки гостевой ОС при моментальном клонировании.
Только Linux в родительской ВМ поддерживает нативную настройку гостевой ОС vSphere для моментального клона в vSphere 7.

Параметры

Параметр	Комментарии
datacenter строка / обязательно	Имя дата-центра, в котором должна быть развернута ВМ.
datastore строка / обязательно	Имя хранилища данных или кластера хранилищ данных. Если указано имя кластера хранилищ данных, модуль найдет рекомендуемое хранилище данных Storage DRS в этом кластере.
folder строка	Папка назначения, абсолютный путь для развертывания клонированной ВМ. Примеры: folder: ha-datacenter/vm folder: /datacenter1/vm
guestinfo_vars список / элементы=словарь	Обеспечивает функциональность настройки GuestOS в мгновенно клонированной ВМ. Список пар ключ-значение, которые будут переданы в целевую ВМ. Эти пары должны использоваться для предоставления пользовательских настроек, которые позволят дифференцировать целевую ВМ от исходной ВМ.
dns строка	dns используется для установки dns в мгновенно клонированной гостевой операционной системе.
domain строка	domain используется для установки полностью квалифицированного доменного имени (FQDN) или полного доменного имени для мгновенно клонированной гостевой операционной системы.
gateway строка	netmask используется для установки netmask в мгновенно клонированной гостевой операционной системе.
hostname строка	hostname используется для получения имени DNS (Domain Name System) и установки имени хоста гостевой системы.
ipaddress строка	ipaddress используется для установки ipaddress в мгновенно клонированной гостевой операционной системе.
netmask строка	netmask используется для установки netmask в мгновенно клонированной гостевой операционной системе.
host псевдонимы: esxi_hostname строка / обязательно	Имя хоста ESX в дата-центре, в котором необходимо разместить клонированную ВМ. Хост должен быть членом кластера, который содержит пул ресурсов. Необходимо вместе с `resource_pool`, чтобы найти сведения о пуле ресурсов. Это будет использоваться как дополнительная информация, когда существуют пулы ресурсов с одинаковым именем.
hostname строка	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
moid строка	Идентификатор управляемого объекта (Managed Object ID) экземпляра ВМ для управления, если известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Это необходимо, если `parent_vm` или `uuid` не указаны.
name псевдонимы: vm_name строка / обязательно	Имя клонированной виртуальной машины.
parent_vm строка	Имя родительской виртуальной машины. Этот параметр обязателен, если параметр `uuid` или `moid` не указан.
password псевдонимы: pass, pwd строка	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host строка	Адрес прокси-сервера, который будет принимать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port целое число	Порт HTTP-прокси-сервера, который будет принимать все запросы HTTPS и пересылать их. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.

resource_pool string	Имя пула ресурсов в дата-центре, в котором будет размещён развернутый виртуальный компьютер. `Resources` — это имя пула ресурсов по умолчанию.
use_instance_uuid boolean	Использовать UUID экземпляра VMware вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя vCenter vSphere или сервера ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`.
uuid string	UUID экземпляра виртуального компьютера для клонирования, это уникальный идентификатор VMware. Это обязательный параметр, если параметр `parent_vm` или `moid` не задан.
validate_certs boolean	Разрешить подключение, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты не доверенны. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm_password string	Пароль, используемый для входа в виртуальную машину. Требуется только при использовании функции настройки гостевой операционной системы.
vm_username string	Имя пользователя для входа в виртуальную машину. Требуется только при использовании функции настройки гостевой операционной системы.
wait_vm_tools boolean	Ожидать запуска инструментов виртуальной машины после перезагрузки клонированной виртуальной машины. Варианты: `false` `true` ← (по умолчанию)
wait_vm_tools_timeout integer	Определите таймаут (в секундах) для параметра `wait_vm_tools`. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Instant Clone a VM
  community.vmware.vmware_guest_instant_clone:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    folder: "{{ f0 }}"
    datastore: "{{ rw_datastore }}"
    datacenter: "{{ dc1 }}"
    host: "{{ esxi1 }}"
    name: "{{ Clone_vm }}"
    parent_vm: "{{ testvm_1 }}"
    resource_pool: "{{ test_resource_001 }}"
  register: vm_clone
  delegate_to: localhost

- name: set state to poweroff the Cloned VM
  community.vmware.vmware_guest_powerstate:
    validate_certs: false
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "cloned_vm_from_vm_cluster"
    folder: "{{ f0 }}"
    state: powered-off
  register: poweroff_instant_clone_from_vm_when_cluster
  delegate_to: localhost

- name: Clean VM
  community.vmware.vmware_guest:
    validate_certs: false
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "cloned_vm_from_vm_cluster"
    datacenter: "{{ dc1 }}"
    state: absent
  register: delete_instant_clone_from_vm_when_cluster
  ignore_errors: true
  delegate_to: localhost

- name: Instant Clone a VM with guest_customization
  community.vmware.vmware_guest_instant_clone:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    vm_username: "root"
    vm_password: "SuperSecret"
    validate_certs: false
    folder: "{{ f0 }}"
    datastore: "{{ rw_datastore }}"
    datacenter: "{{ dc1 }}"
    host: "{{ esxi1 }}"
    guestinfo_vars:
      - hostname: "{{ guestinfo.ic.hostname }}"
        ipaddress: "{{ guestinfo.ic.ipaddress }}"
        netmask: "{{ guestinfo.ic.netmask }}"
        gateway: "{{ guestinfo.ic.gateway }}"
        dns: "{{ guestinfo.ic.dns }}"
        domain: "{{ guestinfo.ic.domain }}"
    name: "Instant_clone_guest_customize"
    parent_vm: "test_vm1"
    resource_pool: DC0_C0_RP1
  register: Instant_cloned_guest_customize
  delegate_to: localhost

- name: Instant Clone a VM when skipping optional params
  community.vmware.vmware_guest_instant_clone:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    name: "{{ Clone_vm }}"
    parent_vm: "{{ testvm_1 }}"
    datacenter: "{{ dc1 }}"
    datastore: "{{ rw_datastore }}"
    host: "{{ esxi1 }}"
  register: VM_clone_optional_arguments
  delegate_to: localhost

- name: Instant clone in check mode
  community.vmware.vmware_guest_instant_clone:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    folder: "{{ f0 }}"
    datastore: "{{ rw_datastore }}"
    datacenter: "{{ dc1 }}"
    host: "{{ esx1 }}"
    name: "{{ Clone_vm }}"
    parent_vm: "{{ testvm_2 }}"
    resource_pool: "{{ test_resource_001 }}"
  check_mode: true
  register: check_mode_clone
  delegate_to: localhost
- debug:
    var: check_mode_clone

Возвращаемые значения

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

Ключ	Описание
vm_info dictionary	Метаданные о виртуальной машине Возвращается: всегда Пример: `{"datastore": "", "host": "", "instance_uuid": "", "vcenter": "", "vm_folder": "", "vm_name": ""}`

Авторы

Anant Chopra (@Anant99-sys)

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

© 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_guest_instant_clone_module.html