mirror of
https://github.com/inspec/inspec
synced 2024-11-23 13:13:22 +00:00
9cfc86d2ab
Light formatting changes, change order of example and matchers, slight color changes Signed-off-by: hannah-radish <hmaddy@chef.io>
56 lines
1.5 KiB
Text
56 lines
1.5 KiB
Text
---
|
|
title: About the launchd_service Resource
|
|
---
|
|
|
|
# launchd_service
|
|
|
|
Use the ``launchd_service`` InSpec audit resource to test a service using Launchd.
|
|
|
|
<br>
|
|
|
|
## Syntax
|
|
|
|
A ``launchd_service`` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
|
|
|
|
describe launchd_service('service_name') do
|
|
it { should be_installed }
|
|
it { should be_enabled }
|
|
it { should be_running }
|
|
end
|
|
|
|
where
|
|
|
|
* ``('service_name')`` must specify a service name
|
|
* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource; all matchers available to the `service` resource may be used
|
|
|
|
The path to the service manager's control may be specified for situations where the path isn't available in the current ``PATH``. For example:
|
|
|
|
describe launchd_service('service_name', '/path/to/control') do
|
|
it { should be_enabled }
|
|
it { should be_installed }
|
|
it { should be_running }
|
|
end
|
|
|
|
<br>
|
|
|
|
## Matchers
|
|
|
|
This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
|
|
|
|
### be_enabled
|
|
|
|
The `be_enabled` matcher tests if the named service is enabled:
|
|
|
|
it { should be_enabled }
|
|
|
|
### be_installed
|
|
|
|
The `be_installed` matcher tests if the named service is installed:
|
|
|
|
it { should be_installed }
|
|
|
|
### be_running
|
|
|
|
The `be_running` matcher tests if the named service is running:
|
|
|
|
it { should be_running }
|