community.vmware.vmware_cfg_backup 模块 – 备份/恢复/重置 ESXi 主机配置
注意
此模块是 community.vmware 集合(版本 5.2.0)的一部分。
如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list。
要安装它,请使用:ansible-galaxy collection install community.vmware。
要在 playbook 中使用它,请指定:community.vmware.vmware_cfg_backup。
概要
- 此模块可用于执行与 ESXi 主机配置的备份、恢复和重置相关的各种操作。 
参数
| 参数 | 注释 | 
|---|---|
| 将保存 ESXi 配置捆绑包的目标位置。可以是文件夹或文件。 如果是文件夹,备份文件将保存在该文件夹中,文件名由 ESXi 服务器生成默认文件名。 如果是文件,备份文件将使用该文件名保存。文件扩展名始终为 .tgz。 | |
| ESXi 服务器的名称。仅当针对 vCenter 进行身份验证时才需要此项。 | |
| vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值,则将使用环境变量  | |
| vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值,则将使用环境变量  | |
| 将接收所有 HTTPS 请求并转发它们的 HTTP 代理端口。 如果任务中未指定该值,则将使用环境变量  | |
| 包含将要恢复的 ESXi 配置的文件。 | |
| vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定该值,则将使用环境变量  | |
| 当 SSL 证书无效时允许连接。当证书不受信任时,设置为  如果任务中未指定该值,则将使用环境变量  选项 
 | 
说明
注意
- 仅适用于 ESXi 主机 
- 对于配置加载或重置,主机将自动切换到维护模式。 
- 所有模块都需要 API 写入访问权限,因此免费 ESXi 许可证不支持该模块。 
- 所有变量和 VMware 对象名称都区分大小写。 
示例
- name: Save the ESXi configuration locally by authenticating directly against the ESXi host
  community.vmware.vmware_cfg_backup:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    state: saved
    dest: /tmp/
  delegate_to: localhost
- name: Save the ESXi configuration locally by authenticating against the vCenter and selecting the ESXi host
  community.vmware.vmware_cfg_backup:
    hostname: '{{ vcenter_hostname }}'
    esxi_hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    state: saved
    dest: /tmp/
  delegate_to: localhost
返回值
常见的返回值记录在这里,以下是此模块独有的字段
| 键 | 描述 | 
|---|---|
| 存储 ESXi 配置文件的完整路径 返回: changed 示例:  | 
