|
| 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 | +* [`sysctl`](#sysctl): Manages entries in /etc/sysctl.conf. |
| 10 | + |
| 11 | +## Resource types |
| 12 | + |
| 13 | +### <a name="sysctl"></a>`sysctl` |
| 14 | + |
| 15 | +Manages entries in /etc/sysctl.conf. |
| 16 | + |
| 17 | +#### Properties |
| 18 | + |
| 19 | +The following properties are available in the `sysctl` type. |
| 20 | + |
| 21 | +##### `comment` |
| 22 | + |
| 23 | +Text to be stored in a comment immediately above the entry. It will be automatically prepended with the name of the setting in order for the provider to know whether it controls the comment or not. |
| 24 | + |
| 25 | +##### `ensure` |
| 26 | + |
| 27 | +Valid values: `present`, `absent` |
| 28 | + |
| 29 | +The basic property that the resource should be in. |
| 30 | + |
| 31 | +Default value: `present` |
| 32 | + |
| 33 | +##### `val` |
| 34 | + |
| 35 | +An alias for 'value'. Maintains interface compatibility with the traditional ParsedFile sysctl provider. If both are set, 'value' will take precedence over 'val'. |
| 36 | + |
| 37 | +##### `value` |
| 38 | + |
| 39 | +Value to change the setting to. Settings with multiple values (such as net.ipv4.tcp_mem) are represented as a single whitespace separated string. |
| 40 | + |
| 41 | +#### Parameters |
| 42 | + |
| 43 | +The following parameters are available in the `sysctl` type. |
| 44 | + |
| 45 | +* [`apply`](#-sysctl--apply) |
| 46 | +* [`name`](#-sysctl--name) |
| 47 | +* [`persist`](#-sysctl--persist) |
| 48 | +* [`provider`](#-sysctl--provider) |
| 49 | +* [`silent`](#-sysctl--silent) |
| 50 | +* [`target`](#-sysctl--target) |
| 51 | + |
| 52 | +##### <a name="-sysctl--apply"></a>`apply` |
| 53 | + |
| 54 | +Valid values: `true`, `false` |
| 55 | + |
| 56 | +Whether to apply the value using the sysctl command. |
| 57 | + |
| 58 | +Default value: `true` |
| 59 | + |
| 60 | +##### <a name="-sysctl--name"></a>`name` |
| 61 | + |
| 62 | +namevar |
| 63 | + |
| 64 | +The name of the setting, e.g. net.ipv4.ip_forward |
| 65 | + |
| 66 | +##### <a name="-sysctl--persist"></a>`persist` |
| 67 | + |
| 68 | +Valid values: `true`, `false` |
| 69 | + |
| 70 | +Persist the value in the on-disk file ($target). |
| 71 | + |
| 72 | +Default value: `true` |
| 73 | + |
| 74 | +##### <a name="-sysctl--provider"></a>`provider` |
| 75 | + |
| 76 | +The specific backend to use for this `sysctl` resource. You will seldom need to specify this --- Puppet will usually |
| 77 | +discover the appropriate provider for your platform. |
| 78 | + |
| 79 | +##### <a name="-sysctl--silent"></a>`silent` |
| 80 | + |
| 81 | +Valid values: `true`, `false` |
| 82 | + |
| 83 | +If set, do not report an error if the system key does not exist. This is useful for systems that may need to load a |
| 84 | +kernel module prior to the sysctl values existing. |
| 85 | + |
| 86 | +Default value: `false` |
| 87 | + |
| 88 | +##### <a name="-sysctl--target"></a>`target` |
| 89 | + |
| 90 | +The file in which to store the settings, defaults to |
| 91 | +`/etc/sysctl.conf`. |
| 92 | + |
0 commit comments