community.vmware.vmware_vm_info 模块 – 返回有关 VMware 虚拟机客户机的基本信息
注意
此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install community.vmware。
要在剧本中使用它，请指定： community.vmware.vmware_vm_info。
概要
返回有关 vSphere 或 ESXi 虚拟机客户机的基本信息。
参数
参数 |
注释 |
|---|---|
指定要从中收集信息的虚拟机的文件夹位置。 示例 folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2 |
|
vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将改用环境变量 |
|
vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将改用环境变量 |
|
将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定该值，则将改用环境变量 |
|
如果设置为 True，则显示以字节为单位的已分配存储空间和以 MB 为单位的内存。 选项
|
|
仅当设置为 选项
|
|
如果设置为 选项
|
|
如果设置为 选项
|
|
如果设置为 选项
|
|
如果设置为 选项
|
|
显示文件夹 选项
|
|
如果设置为 选项
|
|
如果设置为 选项
|
|
如果设置为 选项
|
|
如果设置为 选项
|
|
vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定值，则将使用环境变量 |
|
要从中获取相关配置信息的虚拟机的名称。 |
|
如果设置为 如果设置为 如果设置为 选项
|
注释
注意
所有模块都需要API写入权限，因此在免费的ESXi许可证上不支持。
所有变量和VMware对象名称都区分大小写。
示例
- name: Gather all registered virtual machines
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
delegate_to: localhost
register: vm_info
- debug:
var: vm_info.virtual_machines
- name: Gather one specific VM
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
vm_name: 'vm_name_as_per_vcenter'
delegate_to: localhost
register: vm_info
- debug:
var: vm_info.virtual_machines
- name: Gather only registered virtual machine templates
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
vm_type: template
delegate_to: localhost
register: template_info
- debug:
var: template_info.virtual_machines
- name: Gather only registered virtual machines
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
vm_type: vm
delegate_to: localhost
register: vm_info
- debug:
var: vm_info.virtual_machines
- name: Get UUID from given VM Name
block:
- name: Get virtual machine info
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
folder: "/datacenter/vm/folder"
delegate_to: localhost
register: vm_info
- debug:
msg: "{{ item.uuid }}"
with_items:
- "{{ vm_info.virtual_machines | community.general.json_query(query) }}"
vars:
query: "[?guest_name=='DC0_H0_VM0']"
- name: Get Tags from given VM Name
block:
- name: Get virtual machine info
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
folder: "/datacenter/vm/folder"
delegate_to: localhost
register: vm_info
- debug:
msg: "{{ item.tags }}"
with_items:
- "{{ vm_info.virtual_machines | community.general.json_query(query) }}"
vars:
query: "[?guest_name=='DC0_H0_VM0']"
- name: Gather all VMs from a specific folder
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
folder: "/Asia-Datacenter1/vm/prod"
delegate_to: localhost
register: vm_info
- name: Get datastore_url from given VM name
block:
- name: Get virtual machine info
community.vmware.vmware_vm_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
delegate_to: localhost
register: vm_info
- debug:
msg: "{{ item.datastore_url }}"
with_items:
- "{{ vm_info.virtual_machines | community.general.json_query(query) }}"
vars:
query: "[?guest_name=='DC0_H0_VM0']"
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
虚拟机及其信息的字典列表 返回：成功 示例： |