vmware.vmware_rest.resource_pool_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.resource_pool_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
Аргументы
Параметр | Комментарии |
|---|---|
Аргументы string / обязательный | Абсолютный путь к папке объекта, который необходимо найти. Пути к папкам всегда начинаются с имени центра обработки данных, за которым следует тип объекта (host, vm, network, datastore). Если объект находится во вложенной папке, путь к ней следует добавить после типа объекта (например, /my_dc/vm/some/sub_folder/vm_name_to_lookup). Указывайте имена объектов или папок так, как они отображаются в графическом интерфейсе VCenter. Не экранируйте пробелы или специальные символы. |
Параметры-ключевые слова
Здесь описаны параметры-ключевые слова плагина поиска. В следующих примерах это значения key1=value1, key2=value2 и т. д.: lookup('vmware.vmware_rest.resource_pool_moid', key1=value1, key2=value2, ...) и query('vmware.vmware_rest.resource_pool_moid', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
object_type string | Не задавайте этот параметр самостоятельно: он задаётся автоматически при использовании определённого плагина поиска. Определяет тип объекта для поиска. Например, cluster, datacenter, datastore и т. д. По умолчанию: |
vcenter_hostname string / обязательный | |
vcenter_password string / обязательный | |
vcenter_rest_log_file string | Этот необязательный параметр позволяет указать расположение файла журнала. В этом файле будут записываться взаимодействия по HTTP REST. Файл будет сохранён на узле, на котором выполняется модуль. Конфигурация:
|
vcenter_username string / обязательный | |
vcenter_validate_certs boolean | Разрешает подключение, если сертификаты SSL недействительны. Установите значение Варианты:
Конфигурация:
|
Примечания
Примечание
- При совместном использовании параметров-позиционных аргументов и параметров-ключевых слов позиционные аргументы необходимо указывать перед параметрами-ключевыми словами:
lookup('vmware.vmware_rest.resource_pool_moid', term1, term2, key1=value1, key2=value2)иquery('vmware.vmware_rest.resource_pool_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', a cluster named 'my_cluster', and a resource pool named 'my_pool'.
# 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.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_pool',
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.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_pool', **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.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_pool') }}"
#
# Resource Pool Search Path Examples
#
# Pools are located under the 'host' folder in a datacenter. They are nested under the cluster name, and
# then a special 'Resources' folder.
# The basic path for a pool should look like '/<datacenter-name>/host/<cluster-name>/Resources/<resource-pool-name>'
- name: Lookup Pool Named 'my_pool' in Datacenter 'my_dc' and Cluster 'my_cluster'
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_pool') }}"
#
# 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 resource pool named 'my_pool'
vmware.vmware_rest.vcenter_resource_pool_info:
names:
- my_pool
register: my_pool_info
- name: Create a VM
vmware.vmware_rest.vcenter_vm:
placement:
resource_pool: "{{ my_pool_info.value[0].resource_pool }}"
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:
resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_pool') }}"
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 Возвращается: при успешном выполнении Пример: |
Статус
- Этот плагин поиска будет удалён в версии 5.0.0. [устаревший]
- Дополнительную информацию см. в разделе УСТАРЕВАЕТ.
Ссылки на коллекцию
© 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/resource_pool_moid_lookup.html