other/Puppet: modules/apt/REFERENCE.md annotate

annotate modules/apt/REFERENCE.md @ 445:9268fe05d0ab

Add new Ubuntu test nodes

author	IBBoard <dev@ibboard.co.uk>
date	Mon, 08 May 2023 13:45:23 +0100
parents	3fce34f642f1
children	adf6fe9bbc17

rev	line source
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1 # Reference
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	2
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	3 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	4
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	5 ## Table of Contents
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	6
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	7 ### Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	8
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	9 #### Public Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	10
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	11 * [`apt`](#apt): Main class, includes all other classes.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	12 * [`apt::backports`](#aptbackports): Manages backports.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	13
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	14 #### Private Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	15
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	16 * `apt::params`: Provides defaults for the Apt module parameters.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	17 * `apt::update`: Updates the list of available packages using apt-get update.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	18
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	19 ### Defined types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	20
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	21 * [`apt::conf`](#aptconf): Specifies a custom Apt configuration file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	22 * [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	23 * [`apt::mark`](#aptmark): Manages apt-mark settings
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	24 * [`apt::pin`](#aptpin): Manages Apt pins. Does not trigger an apt-get update run.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	25 * [`apt::ppa`](#aptppa): Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	26 * [`apt::setting`](#aptsetting): Manages Apt configuration files.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	27 * [`apt::source`](#aptsource): Manages the Apt sources in /etc/apt/sources.list.d/.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	28
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	29 ### Resource types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	30
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	31 #### Public Resource types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	32
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	33
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	34 #### Private Resource types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	35
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	36 * `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	37 by apt to perform package validation. Apt has it's own GPG keyring that can
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	38 be manipulated through the `apt-key` command.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	39
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	40 ### Data types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	41
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	42 * [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	43 * [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	44 * [`Apt::Proxy_Per_Host`](#aptproxy_per_host): Adds per-host overrides to the system default APT proxy configuration
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	45
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	46 ### Tasks
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	47
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	48 * [`init`](#init): Allows you to perform apt functions
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	49
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	50 ## Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	51
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	52 ### <a name="apt"></a>`apt`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	53
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	54 Main class, includes all other classes.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	55
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	56 * See also
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	57 * https://docs.puppetlabs.com/references/latest/function.html#createresources
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	58 * for the create resource function
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	59
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	60 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	61
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	62 The following parameters are available in the `apt` class:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	63
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	64 * [`provider`](#provider)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	65 * [`keyserver`](#keyserver)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	66 * [`key_options`](#key_options)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	67 * [`ppa_options`](#ppa_options)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	68 * [`ppa_package`](#ppa_package)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	69 * [`backports`](#backports)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	70 * [`confs`](#confs)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	71 * [`update`](#update)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	72 * [`purge`](#purge)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	73 * [`proxy`](#proxy)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	74 * [`sources`](#sources)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	75 * [`keys`](#keys)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	76 * [`ppas`](#ppas)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	77 * [`pins`](#pins)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	78 * [`settings`](#settings)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	79 * [`manage_auth_conf`](#manage_auth_conf)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	80 * [`auth_conf_entries`](#auth_conf_entries)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	81 * [`auth_conf_owner`](#auth_conf_owner)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	82 * [`root`](#root)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	83 * [`sources_list`](#sources_list)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	84 * [`sources_list_d`](#sources_list_d)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	85 * [`conf_d`](#conf_d)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	86 * [`preferences`](#preferences)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	87 * [`preferences_d`](#preferences_d)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	88 * [`config_files`](#config_files)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	89 * [`sources_list_force`](#sources_list_force)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	90 * [`update_defaults`](#update_defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	91 * [`purge_defaults`](#purge_defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	92 * [`proxy_defaults`](#proxy_defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	93 * [`include_defaults`](#include_defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	94 * [`apt_conf_d`](#apt_conf_d)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	95 * [`source_key_defaults`](#source_key_defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	96
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	97 ##### <a name="provider"></a>`provider`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	98
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	99 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	100
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	101 Specifies the provider that should be used by apt::update.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	102
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	103 Default value: `$apt::params::provider`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	104
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	105 ##### <a name="keyserver"></a>`keyserver`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	106
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	107 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	108
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	109 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	110 hkp://).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	111
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	112 Default value: `$apt::params::keyserver`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	113
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	114 ##### <a name="key_options"></a>`key_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	115
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	116 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	117
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	118 Specifies the default options for apt::key resources.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	119
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	120 Default value: `$apt::params::key_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	121
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	122 ##### <a name="ppa_options"></a>`ppa_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	123
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	124 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	125
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	126 Supplies options to be passed to the `add-apt-repository` command.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	127
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	128 Default value: `$apt::params::ppa_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	129
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	130 ##### <a name="ppa_package"></a>`ppa_package`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	131
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	132 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	133
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	134 Names the package that provides the `apt-add-repository` command.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	135
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	136 Default value: `$apt::params::ppa_package`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	137
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	138 ##### <a name="backports"></a>`backports`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	139
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	140 Data type: `Optional[Hash]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	141
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	142 Specifies some of the default parameters used by apt::backports. Valid options: a hash made up from the following keys:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	143
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	144 Options:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	145
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	146 * :location `String`: See apt::backports for documentation.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	147 * :repos `String`: See apt::backports for documentation.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	148 * :key `String`: See apt::backports for documentation.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	149
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	150 Default value: `$apt::params::backports`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	151
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	152 ##### <a name="confs"></a>`confs`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	153
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	154 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	155
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	156 Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	157
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	158 Default value: `$apt::params::confs`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	159
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	160 ##### <a name="update"></a>`update`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	161
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	162 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	163
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	164 Configures various update settings. Valid options: a hash made up from the following keys:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	165
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	166 Options:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	167
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	168 * :frequency `String`: Specifies how often to run `apt-get update`. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	169 Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400);
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	170 'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	171 `apt_update` is notified). Default: 'reluctantly'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	172 * :loglevel `Integer`: Specifies the log level of logs outputted to the console. Default: undef.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	173 * :timeout `Integer`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	174 * :tries `Integer`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	175
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	176 Default value: `$apt::params::update`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	177
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	178 ##### <a name="purge"></a>`purge`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	179
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	180 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	181
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	182 Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	183
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	184 Options:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	185
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	186 * :sources.list `Boolean`: Specifies whether to purge any unmanaged entries from sources.list. Default false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	187 * :sources.list.d `Boolean`: Specifies whether to purge any unmanaged entries from sources.list.d. Default false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	188 * :preferences `Boolean`: Specifies whether to purge any unmanaged entries from preferences. Default false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	189 * :preferences.d. `Boolean`: Specifies whether to purge any unmanaged entries from preferences.d. Default false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	190
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	191 Default value: `$apt::params::purge`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	192
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	193 ##### <a name="proxy"></a>`proxy`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	194
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	195 Data type: `Apt::Proxy`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	196
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	197 Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	198
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	199 Default value: `$apt::params::proxy`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	200
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	201 ##### <a name="sources"></a>`sources`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	202
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	203 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	204
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	205 Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	206
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	207 Default value: `$apt::params::sources`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	208
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	209 ##### <a name="keys"></a>`keys`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	210
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	211 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	212
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	213 Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	214
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	215 Default value: `$apt::params::keys`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	216
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	217 ##### <a name="ppas"></a>`ppas`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	218
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	219 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	220
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	221 Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	222
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	223 Default value: `$apt::params::ppas`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	224
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	225 ##### <a name="pins"></a>`pins`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	226
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	227 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	228
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	229 Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	230
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	231 Default value: `$apt::params::pins`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	232
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	233 ##### <a name="settings"></a>`settings`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	234
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	235 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	236
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	237 Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	238
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	239 Default value: `$apt::params::settings`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	240
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	241 ##### <a name="manage_auth_conf"></a>`manage_auth_conf`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	242
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	243 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	244
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	245 Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	246 the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	247
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	248 Default value: `$apt::params::manage_auth_conf`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	249
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	250 ##### <a name="auth_conf_entries"></a>`auth_conf_entries`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	251
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	252 Data type: `Array[Apt::Auth_conf_entry]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	253
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	254 An optional array of login configuration settings (hashes) that are recorded in the file /etc/apt/auth.conf. This file has a netrc-like
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	255 format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	256 https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details. If specified each hash must contain the keys machine, login and
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	257 password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	258
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	259 Default value: `$apt::params::auth_conf_entries`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	260
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	261 ##### <a name="auth_conf_owner"></a>`auth_conf_owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	262
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	263 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	264
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	265 The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	266
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	267 Default value: `$apt::params::auth_conf_owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	268
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	269 ##### <a name="root"></a>`root`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	270
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	271 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	272
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	273 Specifies root directory of Apt executable.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	274
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	275 Default value: `$apt::params::root`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	276
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	277 ##### <a name="sources_list"></a>`sources_list`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	278
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	279 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	280
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	281 Specifies the path of the sources_list file to use.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	282
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	283 Default value: `$apt::params::sources_list`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	284
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	285 ##### <a name="sources_list_d"></a>`sources_list_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	286
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	287 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	288
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	289 Specifies the path of the sources_list.d file to use.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	290
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	291 Default value: `$apt::params::sources_list_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	292
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	293 ##### <a name="conf_d"></a>`conf_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	294
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	295 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	296
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	297 Specifies the path of the conf.d file to use.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	298
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	299 Default value: `$apt::params::conf_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	300
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	301 ##### <a name="preferences"></a>`preferences`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	302
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	303 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	304
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	305 Specifies the path of the preferences file to use.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	306
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	307 Default value: `$apt::params::preferences`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	308
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	309 ##### <a name="preferences_d"></a>`preferences_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	310
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	311 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	312
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	313 Specifies the path of the preferences.d file to use.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	314
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	315 Default value: `$apt::params::preferences_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	316
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	317 ##### <a name="config_files"></a>`config_files`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	318
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	319 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	320
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	321 A hash made up of the various configuration files used by Apt.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	322
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	323 Default value: `$apt::params::config_files`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	324
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	325 ##### <a name="sources_list_force"></a>`sources_list_force`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	326
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	327 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	328
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	329 Specifies whether to perform force purge or delete. Default false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	330
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	331 Default value: `$apt::params::sources_list_force`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	332
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	333 ##### <a name="update_defaults"></a>`update_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	334
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	335 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	336
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	337
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	338
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	339 Default value: `$apt::params::update_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	340
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	341 ##### <a name="purge_defaults"></a>`purge_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	342
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	343 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	344
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	345
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	346
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	347 Default value: `$apt::params::purge_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	348
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	349 ##### <a name="proxy_defaults"></a>`proxy_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	350
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	351 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	352
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	353
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	354
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	355 Default value: `$apt::params::proxy_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	356
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	357 ##### <a name="include_defaults"></a>`include_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	358
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	359 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	360
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	361
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	362
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	363 Default value: `$apt::params::include_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	364
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	365 ##### <a name="apt_conf_d"></a>`apt_conf_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	366
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	367 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	368
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	369
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	370
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	371 Default value: `$apt::params::apt_conf_d`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	372
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	373 ##### <a name="source_key_defaults"></a>`source_key_defaults`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	374
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	375 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	376
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	377
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	378
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	379 Default value: `{
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	380 'server' => $keyserver,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	381 'options' => undef,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	382 'content' => undef,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	383 'source' => undef,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	384 }`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	385
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	386 ### <a name="aptbackports"></a>`apt::backports`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	387
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	388 Manages backports.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	389
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	390 #### Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	391
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	392 ##### Set up a backport source for Linux Mint qiana
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	393
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	394 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	395 class { 'apt::backports':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	396 location => 'http://us.archive.ubuntu.com/ubuntu',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	397 release => 'trusty-backports',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	398 repos => 'main universe multiverse restricted',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	399 key => {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	400 id => '630239CC130E1A7FD81A27B140976EAF437D05B5',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	401 server => 'keyserver.ubuntu.com',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	402 },
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	403 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	404 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	405
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	406 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	407
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	408 The following parameters are available in the `apt::backports` class:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	409
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	410 * [`location`](#location)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	411 * [`release`](#release)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	412 * [`repos`](#repos)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	413 * [`key`](#key)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	414 * [`pin`](#pin)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	415 * [`include`](#include)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	416
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	417 ##### <a name="location"></a>`location`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	418
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	419 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	420
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	421 Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Default value for Debian and
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	422 Ubuntu varies:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	423
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	424 - Debian: 'http://deb.debian.org/debian'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	425
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	426 - Ubuntu: 'http://archive.ubuntu.com/ubuntu'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	427
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	428 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	429
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	430 ##### <a name="release"></a>`release`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	431
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	432 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	433
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	434 Specifies a distribution of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	435 Default: on Debian and Ubuntu, `${facts['os']['distro']['codename']}-backports`. We recommend keeping this default, except on other operating
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	436 systems.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	437
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	438 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	439
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	440 ##### <a name="repos"></a>`repos`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	441
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	442 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	443
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	444 Specifies a component of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	445 Default value for Debian and Ubuntu varies:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	446
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	447 - Debian: 'main contrib non-free'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	448
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	449 - Ubuntu: 'main universe multiverse restricted'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	450
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	451 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	452
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	453 ##### <a name="key"></a>`key`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	454
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	455 Data type: `Optional[Variant[String, Hash]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	456
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	457 Specifies a key to authenticate the backports. Valid options: a string to be passed to the id parameter of the apt::key defined type, or a
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	458 hash of parameter => value pairs to be passed to apt::key's id, server, content, source, and/or options parameters. Default value
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	459 for Debian and Ubuntu varies:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	460
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	461 - Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	462
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	463 - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	464
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	465 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	466
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	467 ##### <a name="pin"></a>`pin`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	468
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	469 Data type: `Optional[Variant[Integer, String, Hash]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	470
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	471 Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` defined
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	472 type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	473
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	474 Default value: `200`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	475
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	476 ##### <a name="include"></a>`include`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	477
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	478 Data type: `Optional[Variant[Hash]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	479
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	480 Specifies whether to include 'deb' or 'src', or both.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	481
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	482 Default value: `{}`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	483
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	484 ## Defined types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	485
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	486 ### <a name="aptconf"></a>`apt::conf`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	487
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	488 Specifies a custom Apt configuration file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	489
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	490 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	491
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	492 The following parameters are available in the `apt::conf` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	493
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	494 * [`content`](#content)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	495 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	496 * [`priority`](#priority)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	497 * [`notify_update`](#notify_update)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	498
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	499 ##### <a name="content"></a>`content`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	500
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	501 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	502
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	503 Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	504
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	505 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	506
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	507 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	508
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	509 Data type: `Enum['present', 'absent']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	510
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	511 Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	512
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	513 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	514
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	515 ##### <a name="priority"></a>`priority`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	516
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	517 Data type: `Variant[String, Integer]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	518
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	519 Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	520 Valid options: a string containing an integer or an integer.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	521
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	522 Default value: `50`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	523
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	524 ##### <a name="notify_update"></a>`notify_update`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	525
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	526 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	527
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	528 Specifies whether to trigger an `apt-get update` run.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	529
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	530 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	531
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	532 ### <a name="aptkey"></a>`apt::key`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	533
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	534 Manages the GPG keys that Apt uses to authenticate packages.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	535
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	536 * Note The apt::key defined type makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	537
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	538 #### Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	539
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	540 ##### Declare Apt key for apt.puppetlabs.com source
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	541
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	542 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	543 apt::key { 'puppetlabs':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	544 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	545 server => 'keyserver.ubuntu.com',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	546 options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	547 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	548 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	549
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	550 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	551
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	552 The following parameters are available in the `apt::key` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	553
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	554 * [`id`](#id)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	555 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	556 * [`content`](#content)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	557 * [`source`](#source)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	558 * [`server`](#server)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	559 * [`weak_ssl`](#weak_ssl)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	560 * [`options`](#options)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	561
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	562 ##### <a name="id"></a>`id`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	563
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	564 Data type: `Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/, /\A(0x)?[0-9a-fA-F]{16}\Z/, /\A(0x)?[0-9a-fA-F]{40}\Z/]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	565
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	566 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	567 characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	568
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	569 Default value: `$title`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	570
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	571 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	572
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	573 Data type: `Enum['present', 'absent', 'refreshed']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	574
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	575 Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	576 update when they have expired (assuming a new key exists on the key server).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	577
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	578 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	579
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	580 ##### <a name="content"></a>`content`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	581
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	582 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	583
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	584 Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	585
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	586 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	587
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	588 ##### <a name="source"></a>`source`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	589
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	590 Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	591
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	592 Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	593 an absolute path.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	594
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	595 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	596
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	597 ##### <a name="server"></a>`server`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	598
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	599 Data type: `Pattern[/\A((hkp\|hkps\|http\|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?(\/[a-zA-Z\d\-_.]+)*\/?$/]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	600
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	601 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	602 hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	603
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	604 Default value: `$::apt::keyserver`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	605
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	606 ##### <a name="weak_ssl"></a>`weak_ssl`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	607
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	608 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	609
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	610 Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	611
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	612 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	613
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	614 ##### <a name="options"></a>`options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	615
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	616 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	617
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	618 Passes additional options to `apt-key adv --keyserver-options`.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	619
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	620 Default value: `$::apt::key_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	621
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	622 ### <a name="aptmark"></a>`apt::mark`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	623
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	624 Manages apt-mark settings
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	625
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	626 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	627
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	628 The following parameters are available in the `apt::mark` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	629
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	630 * [`setting`](#setting)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	631
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	632 ##### <a name="setting"></a>`setting`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	633
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	634 Data type: `Enum['auto','manual','hold','unhold']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	635
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	636 auto, manual, hold, unhold
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	637 specifies the behavior of apt in case of no more dependencies installed
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	638 https://manpages.debian.org/stable/apt/apt-mark.8.en.html
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	639
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	640 ### <a name="aptpin"></a>`apt::pin`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	641
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	642 Manages Apt pins. Does not trigger an apt-get update run.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	643
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	644 * See also
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	645 * http://linux.die.net/man/5/apt_preferences
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	646 * for context on these parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	647
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	648 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	649
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	650 The following parameters are available in the `apt::pin` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	651
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	652 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	653 * [`explanation`](#explanation)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	654 * [`order`](#order)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	655 * [`packages`](#packages)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	656 * [`priority`](#priority)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	657 * [`release`](#release)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	658 * [`release_version`](#release_version)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	659 * [`component`](#component)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	660 * [`originator`](#originator)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	661 * [`label`](#label)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	662 * [`origin`](#origin)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	663 * [`version`](#version)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	664 * [`codename`](#codename)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	665
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	666 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	667
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	668 Data type: `Optional[Enum['file', 'present', 'absent']]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	669
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	670 Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	671
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	672 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	673
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	674 ##### <a name="explanation"></a>`explanation`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	675
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	676 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	677
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	678 Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	679
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	680 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	681
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	682 ##### <a name="order"></a>`order`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	683
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	684 Data type: `Variant[Integer]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	685
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	686 Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	687
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	688 Default value: `50`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	689
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	690 ##### <a name="packages"></a>`packages`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	691
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	692 Data type: `Variant[String, Array]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	693
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	694 Specifies which package(s) to pin.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	695
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	696 Default value: `'*'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	697
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	698 ##### <a name="priority"></a>`priority`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	699
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	700 Data type: `Variant[Numeric, String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	701
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	702 Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	703 priority number (subject to dependency constraints). Valid options: an integer.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	704
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	705 Default value: `0`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	706
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	707 ##### <a name="release"></a>`release`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	708
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	709 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	710
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	711 Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	712
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	713 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	714
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	715 ##### <a name="release_version"></a>`release_version`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	716
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	717 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	718
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	719 Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	720
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	721 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	722
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	723 ##### <a name="component"></a>`component`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	724
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	725 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	726
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	727 Names the licensing component associated with the packages in the directory tree of the Release file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	728
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	729 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	730
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	731 ##### <a name="originator"></a>`originator`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	732
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	733 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	734
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	735 Names the originator of the packages in the directory tree of the Release file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	736
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	737 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	738
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	739 ##### <a name="label"></a>`label`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	740
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	741 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	742
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	743 Names the label of the packages in the directory tree of the Release file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	744
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	745 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	746
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	747 ##### <a name="origin"></a>`origin`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	748
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	749 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	750
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	751
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	752
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	753 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	754
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	755 ##### <a name="version"></a>`version`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	756
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	757 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	758
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	759
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	760
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	761 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	762
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	763 ##### <a name="codename"></a>`codename`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	764
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	765 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	766
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	767
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	768
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	769 Default value: `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	770
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	771 ### <a name="aptppa"></a>`apt::ppa`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	772
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	773 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	774
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	775 #### Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	776
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	777 ##### Example declaration of an Apt PPA
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	778
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	779 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	780 apt::ppa{ 'ppa:openstack-ppa/bleeding-edge': }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	781 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	782
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	783 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	784
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	785 The following parameters are available in the `apt::ppa` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	786
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	787 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	788 * [`options`](#options)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	789 * [`release`](#release)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	790 * [`dist`](#dist)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	791 * [`package_name`](#package_name)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	792 * [`package_manage`](#package_manage)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	793
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	794 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	795
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	796 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	797
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	798 Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	799
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	800 Default value: `'present'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	801
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	802 ##### <a name="options"></a>`options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	803
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	804 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	805
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	806 Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	807
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	808 Default value: `$::apt::ppa_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	809
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	810 ##### <a name="release"></a>`release`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	811
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	812 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	813
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	814 Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	815 Optional if `puppet facts show os.distro.codename` returns your correct distribution release codename.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	816
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	817 Default value: `$facts['os']['distro']['codename']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	818
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	819 ##### <a name="dist"></a>`dist`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	820
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	821 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	822
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	823 Specifies the distribution of your node. Valid options: a string containing a valid distribution codename.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	824 Optional if `puppet facts show os.name` returns your correct distribution name.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	825
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	826 Default value: `$facts['os']['name']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	827
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	828 ##### <a name="package_name"></a>`package_name`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	829
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	830 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	831
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	832 Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	833
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	834 Default value: `$::apt::ppa_package`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	835
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	836 ##### <a name="package_manage"></a>`package_manage`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	837
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	838 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	839
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	840 Specifies whether Puppet should manage the package that provides `apt-add-repository`.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	841
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	842 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	843
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	844 ### <a name="aptsetting"></a>`apt::setting`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	845
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	846 Manages Apt configuration files.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	847
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	848 * See also
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	849 * https://docs.puppetlabs.com/references/latest/type.html#file-attributes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	850 * for more information on source and content parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	851
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	852 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	853
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	854 The following parameters are available in the `apt::setting` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	855
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	856 * [`priority`](#priority)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	857 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	858 * [`source`](#source)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	859 * [`content`](#content)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	860 * [`notify_update`](#notify_update)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	861
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	862 ##### <a name="priority"></a>`priority`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	863
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	864 Data type: `Variant[String, Integer, Array]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	865
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	866 Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	867
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	868 Default value: `50`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	869
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	870 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	871
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	872 Data type: `Optional[Enum['file', 'present', 'absent']]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	873
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	874 Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	875
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	876 Default value: `file`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	877
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	878 ##### <a name="source"></a>`source`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	879
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	880 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	881
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	882 Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	883 with `content`. Valid options: see link above for Puppet's native file type source attribute.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	884
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	885 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	886
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	887 ##### <a name="content"></a>`content`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	888
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	889 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	890
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	891 Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	892 options: see link above for Puppet's native file type content attribute.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	893
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	894 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	895
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	896 ##### <a name="notify_update"></a>`notify_update`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	897
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	898 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	899
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	900 Specifies whether to trigger an `apt-get update` run.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	901
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	902 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	903
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	904 ### <a name="aptsource"></a>`apt::source`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	905
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	906 Manages the Apt sources in /etc/apt/sources.list.d/.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	907
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	908 #### Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	909
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	910 ##### Install the puppetlabs apt source
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	911
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	912 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	913 apt::source { 'puppetlabs':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	914 location => 'http://apt.puppetlabs.com',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	915 repos => 'main',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	916 key => {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	917 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	918 server => 'keyserver.ubuntu.com',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	919 },
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	920 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	921 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	922
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	923 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	924
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	925 The following parameters are available in the `apt::source` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	926
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	927 * [`location`](#location)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	928 * [`comment`](#comment)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	929 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	930 * [`release`](#release)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	931 * [`repos`](#repos)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	932 * [`include`](#include)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	933 * [`key`](#key)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	934 * [`keyring`](#keyring)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	935 * [`pin`](#pin)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	936 * [`architecture`](#architecture)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	937 * [`allow_unsigned`](#allow_unsigned)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	938 * [`notify_update`](#notify_update)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	939
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	940 ##### <a name="location"></a>`location`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	941
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	942 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	943
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	944 Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	945
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	946 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	947
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	948 ##### <a name="comment"></a>`comment`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	949
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	950 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	951
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	952 Supplies a comment for adding to the Apt source file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	953
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	954 Default value: `$name`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	955
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	956 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	957
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	958 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	959
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	960 Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	961
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	962 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	963
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	964 ##### <a name="release"></a>`release`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	965
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	966 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	967
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	968 Specifies a distribution of the Apt repository.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	969
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	970 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	971
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	972 ##### <a name="repos"></a>`repos`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	973
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	974 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	975
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	976 Specifies a component of the Apt repository.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	977
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	978 Default value: `'main'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	979
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	980 ##### <a name="include"></a>`include`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	981
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	982 Data type: `Optional[Variant[Hash]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	983
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	984 Configures include options. Valid options: a hash of available keys.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	985
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	986 Options:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	987
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	988 * :deb `Boolean`: Specifies whether to request the distribution's compiled binaries. Default true.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	989 * :src `Boolean`: Specifies whether to request the distribution's uncompiled source code. Default false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	990
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	991 Default value: `{}`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	992
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	993 ##### <a name="key"></a>`key`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	994
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	995 Data type: `Optional[Variant[String, Hash]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	996
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	997 Creates a declaration of the apt::key defined type. Valid options: a string to be passed to the `id` parameter of the `apt::key`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	998 defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, `weak_ssl`,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	999 and/or `options` parameters.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1000
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1001 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1002
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1003 ##### <a name="keyring"></a>`keyring`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1004
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1005 Data type: `Optional[Stdlib::AbsolutePath]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1006
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1007 Absolute path to a file containing the PGP keyring used to sign this repository. Value is used to set signed-by on the source entry.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1008 See https://wiki.debian.org/DebianRepository/UseThirdParty for details.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1009
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1010 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1011
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1012 ##### <a name="pin"></a>`pin`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1013
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1014 Data type: `Optional[Variant[Hash, Numeric, String]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1015
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1016 Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1017 `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1018
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1019 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1020
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1021 ##### <a name="architecture"></a>`architecture`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1022
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1023 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1024
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1025 Tells Apt to only download information for specified architectures. Valid options: a string containing one or more architecture names,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1026 separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1027 defined in the Apt::Architectures option).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1028
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1029 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1030
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1031 ##### <a name="allow_unsigned"></a>`allow_unsigned`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1032
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1033 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1034
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1035 Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1036
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1037 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1038
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1039 ##### <a name="notify_update"></a>`notify_update`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1040
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1041 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1042
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1043 Specifies whether to trigger an `apt-get update` run.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1044
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1045 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1046
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1047 ## Resource types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1048
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1049 ## Data types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1050
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1051 ### <a name="aptauth_conf_entry"></a>`Apt::Auth_conf_entry`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1052
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1053 Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1054
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1055 * See also
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1056 * https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1057 * for more information
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1058
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1059 Alias of
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1060
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1061 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1062 Struct[{
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1063 machine => String[1],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1064 login => String,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1065 password => String
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1066 }]
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1067 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1068
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1069 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1070
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1071 The following parameters are available in the `Apt::Auth_conf_entry` data type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1072
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1073 * [`machine`](#machine)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1074 * [`login`](#login)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1075 * [`password`](#password)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1076
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1077 ##### <a name="machine"></a>`machine`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1078
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1079 Hostname of machine to connect to.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1080
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1081 ##### <a name="login"></a>`login`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1082
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1083 Specifies the username to connect with.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1084
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1085 ##### <a name="password"></a>`password`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1086
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1087 Specifies the password to connect with.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1088
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1089 ### <a name="aptproxy"></a>`Apt::Proxy`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1090
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1091 Configures Apt to connect to a proxy server.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1092
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1093 Alias of
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1094
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1095 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1096 Struct[{
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1097 ensure => Optional[Enum['file', 'present', 'absent']],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1098 host => Optional[String],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1099 port => Optional[Integer[0, 65535]],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1100 https => Optional[Boolean],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1101 https_acng => Optional[Boolean],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1102 direct => Optional[Boolean],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1103 perhost => Optional[Array[Apt::Proxy_Per_Host]],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1104 }]
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1105 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1106
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1107 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1108
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1109 The following parameters are available in the `Apt::Proxy` data type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1110
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1111 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1112 * [`host`](#host)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1113 * [`port`](#port)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1114 * [`https`](#https)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1115 * [`direct`](#direct)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1116
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1117 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1118
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1119 Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1120
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1121 ##### <a name="host"></a>`host`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1122
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1123 Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1124
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1125 ##### <a name="port"></a>`port`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1126
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1127 Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1128
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1129 ##### <a name="https"></a>`https`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1130
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1131 Specifies whether to enable https proxies.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1132
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1133 ##### <a name="direct"></a>`direct`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1134
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1135 Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1136
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1137 ### <a name="aptproxy_per_host"></a>`Apt::Proxy_Per_Host`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1138
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1139 Adds per-host overrides to the system default APT proxy configuration
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1140
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1141 Alias of
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1142
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1143 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1144 Struct[{
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1145 scope => String,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1146 host => Optional[String],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1147 port => Optional[Integer[1, 65535]],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1148 https => Optional[Boolean],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1149 direct => Optional[Boolean],
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1150 }]
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1151 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1152
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1153 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1154
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1155 The following parameters are available in the `Apt::Proxy_Per_Host` data type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1156
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1157 * [`scope`](#scope)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1158 * [`host`](#host)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1159 * [`port`](#port)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1160 * [`https`](#https)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1161 * [`direct`](#direct)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1162
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1163 ##### <a name="scope"></a>`scope`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1164
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1165 Specifies the scope of the override. Valid options: a string containing a hostname.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1166
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1167 ##### <a name="host"></a>`host`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1168
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1169 Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1170
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1171 ##### <a name="port"></a>`port`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1172
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1173 Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1174
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1175 ##### <a name="https"></a>`https`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1176
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1177 Specifies whether to enable https for this override.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1178
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1179 ##### <a name="direct"></a>`direct`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1180
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1181 Specifies whether or not to use a `DIRECT` target to bypass the system default proxy.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1182
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1183 ## Tasks
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1184
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1185 ### <a name="init"></a>`init`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1186
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1187 Allows you to perform apt functions
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1188
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1189 Supports noop? false
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1190
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1191 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1192
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1193 ##### `action`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1194
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1195 Data type: `Enum[update, upgrade, dist-upgrade, autoremove]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1196
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1197 Action to perform
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1198

Mercurial > repos > other > Puppet

annotate modules/apt/REFERENCE.md @ 445:9268fe05d0ab