vmware.vmware_rest.appliance_services module – Restart, start, or stop a vCenter appliance service.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.appliance_services.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Perform lifecycle actions on a vCenter Server Appliance service.

  • Use this module to restart, start, or stop an individual service by its identifier.

  • This module is not idempotent; the requested action is always performed.

Parameters

Parameter

Comments

service

string

Identifier of the service to act on.

This is the service identifier used by vCenter (for example ntpd).

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

state

string / required

The lifecycle action to perform on the service.

Use restart to restart the service.

Use start to start the service.

Use stop to stop the service.

None of these actions are idempotent; the requested action is always performed.

Choices:

  • "restart"

  • "start"

  • "stop"

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Restart the ntpd service
  vmware.vmware_rest.appliance_services:
    service: ntpd
    state: restart

- name: Stop the ntpd service
  vmware.vmware_rest.appliance_services:
    service: ntpd
    state: stop

- name: Start the ntpd service
  vmware.vmware_rest.appliance_services:
    service: ntpd
    state: start

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

value

any

The raw API response body from the vCenter operation. Empty when the operation returns no content.

Returned: On success

Sample: {}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)