community.vmware.vmware_host_scanhba 模块 – 重新扫描主机 HBA 并可选地刷新存储系统

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.vmware

要在 playbook 中使用它,请指定: community.vmware.vmware_host_scanhba

概要

  • 此模块可以强制重新扫描主机的 HBA 子系统,这在需要挂载新的数据存储时是必需的。

  • 在使用 community.vmware.vmware_host_datastore 挂载新的数据存储之前,您可以使用此模块来确保您的设备/卷已准备就绪。

  • 您还可以选择强制刷新 vCenter/ESXi Web Client 中的存储系统。

  • 您可以提供 esxi_hostname 或 cluster_name

参数

参数

注释

cluster_name

字符串

要对其重新扫描存储子系统的集群名称(这将在集群中的每个主机上运行重新扫描任务)。

esxi_hostname

字符串

要对其重新扫描存储子系统的 ESXi 主机名。

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

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

password

别名:pass,pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

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

port

整数

vSphere vCenter 或 ESXi 服务器的端口号。

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

默认值: 443

proxy_host

字符串

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式为主机名或 IP。

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

proxy_port

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

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

refresh_storage

布尔值

为找到的每个主机刷新 vCenter/ESXi Web Client 中的存储系统

选项

  • false ← (默认)

  • true

rescan_hba

布尔值

重新扫描所有主机总线适配器以查找新的存储设备。重新扫描所有适配器可能会很慢。

选项

  • false

  • true ← (默认)

rescan_vmfs

布尔值

重新扫描所有已知的存储设备以查找新的 VMFS 卷。

选项

  • false ← (默认)

  • true

username

别名:admin,user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

备注

注意

  • 所有模块都需要 API 写入权限,因此在免费 ESXi 许可证上不支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Rescan HBA's for a given ESXi host and refresh storage system objects
  community.vmware.vmware_host_scanhba:
      hostname: '{{ vcenter_hostname }}'
      username: '{{ vcenter_username }}'
      password: '{{ vcenter_password }}'
      esxi_hostname: '{{ inventory_hostname }}'
      refresh_storage: true
  delegate_to: localhost

- name: Rescan HBA's for a given cluster - all found hosts will be scanned
  community.vmware.vmware_host_scanhba:
      hostname: '{{ vcenter_hostname }}'
      username: '{{ vcenter_username }}'
      password: '{{ vcenter_password }}'
      esxi_hostname: '{{ inventory_hostname }}'
      refresh_storage: true
  delegate_to: localhost

- name: Rescan for new VMFS Volumes in a given cluster, but do not scan for new Devices - all found hosts will be scanned
  community.vmware.vmware_host_scanhba:
      hostname: '{{ vcenter_hostname }}'
      username: '{{ vcenter_username }}'
      password: '{{ vcenter_password }}'
      esxi_hostname: '{{ inventory_hostname }}'
      rescan_vmfs: true
      rescan_hba: false
  delegate_to: localhost

- name: Rescan HBA's for a given ESXi host and don't refresh storage system objects
  community.vmware.vmware_host_scanhba:
      hostname: '{{ vcenter_hostname }}'
      username: '{{ vcenter_username }}'
      password: '{{ vcenter_password }}'
      esxi_hostname: '{{ inventory_hostname }}'
  delegate_to: localhost

返回值

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

描述

result

字典

返回请求的主机和已更新/刷新的存储系统的确认信息

返回:始终

示例: {"esxi01.example.com": {"refreshed_storage": "true", "rescaned_hba": "true", "rescaned_vmfs": "true"}}

作者

  • Michael Eaton (@michaeldeaton)