chef 18.10.17 → 19.2.12

data/lib/chef/resource/windows_audit_policy.rb

@@ -2,7 +2,7 @@
 # Author:: Ross Moles (<rmoles@chef.io>)
 # Author:: Rachel Rice (<rrice@chef.io>)
 # Author:: Davin Taddeo (<davin@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -89,36 +89,36 @@ class Chef
       introduced "16.2"
 
       examples <<~DOC
-        **Set Logon and Logoff policy to "Success and Failure"**:
-
-        ```ruby
-        windows_audit_policy "Set Audit Policy for 'Logon and Logoff' actions to 'Success and Failure'" do
-          subcategory %w(Logon Logoff)
-          success true
-          failure true
-          action :set
-        end
-        ```
+      **Set Logon and Logoff policy to "Success and Failure"**:
+
+      ```ruby
+      windows_audit_policy "Set Audit Policy for 'Logon and Logoff' actions to 'Success and Failure'" do
+        subcategory %w(Logon Logoff)
+        success true
+        failure true
+        action :set
+      end
+      ```
 
-        **Set Credential Validation policy to "Success"**:
+      **Set Credential Validation policy to "Success"**:
 
-        ```ruby
-        windows_audit_policy "Set Audit Policy for 'Credential Validation' actions to 'Success'" do
-          subcategory 'Credential Validation'
-          success true
-          failure false
-          action :set
-        end
-        ```
+      ```ruby
+      windows_audit_policy "Set Audit Policy for 'Credential Validation' actions to 'Success'" do
+        subcategory 'Credential Validation'
+        success true
+        failure false
+        action :set
+      end
+      ```
 
-        **Enable CrashOnAuditFail option**:
+      **Enable CrashOnAuditFail option**:
 
-        ```ruby
-        windows_audit_policy 'Enable CrashOnAuditFail option' do
-          crash_on_audit_fail true
-          action :set
-        end
-        ```
+      ```ruby
+      windows_audit_policy 'Enable CrashOnAuditFail option' do
+        crash_on_audit_fail true
+        action :set
+      end
+      ```
       DOC
 
       property :subcategory, [String, Array],
@@ -127,28 +127,28 @@ class Chef
         callbacks: { "Subcategories entered should be actual advanced audit policy subcategories" => proc { |n| (Array(n) - WIN_AUDIT_SUBCATEGORIES).empty? } }
 
       property :success, [true, false],
-        description: "Specify success auditing. By setting this property to true the resource will enable success for the category or sub category. Success is the default and is applied if neither success nor failure are specified."
+               description: "Specify success auditing. By setting this property to true the resource will enable success for the category or sub category. Success is the default and is applied if neither success nor failure are specified."
 
       property :failure, [true, false],
-        description: "Specify failure auditing. By setting this property to true the resource will enable failure for the category or sub category. Success is the default and is applied if neither success nor failure are specified."
+               description: "Specify failure auditing. By setting this property to true the resource will enable failure for the category or sub category. Success is the default and is applied if neither success nor failure are specified."
 
       property :include_user, String,
-        description: "The audit policy specified by the category or subcategory is applied per-user if specified. When a user is specified, include user. Include and exclude cannot be used at the same time."
+               description: "The audit policy specified by the category or subcategory is applied per-user if specified. When a user is specified, include user. Include and exclude cannot be used at the same time."
 
       property :exclude_user, String,
-        description: "The audit policy specified by the category or subcategory is applied per-user if specified. When a user is specified, exclude user. Include and exclude cannot be used at the same time."
+               description: "The audit policy specified by the category or subcategory is applied per-user if specified. When a user is specified, exclude user. Include and exclude cannot be used at the same time."
 
       property :crash_on_audit_fail, [true, false],
-        description: "Setting this audit policy option to true will cause the system to crash if the auditing system is unable to log events."
+               description: "Setting this audit policy option to true will cause the system to crash if the auditing system is unable to log events."
 
       property :full_privilege_auditing, [true, false],
-        description: "Setting this audit policy option to true will force the audit of all privilege changes except SeAuditPrivilege. Setting this property may cause the logs to fill up more quickly."
+               description: "Setting this audit policy option to true will force the audit of all privilege changes except SeAuditPrivilege. Setting this property may cause the logs to fill up more quickly."
 
       property :audit_base_objects, [true, false],
-        description: "Setting this audit policy option to true will force the system to assign a System Access Control List to named objects to enable auditing of base objects such as mutexes."
+               description: "Setting this audit policy option to true will force the system to assign a System Access Control List to named objects to enable auditing of base objects such as mutexes."
 
       property :audit_base_directories, [true, false],
