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 主机配置的备份、恢复和重置相关的各种操作。

参数

参数

注释

dest

路径

将保存 ESXi 配置捆绑包的目标位置。可以是文件夹或文件。

如果是文件夹,备份文件将保存在该文件夹中,文件名由 ESXi 服务器生成默认文件名。

如果是文件,备份文件将使用该文件名保存。文件扩展名始终为 .tgz。

esxi_hostname

字符串

ESXi 服务器的名称。仅当针对 vCenter 进行身份验证时才需要此项。

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

src

路径

包含将要恢复的 ESXi 配置的文件。

state

字符串 / 必选

如果为 saved,则 .tgz 备份捆绑包将保存在 dest 中。

如果为 absent,则主机配置将重置为默认值。

如果为 loaded,则 src 中的备份文件将被加载到 ESXi 主机,从而重写主机设置。

选项

  • "saved"

  • "absent"

  • "loaded"

username

别名:admin, user

字符串

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

说明

注意

  • 仅适用于 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

返回值

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

描述

dest_file

字符串

存储 ESXi 配置文件的完整路径

返回: changed

示例: "/tmp/configBundle-esxi.host.domain.tgz"

作者

  • Andreas Nafpliotis (@nafpliot-ibm)