vmware.vmware_rest.network_moid lookup — поиск MoID сетевых объектов vSphere с помощью REST API vCenter

УСТАРЕЛО

Удалено в:

версии 5.0.0

Причина:

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

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

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

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

• Возвращает ссылку на управляемый объект (MoID) сетевого объекта vSphere, расположенного по указанному пути.
• Этот плагин поиска не может различать сети с одинаковыми именами в разных коммутаторах, поскольку REST API vSphere не поддерживает такую возможность; имена сетей должны быть уникальными в пределах указанного пути к центру обработки данных или папке.

Требования

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

• vSphere 7.0.3 или выше
• python >= 3.6
• aiohttp

Аргументы

Именованные параметры

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

Примечания

Примеры

#
#
# 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') }}"

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

Статус

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