New in version 2.5.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster_name |
Name of the cluster.
Service settings are applied to every ESXi host system/s in given cluster.
If
esxi_hostname is not given, this parameter is required. |
|
| esxi_hostname |
ESXi hostname.
Service settings are applied to this ESXi host system.
If
cluster_name is not given, this parameter is required. |
|
| hostname |
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
VMWARE_HOST will be used instead.Environment variable supported added in version 2.6.
|
|
| password |
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PASSWORD will be used instead.Environment variable supported added in version 2.6.
aliases: pass, pwd |
|
|
port
(added in 2.5) |
Default: 443
|
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PORT will be used instead.Environment variable supported added in version 2.6.
|
|
service_name
required |
Name of Service to be managed. This is brief identifier for the service, for example, ntpd, vxsyslogd etc.
This value should be a valid ESXi service name.
|
|
| service_policy |
|
Set of valid service policy strings.
If set
on, then service should be started when the host starts up.If set
automatic, then service should run if and only if it has open firewall ports.If set
off, then Service should not be started when the host starts up. |
| state |
|
Desired state of service.
State value 'start' and 'present' has same effect.
State value 'stop' and 'absent' has same effect.
|
| username |
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_USER will be used instead.Environment variable supported added in version 2.6.
aliases: user, admin |
|
| validate_certs |
True
|
Allows connection when SSL certificates are not valid. Set to
false when certificates are not trusted.If the value is not specified in the task, the value of environment variable
VMWARE_VALIDATE_CERTS will be used instead.Environment variable supported added in version 2.6.
|
- name: Start ntpd service setting for all ESXi Host in given Cluster
vmware_host_service_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: cluster_name
service_name: ntpd
state: present
- name: Start ntpd setting for an ESXi Host
vmware_host_service_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
service_name: ntpd
state: present
- name: Start ntpd setting for an ESXi Host with Service policy
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
- name: Stop ntpd setting for an ESXi Host
vmware_host_service_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
service_name: ntpd
state: absent
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.