community.vmware.vmware_datastore_maintenancemode 模块 – 将数据存储置于维护模式

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_datastore_maintenancemode。

概要

• 此模块可用于管理数据存储的维护模式。

参数

参数	注释
cluster_name 字符串	数据存储连接到的集群的名称。 如果多个数据存储连接到给定的集群，则所有数据存储都将由 state 管理。 如果未设置 datastore 或 datastore_cluster，则此参数是必需的。
datastore 字符串	要管理的数据存储的名称。 如果未设置 datastore_cluster 或 cluster_name，则此参数是必需的。
datastore_cluster 字符串	要管理的所有子数据存储的数据存储集群的名称。 如果未设置 datastore 或 cluster_name，则此参数是必需的。
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 的值。
state 字符串	如果设置为 present，则将数据存储置于维护模式。 如果设置为 present 并且数据存储已处于维护模式，则不会采取任何操作。 如果设置为 absent 并且数据存储处于维护模式，则退出维护模式。 如果设置为 absent 并且数据存储未处于维护模式，则不会采取任何操作。 选项 "present" ← (默认) "absent"
username 别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定该值，则将使用环境变量 VMWARE_USER 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 false。 如果任务中未指定该值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。 选项 false true ← (默认)

注意

注意

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

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

示例

- name: Enter datastore into Maintenance Mode
  community.vmware.vmware_datastore_maintenancemode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datastore: '{{ datastore_name }}'
    state: present
  delegate_to: localhost

- name: Enter all datastores under cluster into Maintenance Mode
  community.vmware.vmware_datastore_maintenancemode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    state: present
  delegate_to: localhost

- name: Enter all datastores under datastore cluster into Maintenance Mode
  community.vmware.vmware_datastore_maintenancemode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datastore_cluster: '{{ datastore_cluster_name }}'
    state: present
  delegate_to: localhost

- name: Exit datastore into Maintenance Mode
  community.vmware.vmware_datastore_maintenancemode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datastore: '{{ datastore_name }}'
    state: absent
  delegate_to: localhost

返回值

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

键	描述
datastore_status 字典	数据存储采取的动作 返回: 总是 示例: {"ds_226_01": "数据存储 'ds_226_01' 已处于维护模式。"}

作者

• Abhijeet Kasurde (@Akasurde)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)