vmware.vmware_rest.appliance_services_info module – Return the state of vCenter appliance services.

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_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve the current state of one or all vCenter Server Appliance services.

  • Each service reports a human-readable description and its running state.

  • Query a single service by identifier, or omit the identifier to list every service.

Parameters

Parameter

Comments

service

string

Identifier of the service whose state should be queried.

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

If no identifier is provided, the state of all services is returned.

session_timeout

float

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

Default: 300.0

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: Get the state of a single service
  vmware.vmware_rest.appliance_services_info:
    service: ntpd

- name: Get the state of all services
  vmware.vmware_rest.appliance_services_info:

Return Values

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

Key

Description

info

list / elements=dictionary

A list of detailed information about the queried services.

Returned: On success

Sample: [{"key": "ntpd", "value": {"description": "NTP daemon", "state": "STARTED"}}, {"key": "sshd", "value": {"description": "SSH daemon", "state": "STOPPED"}}]

value

dictionary

Detailed information about a single service.

Returned: When only one service was queried

Sample: {"description": "NTP daemon", "state": "STARTED"}

Authors

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