Spec-Zone.ru › Ansible

vmware.vmware_rest.datastore_moid lookup — поиск MoID объектов хранилища данных vSphere с помощью REST API vCenter

Примечание

Этот плагин поиска входит в коллекцию vmware.vmware_rest (версия 4.10.0).

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

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

Чтобы использовать его в плейбуке, укажите: vmware.vmware_rest.datastore_moid.

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

  • УСТАРЕЛ
  • Краткое описание
  • Требования
  • Параметры
  • Параметры-ключевые слова
  • Примечания
  • Примеры
  • Возвращаемое значение
  • Статус

УСТАРЕЛ

Удалён в:

версии 5.0.0

Причина:

Этот плагин не будет работать с ansible-core 2.19 и более поздними версиями. Примеры перехода см. в документации по переходу.

Альтернатива:

Вместо него используйте vmware.vmware.moid_from_path.

Краткое описание

  • Возвращает ссылку на управляемый объект (MoID) объекта хранилища данных vSphere, указанного в заданном пути.

Требования

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

  • vSphere 7.0.3 или новее
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

Terms

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

Абсолютный путь к папке, содержащей объект, который нужно найти.

Пути к папкам всегда начинаются с имени центра обработки данных, за которым следует тип объекта (host, vm, network, datastore).

Если объект находится во вложенной папке, после типа объекта нужно добавить путь к этой папке (например, /my_dc/vm/some/sub_folder/vm_name_to_lookup).

Указывайте имена объектов или папок так, как они отображаются в графическом интерфейсе VCenter. Не экранируйте пробелы и специальные символы.

Параметры-ключевые слова

Здесь описаны параметры-ключевые слова поиска. В следующих примерах это значения key1=value1, key2=value2 и т. д.: lookup('vmware.vmware_rest.datastore_moid', key1=value1, key2=value2, ...) и query('vmware.vmware_rest.datastore_moid', key1=value1, key2=value2, ...)

Параметр

Комментарии

object_type

string

Не следует задавать пользователю: это значение устанавливается внутри плагина при использовании определённого плагина поиска.

Описывает тип объекта для поиска. Например: cluster, datacenter, datastore и т. д.

По умолчанию: "cluster"

vcenter_hostname

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

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

Конфигурация:

  • Переменная окружения: VMWARE_HOST

vcenter_password

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

Пароль vCenter vSphere.

Конфигурация:

  • Переменная окружения: VMWARE_PASSWORD

vcenter_rest_log_file

string

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

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

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

Конфигурация:

  • Переменная окружения: VMWARE_REST_LOG_FILE

vcenter_username

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

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

Конфигурация:

  • Переменная окружения: VMWARE_USER

vcenter_validate_certs

boolean

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

Варианты:

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

Конфигурация:

  • Переменная окружения: VMWARE_VALIDATE_CERTS

Примечания

Примечание

  • Если одновременно используются позиционные параметры и параметры-ключевые слова, позиционные параметры должны указываться перед параметрами-ключевыми словами: lookup('vmware.vmware_rest.datastore_moid', term1, term2, key1=value1, key2=value2) и query('vmware.vmware_rest.datastore_moid', term1, term2, key1=value1, key2=value2)
  • Для этого плагина требуется коллекция cloud.common, которая не устанавливается автоматически как зависимость.
  • Плагины поиска запускаются на контроллере Ansible и используются для получения сведений из внешнего ресурса. См. раздел https://docs.ansible.com/ansible/latest/plugins/lookup.html#lookup-plugins
  • Плагины этой коллекции позволяют быстро собирать идентификаторы ресурсов VMWare и сохранять или использовать их, вместо того чтобы выполнять ту же задачу с помощью нескольких модулей и задач. Сравнение см. в разделе примеров.

Примеры

#
#
# The examples below assume you have a datacenter named 'my_dc' and a datastore named 'my_datastore'.
# Replace these values as needed for your environment.
#
#

#
# Authentication / Connection Arguments
#
# You can explicitly set the connection arguments in each lookup. This may be clearer for some use cases
- name: Pass In Connection Arguments Explicitly
  ansible.builtin.debug:
    msg: >-
      {{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/my_datastore',
      vcenter_hostname="vcenter.test",
      vcenter_username="administrator@vsphere.local",
      vcenter_password="1234") }}

# Alternatively, you can add the connection arguments to a dictionary variable, and then pass that variable to the
# lookup plugins. This makes the individual lookup plugin calls simpler
- name: Example Playbook
  hosts: all
  vars:
    connection_args:
      vcenter_hostname: "vcenter.test"
      vcenter_username: "administrator@vsphere.local"
      vcenter_password: "1234"
  tasks:
    # Add more tasks or lookups as needed, referencing the same connection_args variable
    - name: Lookup MoID of the object
      ansible.builtin.debug:
        msg: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/my_datastore', **connection_args) }}"

# Finally, you can also leverage the environment variables associated with each connection arg, and avoid passing
# extra args to the lookup plugins
- name: Use a lookup plugin with VMWARE_* environment variables set
  ansible.builtin.debug:
    msg: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/my_datastore') }}"

#
# Datastore Search Path Examples
#
# Datastores are located under the 'datastore' folder in a datacenter.
# The basic path for a datastore should look like '/<datacenter-name>/datastore/<datastore-name>'
# You can also lookup datastores under a specific host, if needed.
# The basic path should look like '/<datacenter-name>/host/<cluster-name>/<host-name>/<datastore-name>'
# Note: All datastores are still accessible at this path, not just the ones attached to the host.
- name: Lookup Datastore Named 'my_datastore' in Datacenter 'my_dc'
  ansible.builtin.debug:
    msg: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/my_datastore') }}"

# If the datastore is in a user created 'datastore' type folder, the path shoud just include the
# datacenter and folder name.
- name: Lookup Datastore Named 'my_datastore' in Datacenter 'my_dc' in a datastore folder 'production'
  ansible.builtin.debug:
    msg: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/production/my_datastore') }}"
#
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about a datastore named 'my_datastore'
  vmware.vmware_rest.vcenter_cluster_info:
    names:
      - my_datastore
  register: my_datastore_info

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      datastore: "{{ my_datastore_info.value[0].datastore }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      size_MiB: 1024
    disks:
      - type: SATA
        new_vmdk:
          name: first_disk
          capacity: 3200

# With the lookup, playbooks are shorter, quicker, and more intuitive:
- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/my_datastore') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      size_MiB: 1024
    disks:
      - type: SATA
        new_vmdk:
          name: first_disk
          capacity: 3200

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

Ключ

Описание

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

string

MoID объекта хранилища данных vSphere

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

Пример: "datastore-1019"

Статус

  • Этот плагин поиска будет удалён в версии 5.0.0. [устарел]
  • Дополнительные сведения см. в разделе УСТАРЕЛ.

Авторы

  • Alina Buzachis (@alinabuzachis)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API