-        description: "Setting this audit policy option to true will force the system to assign a System Access Control List to named objects to enable auditing of container objects such as directories."
+               description: "Setting this audit policy option to true will force the system to assign a System Access Control List to named objects to enable auditing of container objects such as directories."
 
       action :set, description: "Configure an audit policy." do
         unless new_resource.subcategory.nil?

data/lib/chef/resource/windows_auto_run.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Paul Morton (<pmorton@biaprotect.com>)
 # Copyright:: 2011-2018, Business Intelligence Associates, Inc.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,15 +27,15 @@ class Chef
       description "Use the **windows_auto_run** resource to set applications to run at login."
       introduced "14.0"
       examples <<~DOC
-        **Run BGInfo at login**
+      **Run BGInfo at login**
 
-        ```ruby
-        windows_auto_run 'BGINFO' do
-          program 'C:/Sysinternals/bginfo.exe'
-          args    ''C:/Sysinternals/Config.bgi' /NOLICPROMPT /TIMER:0'
-          action  :create
-        end
-        ```
+      ```ruby
+      windows_auto_run 'BGINFO' do
+        program 'C:/Sysinternals/bginfo.exe'
+        args    "'C:/Sysinternals/Config.bgi' /NOLICPROMPT /TIMER:0"
+        action  :create
+      end
+      ```
       DOC
 
       property :program_name, String,

data/lib/chef/resource/windows_certificate.rb

@@ -2,7 +2,7 @@
 # Author:: Richard Lavey (richard.lavey@calastone.com)
 #
 # Copyright:: 2015-2017, Calastone Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -35,30 +35,30 @@ class Chef
       description "Use the **windows_certificate** resource to install a certificate into the Windows certificate store from a file. The resource grants read-only access to the private key for designated accounts. Due to current limitations in WinRM, installing certificates remotely may not work if the operation requires a user profile. Operations on the local machine store should still work."
       introduced "14.7"
       examples <<~DOC
-        **Add PFX cert to local machine personal store and grant accounts read-only access to private key**
+      **Add PFX cert to local machine personal store and grant accounts read-only access to private key**
 
-        ```ruby
-        windows_certificate 'c:/test/mycert.pfx' do
-          pfx_password 'password'
-          private_key_acl ["acme\\fred", "pc\\jane"]
-        end
-        ```
+      ```ruby
+      windows_certificate 'c:/test/mycert.pfx' do
+        pfx_password 'password'
+        private_key_acl ["acme\\fred", "pc\\jane"]
+      end
+      ```
 
-        **Add cert to trusted intermediate store**
+      **Add cert to trusted intermediate store**
 
-        ```ruby
-        windows_certificate 'c:/test/mycert.cer' do
-          store_name 'CA'
-        end
-        ```
+      ```ruby
+      windows_certificate 'c:/test/mycert.cer' do
+        store_name 'CA'
+      end
+      ```
 
-        **Remove all certificates matching the subject**
+      **Remove all certificates matching the subject**
 
-        ```ruby
-        windows_certificate 'me.acme.com' do
-          action :delete
-        end
-        ```
+      ```ruby
+      windows_certificate 'me.acme.com' do
+        action :delete
+      end
+      ```
       DOC
 
       property :source, String,

data/lib/chef/resource/windows_defender.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Chef Software, Inc.
+#  Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,30 +24,30 @@ class Chef
       description "Use the **windows_defender** resource to enable or disable the Microsoft Windows Defender service."
       introduced "17.3"
       examples <<~DOC
-        **Configure Windows Defender AV settings**:
-
-        ```ruby
-        windows_defender 'Configure Defender' do
-          realtime_protection true
-          intrusion_protection_system true
-          lock_ui true
-          scan_archives true
-          scan_scripts true
-          scan_email true
-          scan_removable_drives true
-          scan_network_files false
-          scan_mapped_drives false
-          action :enable
-        end
-        ```
+      **Configure Windows Defender AV settings**:
+
+      ```ruby
+      windows_defender 'Configure Defender' do
+        realtime_protection true
+        intrusion_protection_system true
+        lock_ui true
+        scan_archives true
+        scan_scripts true
+        scan_email true
+        scan_removable_drives true
+        scan_network_files false
+        scan_mapped_drives false
+        action :enable
+      end
+      ```
 
-        **Disable Windows Defender AV**:
+      **Disable Windows Defender AV**:
 
