community / community.vmware / 4.2.0 / module / vmware_host_service_manager Manage services on a given ESXi host Authors: Abhijeet Kasurde (@Akasurde)community.vmware.vmware_host_service_manager (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to manage (start, stop, restart) services on a given ESXi host.
If cluster_name is provided, specified service will be managed on all ESXi host belonging to that cluster.
If specific esxi_hostname is provided, then specified service will be managed on given ESXi host only.
- 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
port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int state: choices: - absent - present - restart - start - stop - unchanged default: start description: - Desired state of service. - V(start) and V(present) has same effect. - V(stop) and V(absent) has same effect. - V(unchanged) allows defining O(service_policy) without defining or changing service state. type: str hostname: description: - The hostname or IP address of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int cluster_name: description: - Name of the cluster. - Service settings are applied to every ESXi host system/s in given cluster. - If O(esxi_hostname) is not given, this parameter is required. type: str service_name: description: - Name of Service to be managed. This is a brief identifier for the service, for example, ntpd, vxsyslogd etc. - This value should be a valid ESXi service name. required: true type: str esxi_hostname: description: - ESXi hostname. - Service settings are applied to this ESXi host system. - If O(cluster_name) is not given, this parameter is required. type: str service_policy: choices: - automatic - 'off' - 'on' description: - Set of valid service policy strings. - If set V(on), then service should be started when the host starts up. - If set V(automatic), then service should run if and only if it has open firewall ports. - If set V(off), then Service should not be started when the host starts up. type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool