Merge pull request #953 from suchpuppet/main

[puppet-modules/puppetlabs-apt.git] / REFERENCE.md

diff --git a/REFERENCE.md b/REFERENCE.md
index 6163acf998fa73b0c7d694a7e6da24cedebfabfb..12a81c36c345519803f19fef57a4561038a2ef7e 100644 (file)
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -1,21 +1,22 @@
 # Reference
 # Reference

+

 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
 
 ## Table of Contents
 
 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
 
 ## Table of Contents
 

-**Classes**
+### Classes

 
 

-_Public Classes_
+#### Public Classes

 
 * [`apt`](#apt): Main class, includes all other classes.
 * [`apt::backports`](#aptbackports): Manages backports.
 
 
 * [`apt`](#apt): Main class, includes all other classes.
 * [`apt::backports`](#aptbackports): Manages backports.
 

-_Private Classes_
+#### Private Classes

 
 * `apt::params`: Provides defaults for the Apt module parameters.
 * `apt::update`: Updates the list of available packages using apt-get update.
 
 
 * `apt::params`: Provides defaults for the Apt module parameters.
 * `apt::update`: Updates the list of available packages using apt-get update.
 

-**Defined types**
+### Defined types

 
 * [`apt::conf`](#aptconf): Specifies a custom Apt configuration file.
 * [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages.
 
 * [`apt::conf`](#aptconf): Specifies a custom Apt configuration file.
 * [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages.


@@ -25,35 +26,35 @@ _Private Classes_
 * [`apt::setting`](#aptsetting): Manages Apt configuration files.
 * [`apt::source`](#aptsource): Manages the Apt sources in /etc/apt/sources.list.d/.
 
 * [`apt::setting`](#aptsetting): Manages Apt configuration files.
 * [`apt::source`](#aptsource): Manages the Apt sources in /etc/apt/sources.list.d/.
 

-**Resource types**
+### Resource types

 
 

-_Public Resource types_
+#### Public Resource types

 
 
 
 

-_Private Resource types_
+#### Private Resource types

 
 * `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed
 by apt to perform package validation. Apt has it's own GPG keyring that can
 be manipulated through the `apt-key` command.
 
 
 * `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed
 by apt to perform package validation. Apt has it's own GPG keyring that can
 be manipulated through the `apt-key` command.
 

-**Data types**
+### Data types

 
 * [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
 * [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server.
 
 
 * [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
 * [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server.
 

-**Tasks**
+### Tasks

 
 * [`init`](#init): Allows you to perform apt functions
 
 ## Classes
 
 
 * [`init`](#init): Allows you to perform apt functions
 
 ## Classes
 

-### apt
+### `apt`

 
 Main class, includes all other classes.
 
 * **See also**
 
 Main class, includes all other classes.
 
 * **See also**

-https://docs.puppetlabs.com/references/latest/function.html#createresources
-for the create resource function
+  * https://docs.puppetlabs.com/references/latest/function.html#createresources
+    * for the create resource function

 
 #### Parameters
 
 
 #### Parameters
 


@@ -65,7 +66,7 @@ Data type: `String`
 
 Specifies the provider that should be used by apt::update.
 
 
 Specifies the provider that should be used by apt::update.
 

-Default value: $apt::params::provider
+Default value: `$apt::params::provider`

 
 ##### `keyserver`
 
 
 ##### `keyserver`
 


@@ -74,7 +75,7 @@ Data type: `String`
 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
 hkp://).
 
 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
 hkp://).
 

-Default value: $apt::params::keyserver
+Default value: `$apt::params::keyserver`

 
 ##### `key_options`
 
 
 ##### `key_options`
 


@@ -82,7 +83,7 @@ Data type: `Optional[String]`
 
 Specifies the default options for apt::key resources.
 
 
 Specifies the default options for apt::key resources.
 

-Default value: $apt::params::key_options
+Default value: `$apt::params::key_options`

 
 ##### `ppa_options`
 
 
 ##### `ppa_options`
 


@@ -90,7 +91,7 @@ Data type: `Optional[String]`
 
 Supplies options to be passed to the `add-apt-repository` command.
 
 
 Supplies options to be passed to the `add-apt-repository` command.
 

-Default value: $apt::params::ppa_options
+Default value: `$apt::params::ppa_options`

 
 ##### `ppa_package`
 
 
 ##### `ppa_package`
 


@@ -98,7 +99,7 @@ Data type: `Optional[String]`
 
 Names the package that provides the `apt-add-repository` command.
 
 
 Names the package that provides the `apt-add-repository` command.
 

-Default value: $apt::params::ppa_package
+Default value: `$apt::params::ppa_package`

 
 ##### `backports`
 
 
 ##### `backports`
 


@@ -112,7 +113,7 @@ Options:
 * **:repos** `String`: See apt::backports for documentation.
 * **:key** `String`: See apt::backports for documentation.
 
 * **:repos** `String`: See apt::backports for documentation.
 * **:key** `String`: See apt::backports for documentation.
 

-Default value: $apt::params::backports
+Default value: `$apt::params::backports`

 
 ##### `confs`
 
 
 ##### `confs`
 


@@ -120,7 +121,7 @@ Data type: `Hash`
 
 Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
 
 
 Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
 

-Default value: $apt::params::confs
+Default value: `$apt::params::confs`

 
 ##### `update`
 
 
 ##### `update`
 


@@ -138,7 +139,7 @@ Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_upd
 * **:timeout** `Integer`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef.
 * **:tries** `Integer`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
 
 * **:timeout** `Integer`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef.
 * **:tries** `Integer`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
 

-Default value: $apt::params::update
+Default value: `$apt::params::update`

 
 ##### `purge`
 
 
 ##### `purge`
 


@@ -153,7 +154,7 @@ Options:
 * **:preferences** `Boolean`: Specifies whether to purge any unmanaged entries from preferences. Default false.
 * **:preferences.d.** `Boolean`: Specifies whether to purge any unmanaged entries from preferences.d. Default false.
 
 * **:preferences** `Boolean`: Specifies whether to purge any unmanaged entries from preferences. Default false.
 * **:preferences.d.** `Boolean`: Specifies whether to purge any unmanaged entries from preferences.d. Default false.
 

-Default value: $apt::params::purge
+Default value: `$apt::params::purge`

 
 ##### `proxy`
 
 
 ##### `proxy`
 


@@ -161,7 +162,7 @@ Data type: `Apt::Proxy`
 
 Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
 
 
 Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
 

-Default value: $apt::params::proxy
+Default value: `$apt::params::proxy`

 
 ##### `sources`
 
 
 ##### `sources`
 


@@ -169,7 +170,7 @@ Data type: `Hash`
 
 Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
 
 
 Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
 

-Default value: $apt::params::sources
+Default value: `$apt::params::sources`

 
 ##### `keys`
 
 
 ##### `keys`
 


@@ -177,7 +178,7 @@ Data type: `Hash`
 
 Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
 
 
 Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
 

-Default value: $apt::params::keys
+Default value: `$apt::params::keys`

 
 ##### `ppas`
 
 
 ##### `ppas`
 


@@ -185,7 +186,7 @@ Data type: `Hash`
 
 Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
 
 
 Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
 

-Default value: $apt::params::ppas
+Default value: `$apt::params::ppas`

 
 ##### `pins`
 
 
 ##### `pins`
 


@@ -193,7 +194,7 @@ Data type: `Hash`
 
 Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
 
 
 Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
 

-Default value: $apt::params::pins
+Default value: `$apt::params::pins`

 
 ##### `settings`
 
 
 ##### `settings`
 


@@ -201,7 +202,7 @@ Data type: `Hash`
 
 Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
 
 
 Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
 

-Default value: $apt::params::settings
+Default value: `$apt::params::settings`

 
 ##### `manage_auth_conf`
 
 
 ##### `manage_auth_conf`
 


@@ -210,7 +211,7 @@ Data type: `Boolean`
 Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in
 the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent.
 
 Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in
 the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent.
 

-Default value: $apt::params::manage_auth_conf
+Default value: `$apt::params::manage_auth_conf`

 
 ##### `auth_conf_entries`
 
 
 ##### `auth_conf_entries`
 


@@ -221,7 +222,7 @@ format (similar to what curl uses) and contains the login configuration for APT
 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
 password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent.
 
 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
 password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent.
 

-Default value: $apt::params::auth_conf_entries
+Default value: `$apt::params::auth_conf_entries`

 
 ##### `auth_conf_owner`
 
 
 ##### `auth_conf_owner`
 


@@ -229,7 +230,7 @@ Data type: `String`
 
 The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
 
 
 The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
 

-Default value: $apt::params::auth_conf_owner
+Default value: `$apt::params::auth_conf_owner`

 
 ##### `root`
 
 
 ##### `root`
 


@@ -237,7 +238,7 @@ Data type: `String`
 
 Specifies root directory of Apt executable.
 
 
 Specifies root directory of Apt executable.
 

-Default value: $apt::params::root
+Default value: `$apt::params::root`

 
 ##### `sources_list`
 
 
 ##### `sources_list`
 


@@ -245,7 +246,7 @@ Data type: `String`
 
 Specifies the path of the sources_list file to use.
 
 
 Specifies the path of the sources_list file to use.
 

-Default value: $apt::params::sources_list
+Default value: `$apt::params::sources_list`

 
 ##### `sources_list_d`
 
 
 ##### `sources_list_d`
 


@@ -253,7 +254,7 @@ Data type: `String`
 
 Specifies the path of the sources_list.d file to use.
 
 
 Specifies the path of the sources_list.d file to use.
 

-Default value: $apt::params::sources_list_d
+Default value: `$apt::params::sources_list_d`

 
 ##### `conf_d`
 
 
 ##### `conf_d`
 


@@ -261,7 +262,7 @@ Data type: `String`
 
 Specifies the path of the conf.d file to use.
 
 
 Specifies the path of the conf.d file to use.
 

-Default value: $apt::params::conf_d
+Default value: `$apt::params::conf_d`

 
 ##### `preferences`
 
 
 ##### `preferences`
 


@@ -269,7 +270,7 @@ Data type: `String`
 
 Specifies the path of the preferences file to use.
 
 
 Specifies the path of the preferences file to use.
 

-Default value: $apt::params::preferences
+Default value: `$apt::params::preferences`

 
 ##### `preferences_d`
 
 
 ##### `preferences_d`
 


@@ -277,7 +278,7 @@ Data type: `String`
 
 Specifies the path of the preferences.d file to use.
 
 
 Specifies the path of the preferences.d file to use.
 

-Default value: $apt::params::preferences_d
+Default value: `$apt::params::preferences_d`

 
 ##### `config_files`
 
 
 ##### `config_files`
 


@@ -285,7 +286,15 @@ Data type: `Hash`
 
 A hash made up of the various configuration files used by Apt.
 
 
 A hash made up of the various configuration files used by Apt.
 

-Default value: $apt::params::config_files
+Default value: `$apt::params::config_files`
+
+##### `sources_list_force`
+
+Data type: `Boolean`
+
+Specifies whether to perform force purge or delete. Default false.
+
+Default value: `$apt::params::sources_list_force`

 
 ##### `update_defaults`
 
 
 ##### `update_defaults`
 


@@ -293,7 +302,7 @@ Data type: `Hash`
 
 
 
 
 
 

-Default value: $apt::params::update_defaults
+Default value: `$apt::params::update_defaults`

 
 ##### `purge_defaults`
 
 
 ##### `purge_defaults`
 


@@ -301,7 +310,7 @@ Data type: `Hash`
 
 
 
 
 
 

-Default value: $apt::params::purge_defaults
+Default value: `$apt::params::purge_defaults`

 
 ##### `proxy_defaults`
 
 
 ##### `proxy_defaults`
 


@@ -309,7 +318,7 @@ Data type: `Hash`
 
 
 
 
 
 

-Default value: $apt::params::proxy_defaults
+Default value: `$apt::params::proxy_defaults`

 
 ##### `include_defaults`
 
 
 ##### `include_defaults`
 


@@ -317,7 +326,7 @@ Data type: `Hash`
 
 
 
 
 
 

-Default value: $apt::params::include_defaults
+Default value: `$apt::params::include_defaults`

 
 ##### `apt_conf_d`
 
 
 ##### `apt_conf_d`
 


@@ -325,7 +334,7 @@ Data type: `String`
 
 
 
 
 
 

-Default value: $apt::params::apt_conf_d
+Default value: `$apt::params::apt_conf_d`

 
 ##### `source_key_defaults`
 
 
 ##### `source_key_defaults`
 


@@ -333,9 +342,9 @@ Data type: `Hash`
 
 
 
 
 
 

-Default value: $apt::params::source_key_defaults
+Default value: `$apt::params::source_key_defaults`

 
 

-### apt::backports
+### `apt::backports`

 
 Manages backports.
 
 
 Manages backports.
 


@@ -370,7 +379,7 @@ Ubuntu varies:
 
 - Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 
 
 - Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `release`
 
 
 ##### `release`
 


@@ -380,7 +389,7 @@ Specifies a distribution of the Apt repository containing the backports to manag
 Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating
 systems.
 
 Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating
 systems.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `repos`
 
 
 ##### `repos`
 


@@ -393,7 +402,7 @@ Default value for Debian and Ubuntu varies:
 
 - Ubuntu: 'main universe multiverse restricted'
 
 
 - Ubuntu: 'main universe multiverse restricted'
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `key`
 
 
 ##### `key`
 


@@ -407,7 +416,7 @@ for Debian and Ubuntu varies:
 
 - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 
 
 - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `pin`
 
 
 ##### `pin`
 


@@ -416,11 +425,19 @@ Data type: `Optional[Variant[Integer, String, Hash]]`
 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
 type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
 
 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
 type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
 

-Default value: 200
+Default value: `200`
+
+##### `include`
+
+Data type: `Optional[Variant[Hash]]`
+
+Specifies whether to include 'deb' or 'src', or both.
+
+Default value: `{}`

 
 ## Defined types
 
 
 ## Defined types
 

-### apt::conf
+### `apt::conf`

 
 Specifies a custom Apt configuration file.
 
 
 Specifies a custom Apt configuration file.
 


@@ -434,7 +451,7 @@ Data type: `Optional[String]`
 
 Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
 
 
 Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `ensure`
 
 
 ##### `ensure`
 


@@ -442,7 +459,7 @@ Data type: `Enum['present', 'absent']`
 
 Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'.
 
 
 Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'.
 

-Default value: present
+Default value: `present`

 
 ##### `priority`
 
 
 ##### `priority`
 


@@ -451,7 +468,7 @@ Data type: `Variant[String, Integer]`
 Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first.
 Valid options: a string containing an integer or an integer.
 
 Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first.
 Valid options: a string containing an integer or an integer.
 

-Default value: 50
+Default value: `50`

 
 ##### `notify_update`
 
 
 ##### `notify_update`
 


@@ -459,9 +476,9 @@ Data type: `Optional[Boolean]`
 
 Specifies whether to trigger an `apt-get update` run.
 
 
 Specifies whether to trigger an `apt-get update` run.
 

-Default value: `undef`
+Default value: ``undef``

 
 

-### apt::key
+### `apt::key`

 
 Manages the GPG keys that Apt uses to authenticate packages.
 
 
 Manages the GPG keys that Apt uses to authenticate packages.
 


@@ -490,7 +507,7 @@ Data type: `Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/, /\A(0x)?[0-9a-fA-F]{16}\Z/, /\A(0
 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
 characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
 
 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
 characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
 

-Default value: $title
+Default value: `$title`

 
 ##### `ensure`
 
 
 ##### `ensure`
 


@@ -499,7 +516,7 @@ Data type: `Enum['present', 'absent', 'refreshed']`
 Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
 update when they have expired (assuming a new key exists on the key server).
 
 Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
 update when they have expired (assuming a new key exists on the key server).
 

-Default value: present
+Default value: `present`

 
 ##### `content`
 
 
 ##### `content`
 


@@ -507,7 +524,7 @@ Data type: `Optional[String]`
 
 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.
 
 
 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.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `source`
 
 
 ##### `source`
 


@@ -516,7 +533,7 @@ Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]`
 Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
 an absolute path.
 
 Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
 an absolute path.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `server`
 
 
 ##### `server`
 


@@ -525,7 +542,7 @@ Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+
 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
 hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
 
 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
 hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
 

-Default value: $::apt::keyserver
+Default value: `$::apt::keyserver`

 
 ##### `weak_ssl`
 
 
 ##### `weak_ssl`
 


@@ -533,7 +550,7 @@ Data type: `Boolean`
 
 Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
 
 
 Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
 

-Default value: `false`
+Default value: ``false``

 
 ##### `options`
 
 
 ##### `options`
 


@@ -541,9 +558,9 @@ Data type: `Optional[String]`
 
 Passes additional options to `apt-key adv --keyserver-options`.
 
 
 Passes additional options to `apt-key adv --keyserver-options`.
 

-Default value: $::apt::key_options
+Default value: `$::apt::key_options`

 
 

-### apt::mark
+### `apt::mark`

 
 defined typeapt::mark
 
 
 defined typeapt::mark
 


@@ -559,13 +576,13 @@ auto, manual, hold, unhold
 specifies the behavior of apt in case of no more dependencies installed
 https://manpages.debian.org/sretch/apt/apt-mark.8.en.html
 
 specifies the behavior of apt in case of no more dependencies installed
 https://manpages.debian.org/sretch/apt/apt-mark.8.en.html
 

-### apt::pin
+### `apt::pin`

 
 Manages Apt pins. Does not trigger an apt-get update run.
 
 * **See also**
 
 Manages Apt pins. Does not trigger an apt-get update run.
 
 * **See also**

-http://linux.die.net/man/5/apt_preferences
-for context on these parameters
+  * http://linux.die.net/man/5/apt_preferences
+    * for context on these parameters

 
 #### Parameters
 
 
 #### Parameters
 


@@ -577,7 +594,7 @@ Data type: `Optional[Enum['file', 'present', 'absent']]`
 
 Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'.
 
 
 Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'.
 

-Default value: present
+Default value: `present`

 
 ##### `explanation`
 
 
 ##### `explanation`
 


@@ -585,7 +602,7 @@ Data type: `Optional[String]`
 
 Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
 
 
 Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `order`
 
 
 ##### `order`
 


@@ -593,7 +610,7 @@ Data type: `Variant[Integer]`
 
 Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first.
 
 
 Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first.
 

-Default value: 50
+Default value: `50`

 
 ##### `packages`
 
 
 ##### `packages`
 


@@ -601,7 +618,7 @@ Data type: `Variant[String, Array]`
 
 Specifies which package(s) to pin.
 
 
 Specifies which package(s) to pin.
 

-Default value: '*'
+Default value: `'*'`

 
 ##### `priority`
 
 
 ##### `priority`
 


@@ -610,7 +627,7 @@ Data type: `Variant[Numeric, String]`
 Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest
 priority number (subject to dependency constraints). Valid options: an integer.
 
 Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest
 priority number (subject to dependency constraints). Valid options: an integer.
 

-Default value: 0
+Default value: `0`

 
 ##### `release`
 
 
 ##### `release`
 


@@ -618,7 +635,7 @@ Data type: `Optional[String]`
 
 Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
 
 
 Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
 

-Default value: ''
+Default value: `''`

 
 ##### `release_version`
 
 
 ##### `release_version`
 


@@ -626,7 +643,7 @@ Data type: `Optional[String]`
 
 Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
 
 
 Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
 

-Default value: ''
+Default value: `''`

 
 ##### `component`
 
 
 ##### `component`
 


@@ -634,7 +651,7 @@ Data type: `Optional[String]`
 
 Names the licensing component associated with the packages in the directory tree of the Release file.
 
 
 Names the licensing component associated with the packages in the directory tree of the Release file.
 

-Default value: ''
+Default value: `''`

 
 ##### `originator`
 
 
 ##### `originator`
 


@@ -642,7 +659,7 @@ Data type: `Optional[String]`
 
 Names the originator of the packages in the directory tree of the Release file.
 
 
 Names the originator of the packages in the directory tree of the Release file.
 

-Default value: ''
+Default value: `''`

 
 ##### `label`
 
 
 ##### `label`
 


@@ -650,7 +667,7 @@ Data type: `Optional[String]`
 
 Names the label of the packages in the directory tree of the Release file.
 
 
 Names the label of the packages in the directory tree of the Release file.
 

-Default value: ''
+Default value: `''`

 
 ##### `origin`
 
 
 ##### `origin`
 


@@ -658,7 +675,7 @@ Data type: `Optional[String]`
 
 
 
 
 
 

-Default value: ''
+Default value: `''`

 
 ##### `version`
 
 
 ##### `version`
 


@@ -666,7 +683,7 @@ Data type: `Optional[String]`
 
 
 
 
 
 

-Default value: ''
+Default value: `''`

 
 ##### `codename`
 
 
 ##### `codename`
 


@@ -674,9 +691,9 @@ Data type: `Optional[String]`
 
 
 
 
 
 

-Default value: ''
+Default value: `''`

 
 

-### apt::ppa
+### `apt::ppa`

 
 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 
 
 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 


@@ -698,7 +715,7 @@ Data type: `String`
 
 Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
 
 
 Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
 

-Default value: 'present'
+Default value: `'present'`

 
 ##### `options`
 
 
 ##### `options`
 


@@ -706,7 +723,7 @@ Data type: `Optional[String]`
 
 Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
 
 
 Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
 

-Default value: $::apt::ppa_options
+Default value: `$::apt::ppa_options`

 
 ##### `release`
 
 
 ##### `release`
 


@@ -715,7 +732,16 @@ Data type: `Optional[String]`
 Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint).
 Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
 
 Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint).
 Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
 

-Default value: $facts['lsbdistcodename']
+Default value: `$facts['lsbdistcodename']`
+
+##### `dist`
+
+Data type: `Optional[String]`
+
+Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint).
+Specifies the distribution of your node. Valid options: a string containing a valid distribution codename.
+
+Default value: `$facts['lsbdistid']`

 
 ##### `package_name`
 
 
 ##### `package_name`
 


@@ -723,7 +749,7 @@ Data type: `Optional[String]`
 
 Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
 
 
 Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
 

-Default value: $::apt::ppa_package
+Default value: `$::apt::ppa_package`

 
 ##### `package_manage`
 
 
 ##### `package_manage`
 


@@ -731,15 +757,15 @@ Data type: `Boolean`
 
 Specifies whether Puppet should manage the package that provides `apt-add-repository`.
 
 
 Specifies whether Puppet should manage the package that provides `apt-add-repository`.
 

-Default value: `false`
+Default value: ``false``

 
 

-### apt::setting
+### `apt::setting`

 
 Manages Apt configuration files.
 
 * **See also**
 
 Manages Apt configuration files.
 
 * **See also**

-https://docs.puppetlabs.com/references/latest/type.html#file-attributes
-for more information on source and content parameters
+  * https://docs.puppetlabs.com/references/latest/type.html#file-attributes
+    * for more information on source and content parameters

 
 #### Parameters
 
 
 #### Parameters
 


@@ -751,7 +777,7 @@ Data type: `Variant[String, Integer, Array]`
 
 Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
 
 
 Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
 

-Default value: 50
+Default value: `50`

 
 ##### `ensure`
 
 
 ##### `ensure`
 


@@ -759,7 +785,7 @@ Data type: `Optional[Enum['file', 'present', 'absent']]`
 
 Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
 
 
 Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
 

-Default value: file
+Default value: `file`

 
 ##### `source`
 
 
 ##### `source`
 


@@ -768,7 +794,7 @@ Data type: `Optional[String]`
 Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination
 with `content`. Valid options: see link above for Puppet's native file type source attribute.
 
 Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination
 with `content`. Valid options: see link above for Puppet's native file type source attribute.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `content`
 
 
 ##### `content`
 


@@ -777,7 +803,7 @@ Data type: `Optional[String]`
 Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid
 options: see link above for Puppet's native file type content attribute.
 
 Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid
 options: see link above for Puppet's native file type content attribute.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `notify_update`
 
 
 ##### `notify_update`
 


@@ -785,9 +811,9 @@ Data type: `Boolean`
 
 Specifies whether to trigger an `apt-get update` run.
 
 
 Specifies whether to trigger an `apt-get update` run.
 

-Default value: `true`
+Default value: ``true``

 
 

-### apt::source
+### `apt::source`

 
 Manages the Apt sources in /etc/apt/sources.list.d/.
 
 
 Manages the Apt sources in /etc/apt/sources.list.d/.
 


@@ -816,7 +842,7 @@ Data type: `Optional[String]`
 
 Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
 
 
 Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `comment`
 
 
 ##### `comment`
 


@@ -824,7 +850,7 @@ Data type: `String`
 
 Supplies a comment for adding to the Apt source file.
 
 
 Supplies a comment for adding to the Apt source file.
 

-Default value: $name
+Default value: `$name`

 
 ##### `ensure`
 
 
 ##### `ensure`
 


@@ -832,7 +858,7 @@ Data type: `String`
 
 Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'.
 
 
 Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'.
 

-Default value: present
+Default value: `present`

 
 ##### `release`
 
 
 ##### `release`
 


@@ -840,7 +866,7 @@ Data type: `Optional[String]`
 
 Specifies a distribution of the Apt repository.
 
 
 Specifies a distribution of the Apt repository.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `repos`
 
 
 ##### `repos`
 


@@ -848,7 +874,7 @@ Data type: `String`
 
 Specifies a component of the Apt repository.
 
 
 Specifies a component of the Apt repository.
 

-Default value: 'main'
+Default value: `'main'`

 
 ##### `include`
 
 
 ##### `include`
 


@@ -861,7 +887,7 @@ Options:
 * **:deb** `Boolean`: Specifies whether to request the distribution's compiled binaries. Default true.
 * **:src** `Boolean`: Specifies whether to request the distribution's uncompiled source code. Default false.
 
 * **:deb** `Boolean`: Specifies whether to request the distribution's compiled binaries. Default true.
 * **:src** `Boolean`: Specifies whether to request the distribution's uncompiled source code. Default false.
 

-Default value: {}
+Default value: `{}`

 
 ##### `key`
 
 
 ##### `key`
 


@@ -871,7 +897,7 @@ Creates a declaration of the apt::key defined type. Valid options: a string to b
 defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or
 `options` parameters.
 
 defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or
 `options` parameters.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `pin`
 
 
 ##### `pin`
 


@@ -880,7 +906,7 @@ Data type: `Optional[Variant[Hash, Numeric, String]]`
 Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the
 `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
 
 Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the
 `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `architecture`
 
 
 ##### `architecture`
 


@@ -890,7 +916,7 @@ Tells Apt to only download information for specified architectures. Valid option
 separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
 defined in the Apt::Architectures option).
 
 separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
 defined in the Apt::Architectures option).
 

-Default value: `undef`
+Default value: ``undef``

 
 ##### `allow_unsigned`
 
 
 ##### `allow_unsigned`
 


@@ -898,7 +924,7 @@ Data type: `Boolean`
 
 Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
 
 
 Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
 

-Default value: `false`
+Default value: ``false``

 
 ##### `notify_update`
 
 
 ##### `notify_update`
 


@@ -906,19 +932,19 @@ Data type: `Boolean`
 
 Specifies whether to trigger an `apt-get update` run.
 
 
 Specifies whether to trigger an `apt-get update` run.
 

-Default value: `true`
+Default value: ``true``

 
 ## Resource types
 
 ## Data types
 
 
 ## Resource types
 
 ## Data types
 

-### Apt::Auth_conf_entry
+### `Apt::Auth_conf_entry`

 
 Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
 
 * **See also**
 
 Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
 
 * **See also**

-https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html
-for more information
+  * https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html
+  * for more information

 
 Alias of `Struct[{
     machine => String[1],
 
 Alias of `Struct[{
     machine => String[1],


@@ -942,16 +968,17 @@ Specifies the username to connect with.
 
 Specifies the password to connect with.
 
 
 Specifies the password to connect with.
 

-### Apt::Proxy
+### `Apt::Proxy`

 
 Configures Apt to connect to a proxy server.
 
 Alias of `Struct[{
 
 Configures Apt to connect to a proxy server.
 
 Alias of `Struct[{

-    ensure => Optional[Enum['file', 'present', 'absent']],
-    host   => Optional[String],
-    port   => Optional[Integer[0, 65535]],
-    https  => Optional[Boolean],
-    direct => Optional[Boolean],
+    ensure     => Optional[Enum['file', 'present', 'absent']],
+    host       => Optional[String],
+    port       => Optional[Integer[0, 65535]],
+    https      => Optional[Boolean],
+    https_acng => Optional[Boolean],
+    direct     => Optional[Boolean],

   }]`
 
 #### Parameters
   }]`
 
 #### Parameters


@@ -980,7 +1007,7 @@ Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but
 
 ## Tasks
 
 
 ## Tasks
 

-### init
+### `init`

 
 Allows you to perform apt functions
 
 
 Allows you to perform apt functions