-        ```ruby
-        windows_defender 'Disable Defender' do
-          action :disable
-        end
-        ```
+      ```ruby
+      windows_defender 'Disable Defender' do
+        action :disable
+      end
+      ```
       DOC
 
       # DisableIOAVProtection

data/lib/chef/resource/windows_defender_exclusion.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Chef Software, Inc.
+#  Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,25 +25,25 @@ class Chef
       description "Use the **windows_defender_exclusion** resource to exclude paths, processes, or file types from Windows Defender realtime protection scanning."
       introduced "17.3"
       examples <<~DOC
-        **Add excluded items to Windows Defender scans**:
-
-        ```ruby
-        windows_defender_exclusion 'Add to things to be excluded from scanning' do
-          paths 'c:\\foo\\bar, d:\\bar\\baz'
-          extensions 'png, foo, ppt, doc'
-          process_paths 'c:\\windows\\system32'
-          action :add
-        end
-        ```
+      **Add excluded items to Windows Defender scans**:
+
+      ```ruby
+      windows_defender_exclusion 'Add to things to be excluded from scanning' do
+        paths 'c:\\foo\\bar, d:\\bar\\baz'
+        extensions 'png, foo, ppt, doc'
+        process_paths 'c:\\windows\\system32'
+        action :add
+      end
+      ```
 
-        **Remove excluded items from Windows Defender scans**:
+      **Remove excluded items from Windows Defender scans**:
 
-        ```ruby
-        windows_defender_exclusion 'Remove things from the list to be excluded' do
-          process_paths 'c:\\windows\\system32'
-          action :remove
-        end
-        ```
+      ```ruby
+      windows_defender_exclusion 'Remove things from the list to be excluded' do
+        process_paths 'c:\\windows\\system32'
+        action :remove
+      end
+      ```
       DOC
 
       property :paths, [String, Array], default: [],

data/lib/chef/resource/windows_dfs_folder.rb

@@ -2,7 +2,7 @@
 # Author:: Jason Field
 #
 # Copyright:: 2018, Calastone Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/resource/windows_dfs_namespace.rb

@@ -2,7 +2,7 @@
 # Author:: Jason Field
 #
 # Copyright:: 2018, Calastone Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/resource/windows_dfs_server.rb

@@ -2,7 +2,7 @@
 # Author:: Jason Field
 #
 # Copyright:: 2018, Calastone Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/resource/windows_dns_record.rb

@@ -2,7 +2,7 @@
 # Author:: Jason Field
 #
 # Copyright:: 2018, Calastone Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/resource/windows_dns_zone.rb

@@ -2,7 +2,7 @@
 # Author:: Jason Field
 #
 # Copyright:: 2018, Calastone Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/chef/resource/windows_env.rb

@@ -30,13 +30,13 @@ class Chef
 
       description "Use the **windows_env** resource to manage environment keys in Microsoft Windows. After an environment key is set, Microsoft Windows must be restarted before the environment key will be available to the Task Scheduler.\n\nThis resource was previously called the **env** resource; its name was updated in #{ChefUtils::Dist::Infra::PRODUCT} 14.0 to reflect the fact that only Windows is supported. Existing cookbooks using `env` will continue to function, but should be updated to use the new name. Note: On UNIX-based systems, the best way to manipulate environment keys is with the `ENV` variable in Ruby; however, this approach does not have the same permanent effect as using the windows_env resource."
       examples <<~DOC
-        **Set an environment variable**:
+      **Set an environment variable**:
 
-        ```ruby
-        windows_env 'ComSpec' do
-          value 'C:\\Windows\\system32\\cmd.exe'
-        end
-        ```
+      ```ruby
+      windows_env 'ComSpec' do
+        value 'C:\\Windows\\system32\\cmd.exe'
+      end
+      ```
       DOC
 
       default_action :create

data/lib/chef/resource/windows_feature.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,59 +27,59 @@ class Chef
       description "Use the **windows_feature** resource to add, remove or entirely delete Windows features and roles. This resource calls the 'windows_feature_dism' or 'windows_feature_powershell' resources depending on the specified installation method, and defaults to DISM, which is available on both Workstation and Server editions of Windows."
       introduced "14.0"
       examples <<~DOC
-        **Install the DHCP Server feature**:
+      **Install the DHCP Server feature**:
 
-        ```ruby
-        windows_feature 'DHCPServer' do
-          action :install
-        end
-        ```
+      ```ruby
+      windows_feature 'DHCPServer' do
+        action :install
+      end
+      ```
 
-        **Install the .Net 3.5.1 feature using repository files on DVD**:
+      **Install the .Net 3.5.1 feature using repository files on DVD**:
 
