Spec-Zone.ru › Ansible

vmware.vmware_rest.cluster_moid поиск — Поиск MoID для объектов кластера vSphere с помощью REST-API vCenter

Примечание

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

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

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

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

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

  • Обзор
  • Требования
  • Термины
  • Ключевые параметры
  • Примечания
  • Примеры
  • Значение возврата

Обзор

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

Требования

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

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

Термины

Параметр

Комментарии

Термины

строка / обязательно

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

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

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

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

Ключевые параметры

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

Параметр

Комментарии

object_type

строка

Не должен устанавливаться пользователем, устанавливается внутренне при использовании определенного плагина поиска.

Определяет тип объекта для поиска. Например, кластер, центр обработки данных, хранилище данных и т.д.

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

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

строка / обязательно

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

Настройка:

  • Переменная среды: VMWARE_USER

vcenter_validate_certs

логическое

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

Варианты:

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

Настройка:

  • Переменная среды: VMWARE_VALIDATE_CERTS

Примечания

Примечание

  • При совместном использовании ключевых и позиционных параметров позиционные параметры должны указываться перед ключевыми параметрами: lookup('vmware.vmware_rest.cluster_moid', term1, term2, key1=value1, key2=value2) и query('vmware.vmware_rest.cluster_moid', term1, term2, key1=value1, key2=value2)
  • Плагины поиска выполняются на контроллере 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 cluster named 'my_cluster'.
# 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.cluster_moid', '/my_dc/host/my_cluster',
      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.cluster_moid', '/my_dc/host/my_cluster', **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.cluster_moid', '/my_dc/host/my_cluster') }}"

#
# Cluster Search Path Examples
#
# Clusters are located under the 'host' folder in a datacenter.
# The basic path for a cluster should look like '/<datacenter-name>/host/<cluster-name>'
- name: Lookup Cluster Named 'my_cluster' in Datacenter 'my_dc'
  ansible.builtin.debug:
    msg: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"

#
# 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 cluster named 'my_cluster'
  vmware.vmware_rest.vcenter_cluster_info:
    names:
      - my_cluster
  register: my_cluster_info

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ my_cluster_info.value[0].cluster }}"
    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:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
    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

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

Ключ

Описание

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

строка

MoID объекта кластера vSphere

Возвращается: success

Пример: "domain-c1007"

Авторы

  • Alina Buzachis (@alinabuzachis)

Подсказка

Элементы конфигурации для каждого типа имеют порядок приоритетов от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

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

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

Spec-Zone.ru

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