community.vmware.vmware_all_snapshots_info 模块 – 收集指定 VMware 数据中心中所有虚拟机快照的信息

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_all_snapshots_info。

概要 

此模块收集数据中心所有快照的详细信息，可以与筛选选项一起使用

参数 

参数	注释
数据中心字符串 / 必需	要从中收集快照信息的数据中心的名称。您可以在 VMware UI 中获取它。
筛选器字典	可选筛选器，应用于正在收集的快照数据，您可以应用一个或多个。筛选器基于指定的变量 match_type 应用。如果 match_type 为 exact，则筛选器需要完全匹配。另一方面，当 match_type 为 includes 时，它会获取包含该值的值。可用的筛选器选项：creation_time、description、folder、id、name、quiesced、state、vm_name。可以应用多个筛选器，快照必须满足所有筛选条件才能包含在结果中。默认值： `{}`
主机名字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果未在任务中指定该值，则将改用环境变量 `VMWARE_HOST` 的值。
match_type 字符串	指示筛选器匹配应该是完全匹配还是包含。例如，当您想获取所有名称中包含单词 test 的快照时，您将筛选器名称设为 test，并将 match_type 设为 includes。例如，当您想获取所有处于 poweredOn 状态的快照时，您可以跳过 match_type（默认值为 exact）或编写 match_type exact。选项 `"exact"` ← (默认) `"includes"`
password 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果未在任务中指定该值，则将改用环境变量 `VMWARE_PASSWORD` 的值。
端口整数	vSphere vCenter 或 ESXi 服务器的端口号。如果未在任务中指定该值，则将改用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理地址。格式为主机名或 IP。如果未在任务中指定该值，则将改用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果未在任务中指定该值，则将改用环境变量 `VMWARE_PROXY_PORT` 的值。
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果未在任务中指定该值，则将改用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果未在任务中指定该值，则将改用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

注意事项 

注意

所有模块都需要 API 写入权限，因此免费 ESXi 许可证不支持。
所有变量和 VMware 对象名称都区分大小写。

示例 

- name: Gather information about all snapshots in VMware vCenter
  vmware_snapshot_info_all:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    datacenter: '{{ datacenter_name }}'
  delegate_to: localhost
- name: Gather information of a snapshot with filters applied and match_type in exacts.
  vmware_snapshot_info_all:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: yes
    datacenter: '{{ datacenter_name }}'
    filters:
      state: "poweredOn"
      vm_name: "you_marchine_name"
  delegate_to: localhost
- name: Gather information of snapshots that in their name contain the "test" in their name.
  vmware_snapshot_info_all:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: yes
    datacenter: '{{ datacenter_name }}'
    match_type: "includes"
    filters:
      name: "test"
  delegate_to: localhost

返回值 

通用返回值请参考此处，以下是此模块特有的字段。

键	描述
vmware_all_snapshots_info 列表 / 元素=字典	指定数据中心中所有虚拟机的所有快照信息的列表返回: 始终
creation_time 字符串	快照创建的时间返回: 始终
description 字符串	快照的描述。返回: 当它存在时，因为它取决于它是否有描述
folder 字符串	虚拟机在数据中心中的文件夹路径，通常是 vm 返回: 始终
id 整数	快照的唯一标识符返回: 始终
name 字符串	快照的名称返回: 始终
quiesced 布尔值	指示创建快照时是否已将虚拟机的文件系统静默返回: 始终
state 字符串	快照时虚拟机的状态 (已开启/已关闭) 返回: 始终
vm_name 字符串	在 iu 中显示的虚拟机的名称。返回: 始终

作者

Fernando Mendieta (@valkiriaaquatica)