Skip to content

Latest commit

 

History

History
90 lines (49 loc) · 2.14 KB

REFERENCE.md

File metadata and controls

90 lines (49 loc) · 2.14 KB

Reference

Table of Contents

Resource types

Resource types

windows_env

Manages Windows environment variables

Properties

The following properties are available in the windows_env type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

type

Valid values: REG_SZ, REG_EXPAND_SZ

What type of registry key to use for the variable. Determines whether interpolation of '%' enclosed names will occur

Parameters

The following parameters are available in the windows_env type.

broadcast_timeout

Set the timeout (in ms) for environment refreshes. This is per top level window, so delay may be longer than provided value.

Default value: 100

mergemode

Valid values: clobber, insert, append, prepend

How to set the value of the environment variable. E.g. replace existing value, append to existing value...

Default value: insert

provider

The specific backend to use for this windows_env resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

separator

How to separate environment variables with multiple values (e.g. PATH)

Default value: ;

user

namevar

Set the user whose environment will be modified

value

namevar

The environment variable value

variable

namevar

The environment variable name