Модуль vmware.vmware_rest.vcenter_ovf_libraryitem – Создает элемент библиотеки в библиотеке контента из виртуальной машины или виртуального приложения

Примечание

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

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

Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.

Для использования в книге задач укажите: vmware.vmware_rest.vcenter_ovf_libraryitem.

Новый в vmware.vmware_rest 2.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Создает элемент библиотеки в библиотеке контента из виртуальной машины или виртуального приложения. <p> Эта {@term операция} создает элемент библиотеки в библиотеке контента, содержимое которого является пакетом OVF, полученным из исходной виртуальной машины или виртуального приложения, используя предоставленное описание создания. Пакет OVF может храниться в новом элементе библиотеки или в существующем элементе библиотеки. Для существующего элемента библиотеки, содержимое которого обновляется с помощью этой {@term операции}, исходное содержимое перезаписывается. Метаданные, такие как имя и описание, не обновляются для существующего элемента библиотеки. </p>

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

vSphere 7.0.3 или более поздняя версия
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
client_token строка	Сгенерированный клиентом токен, используемый для повторной попытки запроса, если клиент не получает ответ от сервера. Если исходный запрос был успешным, возвращается результат этого запроса, в противном случае операция повторяется.
create_spec словарь	Информация, используемая для создания пакета OVF из исходной виртуальной машины или виртуального приложения. Требуется при state=[‘present’] Допустимые атрибуты: `name` (строка): Имя для использования в описателе OVF, хранящемся в элементе библиотеки. ([‘present’]) `description` (строка): Описание для использования в описателе OVF, хранящемся в элементе библиотеки. ([‘present’]) `flags` (список): Флаги для использования при создании пакета OVF. Поддерживаемые флаги можно получить, используя {@ссылка ExportFlag#list}. ([‘present’])
deployment_spec словарь	Спецификация того, как пакет OVF должен быть развернут на целевом устройстве. Требуется при state=[‘deploy’] Допустимые атрибуты: `name` (строка): Наименование, присвоенное развернутой целевой виртуальной машине или виртуальному приложению. ([‘deploy’]) `annotation` (строка): Комментарий, присвоенный развернутой целевой виртуальной машине или виртуальному приложению. ([‘deploy’]) `accept_all_EULA` (логическое значение): Указывает, следует ли принять все лицензионные соглашения конечного пользователя. ([‘deploy’]) Этот ключ требуется при [‘deploy’]. `network_mappings` (словарь): Описание целевой сети, которая должна использоваться для разделов типа ovf:NetworkSection в описателе OVF. Ключ в {@term map} — идентификатор раздела ovf:NetworkSection в описателе OVF, а значение — целевая сеть, используемая для развертывания. ([‘deploy’]) `storage_mappings` (словарь): Описание целевого хранилища, которое должно использоваться для разделов типа vmw:StorageGroupSection в описателе OVF. Ключ в {@term map} — идентификатор раздела ovf:StorageGroupSection в описателе OVF, а значение — описание целевого хранилища, используемого для развертывания. ([‘deploy’]) `storage_provisioning` (строка): `disk_provisioning_type` определяет типы виртуального дискового обеспечения, которые могут быть заданы для диска на целевой платформе. ([‘deploy’]) Допустимые значения: eagerZeroedThick thick thin `storage_profile_id` (строка): Профиля хранилища по умолчанию для всех разделов типа vmw:StorageSection в описателе OVF. ([‘deploy’]) `locale` (строка): Язык для парсинга описателя OVF. ([‘deploy’]) `flags` (список): Флаги, которые следует использовать для развертывания. Поддерживаемые значения флагов можно получить, используя {@ссылка ImportFlag#list}. ([‘deploy’]) `additional_parameters` (список): Дополнительные параметры OVF, которые могут потребоваться для развертывания. Дополнительные параметры OVF могут потребоваться описателем OVF пакета в элементе библиотеки. Примеры параметров OVF, которые можно указать в этом поле, включают, но не ограничиваются: <ul> <li>{@link DeploymentOptionParams}</li> <li>{@link ExtraConfigParams}</li> <li>{@link IpAllocationParams}</li> <li>{@link PropertyParams}</li> <li>{@link ScaleOutParams}</li> <li>{@link VcenterExtensionParams}</li> </ul> ([‘deploy’]) `default_datastore_id` (строка): Хранилище по умолчанию для всех разделов типа vmw:StorageSection в описателе OVF. ([‘deploy’])
ovf_library_item_id строка	Идентификатор элемента библиотеки контента, содержащего пакет OVF, который необходимо развернуть. Требуется при state=[‘deploy’, ‘filter’]
session_timeout число с плавающей точкой добавлен в vmware.vmware_rest 2.1.0	Параметры таймаута для сеанса клиента. Максимальное время в секундах для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 секунд.
source словарь	Идентификатор виртуальной машины или виртуального приложения, которое следует использовать в качестве источника. Требуется при state=[‘present’] Допустимые атрибуты: `type` (строка): Тип развертываемого ресурса. ([‘present’]) Этот ключ требуется при [‘present’]. `id` (строка): Идентификатор развертываемого ресурса. ([‘present’]) Этот ключ требуется при [‘present’].
state строка	Варианты: `"deploy"` `"filter"` `"present"` ← (по умолчанию)
target словарь / обязательно	Описание целевой библиотеки контента и элемента библиотеки. Этот параметр обязателен. Допустимые атрибуты: `library_id` (строка): Идентификатор библиотеки, в которой должен быть создан новый элемент библиотеки. Это поле не используется, если указано поле `#library_item_id`. ([‘present’]) `library_item_id` (строка): Идентификатор элемента библиотеки, который должен быть обновлен. ([‘present’]) `resource_pool_id` (строка): Идентификатор пула ресурсов, к которому должна быть подключена виртуальная машина или виртуальное приложение. ([‘deploy’, ‘filter’]) Этот ключ требуется при [‘deploy’, ‘filter’]. `host_id` (строка): Идентификатор целевого хоста, на котором будет выполняться виртуальная машина или виртуальное приложение. Целевой хост должен быть членом кластера, содержащего пул ресурсов, идентифицированный по {@ссылка #resourcePoolId}. ([‘deploy’, ‘filter’]) `folder_id` (строка): Идентификатор папки vCenter, которая должна содержать виртуальную машину или виртуальное приложение. Папка должна быть папкой виртуальных машин. ([‘deploy’, ‘filter’])
vcenter_hostname строка / обязательно	Имя хоста или IP-адрес vCenter vSphere Если значение не указано в задаче, используется значение переменной среды `VMWARE_HOST`.
vcenter_password строка / обязательно	Пароль vCenter vSphere Если значение не указано в задаче, используется значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	Этот необязательный параметр можно использовать для задания расположения файла журнала. Этот файл используется для записи взаимодействия с HTTP REST. Файл будет сохранен на хосте, на котором выполняется модуль. Если значение не указано в задаче, используется значение переменной среды `VMWARE_REST_LOG_FILE`.

vcenter_username

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

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

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

vcenter_validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

Тестировано на vSphere 7.0.3

Примеры

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
  register: my_vm

- name: Create a content library pointing on a NFS share
  vmware.vmware_rest.content_locallibrary:
    name: my_library_on_nfs
    description: automated
    publish_info:
      published: true
      authentication_method: NONE
    storage_backings:
    - storage_uri: nfs://datastore.test/srv/share/content-library
      type: OTHER
    state: present
  register: nfs_lib

- name: Export the VM as an OVF on the library
  vmware.vmware_rest.vcenter_ovf_libraryitem:
    session_timeout: 2900
    source:
      type: VirtualMachine
      id: '{{ my_vm.id }}'
    target:
      library_id: '{{ nfs_lib.id }}'
    create_spec:
      name: golden_image
      description: an OVF example
      flags: []
    state: present
  register: ovf_item

- name: Get the list of items of the NFS library
  vmware.vmware_rest.content_library_item_info:
    library_id: '{{ nfs_lib.id }}'
  register: lib_items

- name: Create a new VM from the OVF
  vmware.vmware_rest.vcenter_ovf_libraryitem:
    ovf_library_item_id: '{{ (lib_items.value|selectattr("name", "equalto", "golden_image")|first).id }}'
    state: deploy
    target:
      resource_pool_id: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    deployment_spec:
      name: my_vm_from_ovf
      accept_all_EULA: true
      storage_provisioning: thin

- name: Create a new VM from the OVF and specify the host and folder
  vmware.vmware_rest.vcenter_ovf_libraryitem:
    ovf_library_item_id: '{{ (lib_items.value|selectattr("name", "equalto", "golden_image")|first).id }}'
    state: deploy
    target:
      resource_pool_id: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
      folder_id: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      host_id: "{{ lookup('vmware.vmware_rest.host_moid', '/my_dc/host/my_cluster/esxi1.test/test_vm1') }}"
    deployment_spec:
      name: my_vm_from_ovf_on_a_host
      accept_all_EULA: true
      storage_provisioning: thin

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

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

Ключ	Описание
value словарь	Создает новую виртуальную машину из OVF и задает хост и папку Возвращается: При успехе Пример: `{"error": {"errors": [], "information": [], "warnings": []}, "resource_id": {"id": "vm-1078", "type": "VirtualMachine"}, "succeeded": 1}`

Авторы

Команда Ansible Cloud (@ansible-collections)

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

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