vmware.vmware_rest.vcenter_host 模块 – 在 vCenter 清单中添加新的独立主机

注意

此模块是 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_host。

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 在 vCenter 清单中添加新的独立主机。新连接的主机将处于连接状态。vCenter Server 将在将主机添加到其清单之前验证 SSL 证书。如果由于未识别证书颁发机构或证书为自签名证书而无法验证 SSL 证书，则 vCenter Server 将回退到由 Host.CreateSpec.ThumbprintVerification 定义的指纹验证模式。

要求

执行此模块的主机需要以下要求。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

folder

字符串

应在其中创建新独立主机的 Host 和集群文件夹。

此字段目前是必需的。将来，如果未设置此字段，系统将尝试为主机选择合适的文件夹；如果无法选择文件夹，则主机创建操作将失败。

当客户端将此结构的值作为参数传递时，该字段必须是 vmware.vmware_rest.vcenter_folder_info 返回的资源 ID。

force_add

布尔值

即使主机由另一个 vCenter Server 管理，是否也应将其添加到 vCenter Server。原始 vCenterServer 将断开与主机的连接。

如果未设置，forceAdd 默认值为 false。

选项

  • false

  • true

host

字符串

要断开连接的主机的标识符。

该参数必须是 vmware.vmware_rest.vcenter_host_info 返回的资源 ID。state=[‘absent’, ‘connect’, ‘disconnect’] 时必需

hostname

字符串

主机的 IP 地址或可解析的 DNS 名称。state=[‘present’] 时必需

password

字符串

主机上管理员帐户的密码。state=[‘present’] 时必需

port

整数

主机的端口。

如果未设置，将使用端口 443。

session_timeout

浮点数

vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

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

默认值为 300 秒。

state

字符串

选项

  • "absent"

  • "connect"

  • "disconnect"

  • "present" ← (默认)

thumbprint

字符串

主机应具有的 SSL 证书的指纹。指纹始终使用 SHA1 哈希计算，并且是该哈希的字符串表示形式，格式为：xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx，其中“x”表示十六进制数字。

此字段是可选的，仅当thumbprint_verification的值为 THUMBPRINT 时才相关。

thumbprint_verification

字符串

thumbprint_verification 枚举类型定义了主机 SSL 证书的指纹验证方案。state=[‘present’] 时必需

选项

  • "NONE"

  • "THUMBPRINT"

user_name

字符串

主机上的管理员帐户。state=[‘present’] 时必需

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 ← (默认)

备注

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Connect the host(s)
  vmware.vmware_rest.vcenter_host:
    hostname: "{{ lookup('env', 'ESXI1_HOSTNAME') }}"
    user_name: "{{ lookup('env', 'ESXI1_USERNAME') }}"
    password: "{{ lookup('env', 'ESXI1_PASSWORD') }}"
    thumbprint_verification: NONE
    folder: '{{ my_host_folder.folder }}'

返回值

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

键

描述

值

字符串

连接主机

返回：成功时

示例："host-1013"

作者

  • Ansible 云团队 (@ansible-collections)