Sha256: a11668b00bce395fc63b28853e7d538dea0b3e2a6f5b197bd553488fe3eb672c

Contents?: true

Size: 1.51 KB

Versions: 30

Compression:

Stored size: 1.51 KB

Contents

#
# Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
# Copyright:: Copyright (c) Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require_relative "../resource"

class Chef
  class Resource
    class WindowsPath < Chef::Resource
      provides(:windows_path) { true }

      description "Use the **windows_path** resource to manage the path environment variable on Microsoft Windows."
      introduced "13.4"
      examples <<~DOC
      **Add Sysinternals to the system path**:

      ```ruby
      windows_path 'C:\\Sysinternals' do
        action :add
      end
      ```

      **Remove 7-Zip from the system path**:

      ```ruby
      windows_path 'C:\\7-Zip' do
        action :remove
      end
      ```
      DOC

      allowed_actions :add, :remove
      default_action :add

      property :path, String,
        description: "An optional property to set the path value if it differs from the resource block's name.",
        name_property: true
    end
  end
end

Version data entries

30 entries across 30 versions & 1 rubygems

Version Path
chef-16.6.14-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.6.14 lib/chef/resource/windows_path.rb
chef-16.5.77 lib/chef/resource/windows_path.rb
chef-16.5.77-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.5.64 lib/chef/resource/windows_path.rb
chef-16.5.64-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.4.41 lib/chef/resource/windows_path.rb
chef-16.4.41-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.4.38 lib/chef/resource/windows_path.rb
chef-16.4.38-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.4.35 lib/chef/resource/windows_path.rb
chef-16.4.35-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.3.45 lib/chef/resource/windows_path.rb
chef-16.3.45-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.3.38 lib/chef/resource/windows_path.rb
chef-16.3.38-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.2.73 lib/chef/resource/windows_path.rb
chef-16.2.73-universal-mingw32 lib/chef/resource/windows_path.rb
chef-16.2.50 lib/chef/resource/windows_path.rb
chef-16.2.50-universal-mingw32 lib/chef/resource/windows_path.rb