vmware.vmware_rest.network_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.network_moid.
Добавлено в vmware.vmware_rest 2.1.0
Описание
- Возвращает Managed Object Reference (MoID) объекта сети vSphere, содержащегося в указанном пути.
- Этот плагин поиска не может различать несколько сетей с одинаковым именем, определенных в нескольких коммутаторах, так как это не поддерживается REST API vSphere; имена сетей должны быть уникальными в рамках заданного пути ЦОД/папки.
Требования
Ниже перечислены требования к локальному узлу управления, на котором выполняется поиск.
- vSphere 7.0.3 или более поздняя версия
- python >= 3.6
- aiohttp
Термины
Параметр | Комментарии |
|---|---|
Terms строка / обязательно | Абсолютный путь к папке к объекту, который вы хотите найти. Пути к папкам всегда начинаются с имени ЦОД, а затем типа объекта (хост, виртуальная машина, сеть, хранилище данных). Если объект находится в подпапке, путь к подпапке следует добавить после типа объекта (например, /my_dc/vm/some/sub_folder/vm_name_to_lookup). Введите имена объектов или папок так, как они отображаются в графическом интерфейсе VCenter. Не экранируйте пробелы или специальные символы. |
Ключевые параметры
Здесь описаны ключевые параметры поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('vmware.vmware_rest.network_moid', key1=value1, key2=value2, ...) и query('vmware.vmware_rest.network_moid', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
object_type строка | Не должен устанавливаться пользователем, он устанавливается внутри при использовании определенного плагина поиска. Описывает тип объекта для поиска. Например, кластер, ЦОД, хранилище данных и т. д. По умолчанию: |
vcenter_hostname строка / обязательно | |
Примечания
Примечание
- Когда ключевые и позиционные параметры используются вместе, позиционные параметры должны быть перечислены перед ключевыми параметрами:
lookup('vmware.vmware_rest.network_moid', term1, term2, key1=value1, key2=value2)иquery('vmware.vmware_rest.network_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 network named 'my_network'.
# 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.network_moid', '/my_dc/network/my_network',
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.network_moid', '/my_dc/network/my_network', **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.network_moid', '/my_dc/network/my_network') }}"
#
# Network Search Path Examples
#
# Networks are located under the 'network' folder in a datacenter.
# The basic path for a datastore should look like '/<datacenter-name>/network/<network-name>'
- name: Lookup Network Named 'my_network' in Datacenter 'my_dc'
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/my_network') }}"
# If the network is in a user created 'network' type folder, the path shoud just include the
# datacenter and folder name.
- name: Lookup Network Named 'my_network' in Datacenter 'my_dc' in a Network folder 'production'
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/production/my_network') }}"
#
# 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 the network named 'my_network'
vmware.vmware_rest.vcenter_network_info:
names:
- my_network
register: my_network_info
- name: Create a VM
vmware.vmware_rest.vcenter_vm:
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
nics:
- backing:
type: STANDARD_PORTGROUP
network: "{{ my_network_info.value[0].network }}"
# With the lookup, playbooks are shorter, quicker, and more intuitive:
- name: Create a VM
vmware.vmware_rest.vcenter_vm:
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
nics:
- backing:
type: STANDARD_PORTGROUP
network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/my_network') }}"
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение строка | MoID объекта сети vSphere Возвращается: успех Пример: |
Ссылки на коллекцию
© 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/network_moid_lookup.html