inspec/docs/resources/windows_feature.md.erb
Clinton Wolfe 2de06bdeb5 Clean injection of Availability section (#3206)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-08-09 08:34:49 -04:00

69 lines
1.6 KiB
Text

---
title: About the windows_feature Resource
platform: windows
---
# windows_feature
Use the `windows_feature` InSpec audit resource to test features on Windows via the `Get-WindowsFeature` cmdlet.
<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
A `windows_feature` resource block declares the name of the Windows feature, tests if that feature is installed, and then returns information about that feature:
describe windows_feature('feature_name') do
it { should be_installed }
end
where
* `('feature_name')` must specify a Windows feature name, such as `DHCP Server` or `IIS-Webserver`
* `be_installed` is a valid matcher for this resource
<br>
## Examples
The following examples show how to use this InSpec audit resource.
### Test the DHCP feature (Attempts PowerShell then DISM)
describe windows_feature('DHCP') do
it{ should be_installed }
end
### Test the IIS-WebServer feature using DISM
describe windows_feature('IIS-WebServer', DISM) do
it{ should be_installed }
end
### Test the NetFx3 feature using DISM
describe windows_feature('NetFx3', :dism) do
it{ should be_installed }
end
<br>
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
### be_installed
The `be_installed` matcher tests if the named Windows feature is installed:
it { should be_installed }