inspec/docs/resources/windows_hotfix.md.erb
Kimberly Garmoe b0bcc35fda Add one comma in all docs & deletes two repeated sentences. (#2658)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 22:07:18 -05:00

53 lines
1.1 KiB
Text

---
title: About the windows_hotfix Resource
platform: windows
---
# windows_hotfix
Use the `windows_hotfix` InSpec audit resource to test if the hotfix has been installed on a Windows system.
<br>
## Syntax
A `windows_hotfix` resource block declares a hotfix to validate:
describe windows_hotfix('name') do
it { should be_installed }
end
where
* `('name')` must specify the name of a hotfix, such as `'KB4012213'`
* `be_installed` is a valid matcher for this resource
<br>
## Examples
The following examples show how to use this InSpec audit resource.
### Test if KB4012213 is installed
describe windows_hotfix('KB4012213') do
it { should be_installed }
end
### Test that a hotfix is not installed
describe windows_hotfix('KB9999999') do
it { should_not 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 hotfix is installed on the system:
it { should be_installed }