vmware.vmware_rest.appliance_vmon_service module – Manage vCenter appliance service states.

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

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This endpoint is no longer supported by Broadcom.

Alternative:

Use vmware.vmware_rest.appliance_services for service management.

Synopsis

  • Start, stop, or restart a vCenter appliance service.

  • This module can also be used to manage a service’s startup settings.

  • This module is not idempotent.

Parameters

Parameter

Comments

request_body

dictionary

Properties to set when managing a service and state is present.

startup_type

string / required

The type of startup strategy for the service.

Choices:

  • "AUTOMATIC"

  • "DISABLED"

  • "MANUAL"

service

string / required

Identifier of the service whose state is being managed.

session_timeout

float

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

Default: 300.0

state

string

Whether to attempt to start or stop the service, or manage the the startup_type (present).

Choices:

  • "start"

  • "stop"

  • "present" ← (default)

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

  • Not compatible with vSphere API 7.0.3.

  • Not compatible with vSphere API 9.1.0.

Examples

- name: Adjust vpxd configuration
  vmware.vmware_rest.appliance_vmon_service:
    service: vpxd
    startup_type: AUTOMATIC

- name: Start the vpxd configuration
  vmware.vmware_rest.appliance_vmon_service:
    service: vpxd
    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: {}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

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