community.vmware.vcenter_extension 模块 – 注册/注销 vCenter 扩展

注意

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

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

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

要在剧本中使用它,请指定:community.vmware.vcenter_extension

概要

  • 此模块可用于注册/注销 vCenter 扩展。

参数

参数

注释

client_type

字符串

对于 state=present 是必需的。扩展的客户端类型(win32、.net、linux 等)。

默认值: "vsphere-client-serenity"

company

字符串

对于 state=present 是必需的。制造扩展的公司名称。

description

字符串

对于 state=present 是必需的。扩展的简短描述。

email

字符串

对于 state=present 是必需的。用于扩展的管理员电子邮件。

extension_key

字符串 / 必需

要安装或卸载的扩展的扩展密钥。

hostname

字符串

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

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

name

字符串

对于 state=present 是必需的。您正在安装的扩展的名称。

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 的值。

server_type

字符串

对于 state=present 是必需的。用于安装扩展的服务器类型(SOAP、REST、HTTP 等)。

默认值: "vsphere-client-serenity"

ssl_thumbprint

字符串

对于 state=present 是必需的。扩展托管服务器的 SSL 指纹。

state

字符串

添加或删除 vCenter 扩展。

选项

  • "absent"

  • "present" ← (默认)

url

字符串

对于 state=present 是必需的。指向托管要安装的扩展 zip 文件的服务器的链接。

username

别名: admin, user

字符串

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

version

字符串 / 必需

您正在安装或卸载的扩展的版本。

visible

布尔值

在 vCenter 内的解决方案管理器中显示扩展。

选项

  • false

  • true ← (默认)

说明

注意

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

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

示例

- name: Register vCenter Extension
  community.vmware.vcenter_extension:
     hostname: "{{ groups['vcsa'][0] }}"
     username: "{{ vcenter_username }}"
     password: "{{ site_password }}"
     extension_key: "{{ extension_key }}"
     version: "1.0"
     company: "Acme"
     name: "Acme Extension"
     description: "acme management"
     email: "[email protected]"
     url: "https://10.0.0.1/ACME-vSphere-web-plugin-1.0.zip"
     ssl_thumbprint: "{{ ssl_thumbprint }}"
     state: present
  delegate_to: localhost
  register: register_extension

- name: Deregister vCenter Extension
  community.vmware.vcenter_extension:
     hostname: "{{ groups['vcsa'][0] }}"
     username: "{{ vcenter_username }}"
     password: "{{ site_password }}"
     extension_key: "{{ extension_key }}"
     version: "1.0"
     state: absent
  delegate_to: localhost
  register: deregister_extension

返回值

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

描述

result

字符串

有关执行的操作的信息

返回: 总是

示例: "'com.acme.Extension' installed."

作者

  • Michael Tipton (@castawayegr)