vmware.vmware_rest.vm_moid 查找 – 使用 vCenter REST API 查找 vSphere 虚拟机对象的 MoID
注意
此查找插件是 vmware.vmware_rest 集合（版本 4.3.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install vmware.vmware_rest。您需要进一步的要求才能使用此查找插件，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： vmware.vmware_rest.vm_moid。
vmware.vmware_rest 2.1.0 中的新增功能
概要
返回指定路径中包含的 vSphere 虚拟机对象的托管对象引用 (MoID)。
要求
在执行此查找的本地控制器节点上需要以下要求。
vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp
术语
参数 |
注释 |
|---|---|
要查找的对象的绝对文件夹路径。 文件夹路径始终以数据中心名称开头，然后是对象类型（主机、虚拟机、网络、数据存储）。 如果对象位于子文件夹中，则应在对象类型后添加子文件夹路径（例如 /my_dc/vm/some/sub_folder/vm_name_to_lookup）。 按照在 VCenter GUI 中看到的输入对象或文件夹名称。不要转义空格或特殊字符。 |
关键字参数
这描述了查找的关键字参数。这些值是 key1=value1、key2=value2 等等，在以下示例中：lookup('vmware.vmware_rest.vm_moid', key1=value1, key2=value2, ...) 和 query('vmware.vmware_rest.vm_moid', key1=value1, key2=value2, ...)
参数 |
注释 |
|---|---|
不应由用户设置，在使用特定的查找插件时会在内部设置。 描述要查找的对象类型。示例，集群、数据中心、数据存储等。 默认值： |
|
注释
注意
当关键字参数和位置参数一起使用时，位置参数必须在关键字参数之前列出：
lookup('vmware.vmware_rest.vm_moid', term1, term2, key1=value1, key2=value2)和query('vmware.vmware_rest.vm_moid', term1, term2, key1=value1, key2=value2)查找插件在 Ansible 控制器上运行，用于从外部资源查找信息。请参阅 https://docs.ansible.org.cn/ansible/latest/plugins/lookup.html#lookup-plugins
此集合的插件允许您快速收集 VMWare 资源标识符，并存储或使用它们，而无需使用多个模块和任务来执行相同的操作。请参阅示例部分进行比较。
示例
#
#
# The examples below assume you have a datacenter named 'my_dc' and a vm named 'my_vm'.
# 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.vm_moid', '/my_dc/vm/my_cluster/my_vm',
vcenter_hostname="vcenter.test",
vcenter_username="[email protected]",
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: "[email protected]"
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.vm_moid', '/my_dc/vm/my_cluster/my_vm', **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.vm_moid', '/my_dc/vm/my_cluster/my_vm') }}"
#
# VM Search Path Examples
#
# VMs are located under the 'vm' folder in a datacenter. If they are not in a folder, the path
# should include the cluster name.
# The basic path for a VM should look like '/<datacenter-name>/vm/<cluster-name>/<vm-name>'
- name: Lookup VM Named 'my_vm' in Datacenter 'my_dc' in Cluster 'my_cluster'
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm/my_cluster/my_vm') }}"
# If the VM is in a user created VM folder, you just include the folder name.
- name: Lookup VM Named 'my_vm' in Datacenter 'my_dc' in Folder 'production' (also in Cluster 'my_cluster')
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/production/my_vm') }}"
#
# 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: Look up the VM called 'my_vm' in the inventory
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- my_vm
register: my_vm_info
- name: Delete a VM
vmware.vmware_rest.vcenter_vm:
vm: '{{ my_vm_info.value[0].vm }}'
state: absent
# With the lookup, playbooks are shorter, quicker, and more intuitive:
- name: Delete a VM
vmware.vmware_rest.vcenter_vm:
vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/my_vm') }}"
state: absent
返回值
键 |
描述 |
|---|---|
vSphere 虚拟机对象的 MoID 返回： 成功 示例： |