-        ```ruby
-        windows_feature "NetFx3" do
-          action :install
-          source 'd:\\sources\\sxs'
-        end
-        ```
+      ```ruby
+      windows_feature "NetFx3" do
+        action :install
+        source 'd:\\sources\\sxs'
+      end
+      ```
 
-        **Remove Telnet Server and Client features**:
+      **Remove Telnet Server and Client features**:
 
-        ```ruby
-        windows_feature %w(TelnetServer TelnetClient) do
-          action :remove
-        end
-        ```
+      ```ruby
+      windows_feature %w(TelnetServer TelnetClient) do
+        action :remove
+      end
+      ```
 
-        **Add the SMTP Server feature using the PowerShell provider**:
+      **Add the SMTP Server feature using the PowerShell provider**:
 
-        ```ruby
-        windows_feature 'smtp-server' do
-          action :install
-          all true
-          install_method :windows_feature_powershell
-        end
-        ```
+      ```ruby
+      windows_feature 'smtp-server' do
+        action :install
+        all true
+        install_method :windows_feature_powershell
+      end
+      ```
 
-        **Install multiple features using one resource with the PowerShell provider**:
+      **Install multiple features using one resource with the PowerShell provider**:
 
-        ```ruby
-        windows_feature %w(Web-Asp-Net45 Web-Net-Ext45) do
-          action :install
-          install_method :windows_feature_powershell
-        end
-        ```
+      ```ruby
+      windows_feature %w(Web-Asp-Net45 Web-Net-Ext45) do
+        action :install
+        install_method :windows_feature_powershell
+      end
+      ```
 
-        **Install the Network Policy and Access Service feature, including the management tools**:
+      **Install the Network Policy and Access Service feature, including the management tools**:
 
-        ```ruby
-        windows_feature 'NPAS' do
-          action :install
-          management_tools true
-          install_method :windows_feature_powershell
-        end
-        ```
+      ```ruby
+      windows_feature 'NPAS' do
+        action :install
+        management_tools true
+        install_method :windows_feature_powershell
+      end
+      ```
       DOC
 
       property :feature_name, [Array, String],

data/lib/chef/resource/windows_feature_dism.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,17 +28,17 @@ class Chef
       description "Use the **windows_feature_dism** resource to add, remove, or entirely delete Windows features and roles using DISM."
       introduced "14.0"
       examples <<~DOC
-        **Installing the TelnetClient service**:
+      **Installing the TelnetClient service**:
 
-        ```ruby
-        windows_feature_dism "TelnetClient"
-        ```
+      ```ruby
+      windows_feature_dism "TelnetClient"
+      ```
 
-        **Installing two features by using an array**:
+      **Installing two features by using an array**:
 
-        ```ruby
-        windows_feature_dism %w(TelnetClient TFTP)
-        ```
+      ```ruby
+      windows_feature_dism %w(TelnetClient TFTP)
+      ```
       DOC
 
       property :feature_name, [Array, String],

data/lib/chef/resource/windows_feature_powershell.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Greg Zapp (<greg.zapp@gmail.com>)
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,31 +29,31 @@ class Chef
       description "Use the **windows_feature_powershell** resource to add, remove, or entirely delete Windows features and roles using PowerShell. This resource offers significant speed benefits over the windows_feature_dism resource, but requires installation of the Remote Server Administration Tools on non-server releases of Windows."
       introduced "14.0"
       examples <<~DOC
-        **Add the SMTP Server feature**:
+      **Add the SMTP Server feature**:
 
-        ```ruby
-        windows_feature_powershell "smtp-server" do
-          action :install
-          all true
-        end
-        ```
+      ```ruby
+      windows_feature_powershell "smtp-server" do
+        action :install
+        all true
+      end
+      ```
 
-        **Install multiple features using one resource**:
+      **Install multiple features using one resource**:
 
-        ```ruby
-        windows_feature_powershell ['Web-Asp-Net45', 'Web-Net-Ext45'] do
-          action :install
-        end
-        ```
+      ```ruby
+      windows_feature_powershell ['Web-Asp-Net45', 'Web-Net-Ext45'] do
+        action :install
+      end
+      ```
 
-        **Install the Network Policy and Access Service feature**:
+      **Install the Network Policy and Access Service feature**:
 
-        ```ruby
-        windows_feature_powershell 'NPAS' do
-          action :install
-          management_tools true
-        end
-        ```
+      ```ruby
+      windows_feature_powershell 'NPAS' do
+        action :install
+        management_tools true
+      end
+      ```
       DOC
 
       property :feature_name, [Array, String],