inspec/docs/resources/bsd_service.md.erb

78 lines
1.7 KiB
Text
Raw Normal View History

2016-09-22 12:43:57 +00:00
---
title: About the bsd_service Resource
platform: linux
2016-09-22 12:43:57 +00:00
---
# bsd_service
Use the `bsd_service` InSpec audit resource to test a service using a Berkeley OS-style `init` on the FreeBSD platform.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
2016-09-22 12:43:57 +00:00
A `bsd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
describe bsd_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.
### Using `bsd_service` resource parameters
#### Path
2016-09-22 12:43:57 +00:00
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 bsd_service('service_name', '/path/to/control') do
it { should be_enabled }
it { should be_installed }
it { should be_running }
end
<br>
2016-09-22 12:43:57 +00:00
## Properties
All properties available to the `service` resource may be used.
<br>
## Matchers
2016-09-22 12:43:57 +00:00
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
2016-09-22 12:43:57 +00:00
### be_enabled
2016-09-22 12:43:57 +00:00
The `be_enabled` matcher tests if the named service is enabled:
it { should be_enabled }
### be_installed
2016-09-22 12:43:57 +00:00
The `be_installed` matcher tests if the named service is installed:
it { should be_installed }
### be_running
2016-09-22 12:43:57 +00:00
The `be_running` matcher tests if the named service is running:
it { should be_running }