Sha256: 22832bd034dfad7d3f26a21cb43105a6da37338666b974e6d3b16ae89884b578
Contents?: true
Size: 1.99 KB
Versions: 30
Compression:
Stored size: 1.99 KB
Contents
#
# Author:: Doug MacEachern (<dougm@vmware.com>)
# Author:: Tyler Cloke (<tyler@chef.io>)
# Copyright:: Copyright 2010-2016, VMware, 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 WindowsEnv < Chef::Resource
provides :windows_env
provides :env # backwards compat with the pre-Chef 14 resource name
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."
examples <<~DOC
**Set an environment variable**:
```ruby
windows_env 'ComSpec' do
value 'C:\\Windows\\system32\\cmd.exe'
end
```
DOC
default_action :create
allowed_actions :create, :delete, :modify
property :key_name, String,
description: "An optional property to set the name of the key that is to be created, deleted, or modified if it differs from the resource block's name.",
name_property: true
property :value, String,
description: "The value of the environmental variable to set.",
required: %i{create modify}
property :delim, [ String, nil, false ],
description: "The delimiter that is used to separate multiple values for a single key.",
desired_state: false
property :user, String, default: "<System>"
end
end
end
Version data entries
30 entries across 30 versions & 1 rubygems