- Description
- Requirements
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Getting help - Some Helpful commands
This module provides the service task. This task allows you to manage and inspect the state of services, including starting, stopping, enabling, and disabling services.
This module is compatible with Puppet Enterprise and Puppet Bolt.
-
To run tasks with Puppet Enterprise, PE 2017.3 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.
-
To run tasks with Puppet Bolt, Bolt 0.5 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.
To run a service task, use the task command, specifying the action and the name of the service.
- With PE on the command line, run
puppet task run service action=<ACTION> name=<SERVICE_NAME>. - With Bolt on the command line, run
bolt task run service action=<ACTION> name=<SERVICE_NAME>.
For example, to check the status of the Apache httpd service, run:
- With PE, run
puppet task run service action=status name=httpd --nodes neptune - With Bolt, run
bolt task run service action=status name=httpd --nodes neptune --modules ~/modules
You can also run tasks in the PE console. See PE task documentation for complete information.
To view the available actions and parameters, on the command line, run puppet task show service or see the service module page on the Forge.
For a complete list of services that are supported see the Puppet services documentation.
To display help for the service task, run puppet task show service
To show help for the task CLI, run puppet task run --help or bolt task run --help