vmware.vmware_rest.vcenter_vm_guest_identity_info 模块 – 返回关于虚拟机客机的详细信息。

注意

此模块是 vmware.vmware_rest 集合 (版本 4.3.0) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在剧本中使用它,请指定: vmware.vmware_rest.vcenter_vm_guest_identity_info

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 返回关于虚拟机客机的详细信息。

要求

以下是执行此模块的主机所需的条件。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

整个操作(包括建立连接、发送请求和响应)的最大秒数。

默认值为 300 秒。

vcenter_hostname

字符串 / 必需

vSphere vCenter 的主机名或 IP 地址

如果任务中未指定此值,则将使用环境变量 VMWARE_HOST 的值。

vcenter_password

字符串 / 必需

vSphere vCenter 密码

如果任务中未指定此值,则将使用环境变量 VMWARE_PASSWORD 的值。

vcenter_rest_log_file

字符串

您可以使用此可选参数来设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行模块的主机上。

如果任务中未指定此值,则将使用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

字符串 / 必需

vSphere vCenter 用户名

如果任务中未指定此值,则将使用环境变量 VMWARE_USER 的值。

vcenter_validate_certs

布尔值

在 SSL 证书无效时允许连接。当证书不受信任时,将其设置为 false

如果任务中未指定此值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

vm

字符串

虚拟机的标识符。

此参数必须是由 vmware.vmware_rest.vcenter_vm_info 返回的资源的 ID。在 *state=[‘get’]* 时需要。

备注

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Get guest identity information
  vmware.vmware_rest.vcenter_vm_guest_identity_info:
    vm: '{{ test_vm1_info.id }}'
  register: _result

返回值

常见的返回值已记录在 此处,以下是此模块特有的字段

描述

字典

获取虚拟机客机身份信息

返回: 成功时

示例: {"family": "LINUX", "full_name": {"args": [], "default_message": "Red Hat Fedora (64-bit)", "id": "vmsg.guestos.fedora64Guest.label"}, "host_name": "localhost.localdomain", "name": "FEDORA_64"}

作者

  • Ansible 云团队 (@ansible-collections)