summaryrefslogtreecommitdiff
path: root/lib/chef/resource/windows_firewall_profile.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2021-02-15 13:01:38 -0800
committerTim Smith <tsmith84@gmail.com>2021-02-15 13:01:38 -0800
commitb3057cc7f55fadd57e54dba45242f692806bc2ba (patch)
tree2d4a8511bb6ecb8813e89a9d85c2986673d005a2 /lib/chef/resource/windows_firewall_profile.rb
parent7eb9179ed6eaf024f62546001544ea2caa3d184c (diff)
downloadchef-docs.tar.gz
Improve automatic docs generationdocs
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/windows_firewall_profile.rb')
-rw-r--r--lib/chef/resource/windows_firewall_profile.rb4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/chef/resource/windows_firewall_profile.rb b/lib/chef/resource/windows_firewall_profile.rb
index ada9729699..c56942ed72 100644
--- a/lib/chef/resource/windows_firewall_profile.rb
+++ b/lib/chef/resource/windows_firewall_profile.rb
@@ -121,7 +121,7 @@ class Chef
end
end
- action :enable do
+ action :enable, description: "Enable and optionally configure a Windows Firewall profile" do
converge_if_changed :default_inbound_action, :default_outbound_action, :allow_inbound_rules, :allow_local_firewall_rules,
:allow_local_ipsec_rules, :allow_user_apps, :allow_user_ports, :allow_unicast_response, :display_notification do
fw_cmd = firewall_command(new_resource.profile)
@@ -135,7 +135,7 @@ class Chef
end
end
- action :disable do
+ action :disable, description: "Disable a Windows Firewall profile" do
if firewall_enabled?(new_resource.profile)
converge_by "Disable the #{new_resource.profile} Firewall Profile" do
cmd = "Set-NetFirewallProfile -Profile #{new_resource.profile} -Enabled \"False\""