vmware.vmware_rest.vcenter_vm_hardware_info 模块 – 返回虚拟机的虚拟硬件设置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：vmware.vmware_rest.vcenter_vm_hardware_info。

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 返回虚拟机的虚拟硬件设置。

要求

以下要求需要在执行此模块的主机上满足。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

session_timeout

float

在 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 the hardware information
  vmware.vmware_rest.vcenter_vm_hardware_info:
    vm: '{{ search_result.value[0].vm }}'
  register: my_vm1_hardware_info

返回值

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

键

描述

值

字典

收集硬件信息

返回： 成功时

示例： {"upgrade_policy": "NEVER", "upgrade_status": "NONE", "version": "VMX_10"}

作者

  • Ansible Cloud 团队 (@ansible-collections)