|
| 1 | +# Reference |
| 2 | + |
| 3 | +<!-- DO NOT EDIT: This document was generated by Puppet Strings --> |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +### Resource types |
| 8 | + |
| 9 | +* [`windows_env`](#windows_env): Manages Windows environment variables |
| 10 | + |
| 11 | +## Resource types |
| 12 | + |
| 13 | +### <a name="windows_env"></a>`windows_env` |
| 14 | + |
| 15 | +Manages Windows environment variables |
| 16 | + |
| 17 | +#### Properties |
| 18 | + |
| 19 | +The following properties are available in the `windows_env` type. |
| 20 | + |
| 21 | +##### `ensure` |
| 22 | + |
| 23 | +Valid values: `present`, `absent` |
| 24 | + |
| 25 | +The basic property that the resource should be in. |
| 26 | + |
| 27 | +Default value: `present` |
| 28 | + |
| 29 | +##### `type` |
| 30 | + |
| 31 | +Valid values: `REG_SZ`, `REG_EXPAND_SZ` |
| 32 | + |
| 33 | +What type of registry key to use for the variable. Determines whether interpolation of '%' enclosed names will occur |
| 34 | + |
| 35 | +#### Parameters |
| 36 | + |
| 37 | +The following parameters are available in the `windows_env` type. |
| 38 | + |
| 39 | +* [`broadcast_timeout`](#-windows_env--broadcast_timeout) |
| 40 | +* [`mergemode`](#-windows_env--mergemode) |
| 41 | +* [`provider`](#-windows_env--provider) |
| 42 | +* [`separator`](#-windows_env--separator) |
| 43 | +* [`user`](#-windows_env--user) |
| 44 | +* [`value`](#-windows_env--value) |
| 45 | +* [`variable`](#-windows_env--variable) |
| 46 | + |
| 47 | +##### <a name="-windows_env--broadcast_timeout"></a>`broadcast_timeout` |
| 48 | + |
| 49 | +Set the timeout (in ms) for environment refreshes. This is per top level window, so delay may be longer than provided |
| 50 | +value. |
| 51 | + |
| 52 | +Default value: `100` |
| 53 | + |
| 54 | +##### <a name="-windows_env--mergemode"></a>`mergemode` |
| 55 | + |
| 56 | +Valid values: `clobber`, `insert`, `append`, `prepend` |
| 57 | + |
| 58 | +How to set the value of the environment variable. E.g. replace existing value, append to existing value... |
| 59 | + |
| 60 | +Default value: `insert` |
| 61 | + |
| 62 | +##### <a name="-windows_env--provider"></a>`provider` |
| 63 | + |
| 64 | +The specific backend to use for this `windows_env` resource. You will seldom need to specify this --- Puppet will |
| 65 | +usually discover the appropriate provider for your platform. |
| 66 | + |
| 67 | +##### <a name="-windows_env--separator"></a>`separator` |
| 68 | + |
| 69 | +How to separate environment variables with multiple values (e.g. PATH) |
| 70 | + |
| 71 | +Default value: `;` |
| 72 | + |
| 73 | +##### <a name="-windows_env--user"></a>`user` |
| 74 | + |
| 75 | +namevar |
| 76 | + |
| 77 | +Set the user whose environment will be modified |
| 78 | + |
| 79 | +##### <a name="-windows_env--value"></a>`value` |
| 80 | + |
| 81 | +namevar |
| 82 | + |
| 83 | +The environment variable value |
| 84 | + |
| 85 | +##### <a name="-windows_env--variable"></a>`variable` |
| 86 | + |
| 87 | +namevar |
| 88 | + |
| 89 | +The environment variable name |
| 90 | + |
0 commit comments