Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/puppetlabs/puppetlabs-windows_env

Puppet module for managing Windows environment variables.
https://github.com/puppetlabs/puppetlabs-windows_env

hacktoberfest module puppet supported windows-puppet-module

Last synced: 4 days ago
JSON representation

Puppet module for managing Windows environment variables.

Awesome Lists containing this project

README 

        
# windows_env



[![Donated by Vox Pupuli](https://img.shields.io/badge/donated%20by-Vox%20Pupuli-fb7047.svg)](#transfer-notice)



This module manages (system and user) Windows environment variables.



## Installation



Install from puppet forge:



```sh

puppet module install puppet/windows_env

```



Install from git (do this in your modulepath):



```sh

git clone https://github.com/puppetlabs/puppetlabs-windows_env windows_env

```



## Changes



[CHANGELOG.md](CHANGELOG.md)



## Compatibility



This module is currently tested against Puppet 4.10 and latest Puppet 5

releases. You can see the range of supported Puppet versions in the

[metadata.json](metadata.json).



## Usage



### Parameters



#### `ensure`



Standard ensure, valid values are `absent` or `present`. Defaults to `present`.



#### `variable` (namevar)



The name of the environment variable. This will be inferred from the title if

not given explicitly. The title can be of either the form `{variable}={value}`

(the fields will be split on the first `=`) or just `{variable}`.



#### `value` (namevar)



The value of the environment variable. How this will treat existing content

depends on `mergemode`.



#### `user` (namevar)



The user whose environment will be modified. Default is `undef`, i.e. system

environment. The user can be local or domain, as long as they have a local

profile (typically `C:\users\{username}` on Vista+). There is no awareness of

network profiles in this module; knowing how changes to the local profile will

affect a distributed profile is up to you.



#### `separator`



How to split entries in environment variables with multiple values (such as

`PATH` or `PATHEXT`) . Default is `';'`.



#### `mergemode`



Specifies how to treat content already in the environment variable, and how to

handle deletion of variables. Default is `insert`.



Valid values:



- `clobber`

  - When `ensure => present`, creates a new variable (if necessary) and sets

    its value. If the variable already exists, its value will be overwritten.

  - When `ensure => absent`, the environment variable will be deleted entirely.

- `insert`

  - When `ensure => present`, creates a new variable (if necessary) and sets

    its value. If the variable already exists, the puppet resource provided

    content will be merged with the existing content. The puppet provided content

    will be placed at the end, and separated from existing entries with

    `separator`. If the specified value is already somewhere in the variable, no

    change will occur.

  - When `ensure => absent`, the value provided by the puppet resource will be

    removed from the environment variable. Other content will be left

    unchanged. The environment variable will not be removed, even if its

    contents are blank.

- `prepend`

  - Same as `insert`, except Puppet will ensure the value appears **first**. If

    the specified value is already in the variable, but not at the beginning, it

    will be moved to the beginning. In the case of multiple resources in

    `prepend` mode managing the same variable, the values will be inserted in the

    order of evaluation (the last to run will be listed first in the variable).

    Note that with multiple `prepend`s on the same resource, there will be

    shuffling around on every puppet run, since each resource will place its own

    value at the front of the list when it is run. Alternatively, an array can be

    provided to `value`. The relative ordering of the array items will be

    maintained when they are inserted into the variable, and the shuffling will

    be avoided.

- `append`

  - Same as `prepend`, except the new value will be placed at (or be moved to) the end of the

    variable's existing contents rather than the beginning.



#### `type`



The type of registry value to use. Default is `undef` for existing keys (i.e.

don't change the type) and `REG_SZ` when creating new keys.



Valid values:



- `REG_SZ`

  - This is a regular registry string item with no substitution.

- `REG_EXPAND_SZ`

  - Values of this type will expand '%' enclosed strings (e.g. `%SystemRoot%`)

    derived from other environment variables. If you're on a 64-bit system and

    running 32-bit puppet, be careful here; registry writes may be subject to

    WoW64 registry redirection shenanigans. This module writes keys with the

    KEY_WOW64_64KEY flag, which on Windows 7+ (Server 2008 R2) systems will

    disable value rewriting. Older systems will rewrite certain values. The

    gory details can be found here:

    http://msdn.microsoft.com/en-us/library/windows/desktop/aa384232%28v=vs.85%29.aspx

    .



#### `broadcast_timeout`



Specifies how long (in ms) to wait (per window) for refreshes to go through

when environment variables change. Default is 100ms. This probably doesn't

need changing unless you're having issues with the refreshes taking a long time

(they generally happen nearly instantly). Note that this only works for the user

that initiated the puppet run; if puppet runs in the background, updates to the

environment will not propagate to logged in users until they log out and back in

or refresh their environment by some other means.



### Examples



```puppet



    # Title type #1. Variable name and value are extracted from title, splitting on '='.

    # Default 'insert' mergemode is selected and default 'present' ensure is selected,

    # so this will add 'C:\code\bin' to PATH, merging it neatly with existing content.

    windows_env { 'PATH=C:\code\bin': }



    # Title type #2. Variable name is derived from the title, but not value (because there is no '=').

    # This will remove the environment variable 'BADVAR' completely.

    windows_env { 'BADVAR':

      ensure    => absent,

      mergemode => clobber,

    }



    # Title type #3. Title doesn't set parameters (because both 'variable' and 'value' have

    # been supplied manually).

    # This will create a new environment variable 'MyVariable' and set its value to 'stuff'.

    # If the variable already exists, its value will be replaced with 'stuff'.

    windows_env {'random_title':

      ensure    => present,

      variable  => 'MyVariable',

      value     => 'stuff',

      mergemode => clobber,

    }



    # Variables with type => 'REG_EXPAND_SZ' allow other environment variables to be used

    # by enclosing them in percent symbols.

    windows_env { 'JAVA_HOME=%ProgramFiles%\Java\jdk1.6.0_02':

      type => 'REG_EXPAND_SZ',

    }



    # Create an environment variable for 'Administrator':

    windows_env { 'KOOLVAR':

      value => 'hi',

      user  => 'Administrator',

    }



    # Create an environment variable for 'Domain\FunUser':

    windows_env { 'Funvar':

      value => 'Funval',

      user  => 'Domain\FunUser',

    }



    # Creates (if needed) an enviroment variable 'VAR', and sticks 'VAL:VAL2' at

    # the beginning. Separates with : instead of ;. The broadcast_timeout change

    # probably won't make any difference.

    windows_env { 'title':

      ensure            => present,

      mergemode         => prepend,

      variable          => 'VAR',

      value             => ['VAL', 'VAL2'],

      separator         => ':',

      broadcast_timeout => 2000,

    }



    # Exec doStuff.bat whenever environment variable KOOLVAR changes.

    # Note that if you have multiple windows_env resources managing one

    # variable, you'll need to either subscribe to all of them or combine

    # the windows_env resources into one (by passing an array to 'value')

    # and subscribing to that one resource.

    exec { 'C:\doStuff.bat':

      subscribe   => Windows_env['KOOLVAR'],

      refreshonly => true,

    }

```



## Facts



### `windows_env`



A structured fact which lists the following Windows environment variables



- ALLUSERSPROFILE

- APPDATA

- COMMONPROGRAMFILES

- COMMONPROGRAMFILES(X86)

- HOME

- HOMEDRIVE

- HOMEPATH

- LOCALAPPDATA

- PATHEXT

- PROCESSOR_IDENTIFIER

- PROCESSOR_LEVEL

- PROCESSOR_REVISION

- PROGRAMDATA

- PROGRAMFILES

- PROGRAMFILES(X86)

- PSMODULEPATH

- PUBLIC

- SYSTEMDRIVE

- SYSTEMROOT

- TEMP

- TMP

- USERPROFILE

- WINDIR



Note that the names will appear as uppercase in the fact, for example the `windir` environment variable will appears as `WINDIR` in the fact



### Examples



```puppet

    $app_data = $facts['windows_env']['APPDATA']



    # Output the AppData path in the puppet log

    notify { $app_data: }

```



## Acknowledgements



The [puppet-windows-path](https://github.com/basti1302/puppet-windows-path)

module by Bastian Krol was the starting point for this module.

puppetlabs-windows_env got migrated from [badgerious](https;//github.com/badgerious)

to Vox Pupuli.



## License



This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.



## Transfer notice



This module was previously maintained by Vox Pupuli. It was migrated to Puppet/Perforce in 2023.