community.vmware.vmware_host_service_manager 模块 – 管理给定 ESXi 主机上的服务

注意

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

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

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

要在 playbook 中使用它,请指定:community.vmware.vmware_host_service_manager

概要

  • 此模块可用于管理(启动、停止、重启)给定 ESXi 主机上的服务。

  • 如果提供了 cluster_name,则指定的服务将在属于该群集的所有 ESXi 主机上进行管理。

  • 如果提供了特定的 esxi_hostname,则指定的服务将仅在给定的 ESXi 主机上进行管理。

参数

参数

注释

cluster_name

字符串

群集的名称。

服务设置将应用于给定群集中的每个 ESXi 主机系统。

如果未给定 esxi_hostname,则此参数是必需的。

esxi_hostname

字符串

ESXi 主机名。

服务设置将应用于此 ESXi 主机系统。

如果未给定 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 的值。

service_name

字符串 / 必需

要管理的服务名称。这是服务的简短标识符,例如 ntpd、vxsyslogd 等。

此值应为有效的 ESXi 服务名称。

service_policy

字符串

一组有效的服务策略字符串。

如果设置为 on,则服务应在主机启动时启动。

如果设置为 automatic,则服务应仅当它具有打开的防火墙端口时才运行。

如果设置为 off,则服务不应在主机启动时启动。

选项

  • "automatic"

  • "off"

  • "on"

state

字符串

服务的所需状态。

startpresent 具有相同的效果。

stopabsent 具有相同的效果。

unchanged 允许在不定义或更改服务状态的情况下定义 service_policy

选项

  • "absent"

  • "present"

  • "restart"

  • "start" ← (默认)

  • "stop"

  • "unchanged"

username

别名:admin, user

字符串

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

注释

注意

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

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

示例

- name: Start ntpd service setting for all ESXi Host in given Cluster
  community.vmware.vmware_host_service_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    service_name: ntpd
    state: present
  delegate_to: localhost

- name: Start ntpd setting for an ESXi Host
  community.vmware.vmware_host_service_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    service_name: ntpd
    state: present
  delegate_to: localhost

- name: Start ntpd setting for an ESXi Host with Service policy
  community.vmware.vmware_host_service_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    service_name: ntpd
    service_policy: 'on'
    state: present
  delegate_to: localhost

- name: Stop ntpd setting for an ESXi Host
  community.vmware.vmware_host_service_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    service_name: ntpd
    state: absent
  delegate_to: localhost

作者

  • Abhijeet Kasurde (@Akasurde)