3 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
11 * [`apt`](#apt): Main class, includes all other classes.
12 * [`apt::backports`](#aptbackports): Manages backports.
16 * `apt::params`: Provides defaults for the Apt module parameters.
17 * `apt::update`: Updates the list of available packages using apt-get update.
21 * [`apt::conf`](#aptconf): Specifies a custom Apt configuration file.
22 * [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages.
23 * [`apt::mark`](#aptmark): defined typeapt::mark
24 * [`apt::pin`](#aptpin): Manages Apt pins. Does not trigger an apt-get update run.
25 * [`apt::ppa`](#aptppa): Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
26 * [`apt::setting`](#aptsetting): Manages Apt configuration files.
27 * [`apt::source`](#aptsource): Manages the Apt sources in /etc/apt/sources.list.d/.
31 #### Public Resource types
34 #### Private Resource types
36 * `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed
37 by apt to perform package validation. Apt has it's own GPG keyring that can
38 be manipulated through the `apt-key` command.
42 * [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
43 * [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server.
47 * [`init`](#init): Allows you to perform apt functions
51 ### <a name="apt"></a>`apt`
53 Main class, includes all other classes.
56 * https://docs.puppetlabs.com/references/latest/function.html#createresources
57 * for the create resource function
61 The following parameters are available in the `apt` class:
63 * [`provider`](#provider)
64 * [`keyserver`](#keyserver)
65 * [`key_options`](#key_options)
66 * [`ppa_options`](#ppa_options)
67 * [`ppa_package`](#ppa_package)
68 * [`backports`](#backports)
73 * [`sources`](#sources)
77 * [`settings`](#settings)
78 * [`manage_auth_conf`](#manage_auth_conf)
79 * [`auth_conf_entries`](#auth_conf_entries)
80 * [`auth_conf_owner`](#auth_conf_owner)
82 * [`sources_list`](#sources_list)
83 * [`sources_list_d`](#sources_list_d)
85 * [`preferences`](#preferences)
86 * [`preferences_d`](#preferences_d)
87 * [`config_files`](#config_files)
88 * [`sources_list_force`](#sources_list_force)
89 * [`update_defaults`](#update_defaults)
90 * [`purge_defaults`](#purge_defaults)
91 * [`proxy_defaults`](#proxy_defaults)
92 * [`include_defaults`](#include_defaults)
93 * [`apt_conf_d`](#apt_conf_d)
94 * [`source_key_defaults`](#source_key_defaults)
96 ##### <a name="provider"></a>`provider`
100 Specifies the provider that should be used by apt::update.
102 Default value: `$apt::params::provider`
104 ##### <a name="keyserver"></a>`keyserver`
108 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
111 Default value: `$apt::params::keyserver`
113 ##### <a name="key_options"></a>`key_options`
115 Data type: `Optional[String]`
117 Specifies the default options for apt::key resources.
119 Default value: `$apt::params::key_options`
121 ##### <a name="ppa_options"></a>`ppa_options`
123 Data type: `Optional[String]`
125 Supplies options to be passed to the `add-apt-repository` command.
127 Default value: `$apt::params::ppa_options`
129 ##### <a name="ppa_package"></a>`ppa_package`
131 Data type: `Optional[String]`
133 Names the package that provides the `apt-add-repository` command.
135 Default value: `$apt::params::ppa_package`
137 ##### <a name="backports"></a>`backports`
139 Data type: `Optional[Hash]`
141 Specifies some of the default parameters used by apt::backports. Valid options: a hash made up from the following keys:
145 * **:location** `String`: See apt::backports for documentation.
146 * **:repos** `String`: See apt::backports for documentation.
147 * **:key** `String`: See apt::backports for documentation.
149 Default value: `$apt::params::backports`
151 ##### <a name="confs"></a>`confs`
155 Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
157 Default value: `$apt::params::confs`
159 ##### <a name="update"></a>`update`
163 Configures various update settings. Valid options: a hash made up from the following keys:
167 * **: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.
168 Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400);
169 'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource
170 `apt_update` is notified). Default: 'reluctantly'.
171 * **:loglevel** `Integer`: Specifies the log level of logs outputted to the console. Default: undef.
172 * **:timeout** `Integer`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef.
173 * **:tries** `Integer`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
175 Default value: `$apt::params::update`
177 ##### <a name="purge"></a>`purge`
181 Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
185 * **:sources.list** `Boolean`: Specifies whether to purge any unmanaged entries from sources.list. Default false.
186 * **:sources.list.d** `Boolean`: Specifies whether to purge any unmanaged entries from sources.list.d. Default false.
187 * **:preferences** `Boolean`: Specifies whether to purge any unmanaged entries from preferences. Default false.
188 * **:preferences.d.** `Boolean`: Specifies whether to purge any unmanaged entries from preferences.d. Default false.
190 Default value: `$apt::params::purge`
192 ##### <a name="proxy"></a>`proxy`
194 Data type: `Apt::Proxy`
196 Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
198 Default value: `$apt::params::proxy`
200 ##### <a name="sources"></a>`sources`
204 Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
206 Default value: `$apt::params::sources`
208 ##### <a name="keys"></a>`keys`
212 Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
214 Default value: `$apt::params::keys`
216 ##### <a name="ppas"></a>`ppas`
220 Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
222 Default value: `$apt::params::ppas`
224 ##### <a name="pins"></a>`pins`
228 Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
230 Default value: `$apt::params::pins`
232 ##### <a name="settings"></a>`settings`
236 Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
238 Default value: `$apt::params::settings`
240 ##### <a name="manage_auth_conf"></a>`manage_auth_conf`
244 Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in
245 the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent.
247 Default value: `$apt::params::manage_auth_conf`
249 ##### <a name="auth_conf_entries"></a>`auth_conf_entries`
251 Data type: `Array[Apt::Auth_conf_entry]`
253 An optional array of login configuration settings (hashes) that are recorded in the file /etc/apt/auth.conf. This file has a netrc-like
254 format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See
255 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
256 password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent.
258 Default value: `$apt::params::auth_conf_entries`
260 ##### <a name="auth_conf_owner"></a>`auth_conf_owner`
264 The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
266 Default value: `$apt::params::auth_conf_owner`
268 ##### <a name="root"></a>`root`
272 Specifies root directory of Apt executable.
274 Default value: `$apt::params::root`
276 ##### <a name="sources_list"></a>`sources_list`
280 Specifies the path of the sources_list file to use.
282 Default value: `$apt::params::sources_list`
284 ##### <a name="sources_list_d"></a>`sources_list_d`
288 Specifies the path of the sources_list.d file to use.
290 Default value: `$apt::params::sources_list_d`
292 ##### <a name="conf_d"></a>`conf_d`
296 Specifies the path of the conf.d file to use.
298 Default value: `$apt::params::conf_d`
300 ##### <a name="preferences"></a>`preferences`
304 Specifies the path of the preferences file to use.
306 Default value: `$apt::params::preferences`
308 ##### <a name="preferences_d"></a>`preferences_d`
312 Specifies the path of the preferences.d file to use.
314 Default value: `$apt::params::preferences_d`
316 ##### <a name="config_files"></a>`config_files`
320 A hash made up of the various configuration files used by Apt.
322 Default value: `$apt::params::config_files`
324 ##### <a name="sources_list_force"></a>`sources_list_force`
328 Specifies whether to perform force purge or delete. Default false.
330 Default value: `$apt::params::sources_list_force`
332 ##### <a name="update_defaults"></a>`update_defaults`
338 Default value: `$apt::params::update_defaults`
340 ##### <a name="purge_defaults"></a>`purge_defaults`
346 Default value: `$apt::params::purge_defaults`
348 ##### <a name="proxy_defaults"></a>`proxy_defaults`
354 Default value: `$apt::params::proxy_defaults`
356 ##### <a name="include_defaults"></a>`include_defaults`
362 Default value: `$apt::params::include_defaults`
364 ##### <a name="apt_conf_d"></a>`apt_conf_d`
370 Default value: `$apt::params::apt_conf_d`
372 ##### <a name="source_key_defaults"></a>`source_key_defaults`
378 Default value: `$apt::params::source_key_defaults`
380 ### <a name="aptbackports"></a>`apt::backports`
386 ##### Set up a backport source for Linux Mint qiana
389 class { 'apt::backports':
390 location => 'http://us.archive.ubuntu.com/ubuntu',
391 release => 'trusty-backports',
392 repos => 'main universe multiverse restricted',
394 id => '630239CC130E1A7FD81A27B140976EAF437D05B5',
395 server => 'hkps.pool.sks-keyservers.net',
402 The following parameters are available in the `apt::backports` class:
404 * [`location`](#location)
405 * [`release`](#release)
409 * [`include`](#include)
411 ##### <a name="location"></a>`location`
413 Data type: `Optional[String]`
415 Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Default value for Debian and
418 - Debian: 'http://deb.debian.org/debian'
420 - Ubuntu: 'http://archive.ubuntu.com/ubuntu'
422 Default value: ``undef``
424 ##### <a name="release"></a>`release`
426 Data type: `Optional[String]`
428 Specifies a distribution of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
429 Default: on Debian and Ubuntu, `${facts['os']['distro']['codename']}-backports`. We recommend keeping this default, except on other operating
432 Default value: ``undef``
434 ##### <a name="repos"></a>`repos`
436 Data type: `Optional[String]`
438 Specifies a component of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
439 Default value for Debian and Ubuntu varies:
441 - Debian: 'main contrib non-free'
443 - Ubuntu: 'main universe multiverse restricted'
445 Default value: ``undef``
447 ##### <a name="key"></a>`key`
449 Data type: `Optional[Variant[String, Hash]]`
451 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
452 hash of parameter => value pairs to be passed to apt::key's id, server, content, source, and/or options parameters. Default value
453 for Debian and Ubuntu varies:
455 - Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
457 - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
459 Default value: ``undef``
461 ##### <a name="pin"></a>`pin`
463 Data type: `Optional[Variant[Integer, String, Hash]]`
465 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
466 type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
470 ##### <a name="include"></a>`include`
472 Data type: `Optional[Variant[Hash]]`
474 Specifies whether to include 'deb' or 'src', or both.
480 ### <a name="aptconf"></a>`apt::conf`
482 Specifies a custom Apt configuration file.
486 The following parameters are available in the `apt::conf` defined type:
488 * [`content`](#content)
489 * [`ensure`](#ensure)
490 * [`priority`](#priority)
491 * [`notify_update`](#notify_update)
493 ##### <a name="content"></a>`content`
495 Data type: `Optional[String]`
497 Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
499 Default value: ``undef``
501 ##### <a name="ensure"></a>`ensure`
503 Data type: `Enum['present', 'absent']`
505 Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'.
507 Default value: `present`
509 ##### <a name="priority"></a>`priority`
511 Data type: `Variant[String, Integer]`
513 Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first.
514 Valid options: a string containing an integer or an integer.
518 ##### <a name="notify_update"></a>`notify_update`
520 Data type: `Optional[Boolean]`
522 Specifies whether to trigger an `apt-get update` run.
524 Default value: ``undef``
526 ### <a name="aptkey"></a>`apt::key`
528 Manages the GPG keys that Apt uses to authenticate packages.
530 * **Note** The apt::key defined type makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.
534 ##### Declare Apt key for apt.puppetlabs.com source
537 apt::key { 'puppetlabs':
538 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
539 server => 'hkps.pool.sks-keyservers.net',
540 options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
546 The following parameters are available in the `apt::key` defined type:
549 * [`ensure`](#ensure)
550 * [`content`](#content)
551 * [`source`](#source)
552 * [`server`](#server)
553 * [`weak_ssl`](#weak_ssl)
554 * [`options`](#options)
556 ##### <a name="id"></a>`id`
558 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/]`
560 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
561 characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
563 Default value: `$title`
565 ##### <a name="ensure"></a>`ensure`
567 Data type: `Enum['present', 'absent', 'refreshed']`
569 Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
570 update when they have expired (assuming a new key exists on the key server).
572 Default value: `present`
574 ##### <a name="content"></a>`content`
576 Data type: `Optional[String]`
578 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.
580 Default value: ``undef``
582 ##### <a name="source"></a>`source`
584 Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]`
586 Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
589 Default value: ``undef``
591 ##### <a name="server"></a>`server`
593 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\-_.]+)*\/?$/]`
595 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
596 hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
598 Default value: `$::apt::keyserver`
600 ##### <a name="weak_ssl"></a>`weak_ssl`
604 Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
606 Default value: ``false``
608 ##### <a name="options"></a>`options`
610 Data type: `Optional[String]`
612 Passes additional options to `apt-key adv --keyserver-options`.
614 Default value: `$::apt::key_options`
616 ### <a name="aptmark"></a>`apt::mark`
618 defined typeapt::mark
622 The following parameters are available in the `apt::mark` defined type:
624 * [`setting`](#setting)
626 ##### <a name="setting"></a>`setting`
628 Data type: `Enum['auto','manual','hold','unhold']`
630 auto, manual, hold, unhold
631 specifies the behavior of apt in case of no more dependencies installed
632 https://manpages.debian.org/sretch/apt/apt-mark.8.en.html
634 ### <a name="aptpin"></a>`apt::pin`
636 Manages Apt pins. Does not trigger an apt-get update run.
639 * http://linux.die.net/man/5/apt_preferences
640 * for context on these parameters
644 The following parameters are available in the `apt::pin` defined type:
646 * [`ensure`](#ensure)
647 * [`explanation`](#explanation)
649 * [`packages`](#packages)
650 * [`priority`](#priority)
651 * [`release`](#release)
652 * [`release_version`](#release_version)
653 * [`component`](#component)
654 * [`originator`](#originator)
656 * [`origin`](#origin)
657 * [`version`](#version)
658 * [`codename`](#codename)
660 ##### <a name="ensure"></a>`ensure`
662 Data type: `Optional[Enum['file', 'present', 'absent']]`
664 Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'.
666 Default value: `present`
668 ##### <a name="explanation"></a>`explanation`
670 Data type: `Optional[String]`
672 Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
674 Default value: ``undef``
676 ##### <a name="order"></a>`order`
678 Data type: `Variant[Integer]`
680 Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first.
684 ##### <a name="packages"></a>`packages`
686 Data type: `Variant[String, Array]`
688 Specifies which package(s) to pin.
692 ##### <a name="priority"></a>`priority`
694 Data type: `Variant[Numeric, String]`
696 Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest
697 priority number (subject to dependency constraints). Valid options: an integer.
701 ##### <a name="release"></a>`release`
703 Data type: `Optional[String]`
705 Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
709 ##### <a name="release_version"></a>`release_version`
711 Data type: `Optional[String]`
713 Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
717 ##### <a name="component"></a>`component`
719 Data type: `Optional[String]`
721 Names the licensing component associated with the packages in the directory tree of the Release file.
725 ##### <a name="originator"></a>`originator`
727 Data type: `Optional[String]`
729 Names the originator of the packages in the directory tree of the Release file.
733 ##### <a name="label"></a>`label`
735 Data type: `Optional[String]`
737 Names the label of the packages in the directory tree of the Release file.
741 ##### <a name="origin"></a>`origin`
743 Data type: `Optional[String]`
749 ##### <a name="version"></a>`version`
751 Data type: `Optional[String]`
757 ##### <a name="codename"></a>`codename`
759 Data type: `Optional[String]`
765 ### <a name="aptppa"></a>`apt::ppa`
767 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
771 ##### Example declaration of an Apt PPA
774 apt::ppa{ 'ppa:openstack-ppa/bleeding-edge': }
779 The following parameters are available in the `apt::ppa` defined type:
781 * [`ensure`](#ensure)
782 * [`options`](#options)
783 * [`release`](#release)
785 * [`package_name`](#package_name)
786 * [`package_manage`](#package_manage)
788 ##### <a name="ensure"></a>`ensure`
792 Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
794 Default value: `'present'`
796 ##### <a name="options"></a>`options`
798 Data type: `Optional[String]`
800 Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
802 Default value: `$::apt::ppa_options`
804 ##### <a name="release"></a>`release`
806 Data type: `Optional[String]`
808 Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
809 Optional if `puppet facts show os.distro.codename` returns your correct distribution release codename.
811 Default value: `$facts['os']['distro']['codename']`
813 ##### <a name="dist"></a>`dist`
815 Data type: `Optional[String]`
817 Specifies the distribution of your node. Valid options: a string containing a valid distribution codename.
818 Optional if `puppet facts show os.name` returns your correct distribution name.
820 Default value: `$facts['os']['name']`
822 ##### <a name="package_name"></a>`package_name`
824 Data type: `Optional[String]`
826 Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
828 Default value: `$::apt::ppa_package`
830 ##### <a name="package_manage"></a>`package_manage`
834 Specifies whether Puppet should manage the package that provides `apt-add-repository`.
836 Default value: ``false``
838 ### <a name="aptsetting"></a>`apt::setting`
840 Manages Apt configuration files.
843 * https://docs.puppetlabs.com/references/latest/type.html#file-attributes
844 * for more information on source and content parameters
848 The following parameters are available in the `apt::setting` defined type:
850 * [`priority`](#priority)
851 * [`ensure`](#ensure)
852 * [`source`](#source)
853 * [`content`](#content)
854 * [`notify_update`](#notify_update)
856 ##### <a name="priority"></a>`priority`
858 Data type: `Variant[String, Integer, Array]`
860 Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
864 ##### <a name="ensure"></a>`ensure`
866 Data type: `Optional[Enum['file', 'present', 'absent']]`
868 Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
870 Default value: `file`
872 ##### <a name="source"></a>`source`
874 Data type: `Optional[String]`
876 Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination
877 with `content`. Valid options: see link above for Puppet's native file type source attribute.
879 Default value: ``undef``
881 ##### <a name="content"></a>`content`
883 Data type: `Optional[String]`
885 Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid
886 options: see link above for Puppet's native file type content attribute.
888 Default value: ``undef``
890 ##### <a name="notify_update"></a>`notify_update`
894 Specifies whether to trigger an `apt-get update` run.
896 Default value: ``true``
898 ### <a name="aptsource"></a>`apt::source`
900 Manages the Apt sources in /etc/apt/sources.list.d/.
904 ##### Install the puppetlabs apt source
907 apt::source { 'puppetlabs':
908 location => 'http://apt.puppetlabs.com',
911 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
912 server => 'hkps.pool.sks-keyservers.net',
919 The following parameters are available in the `apt::source` defined type:
921 * [`location`](#location)
922 * [`comment`](#comment)
923 * [`ensure`](#ensure)
924 * [`release`](#release)
926 * [`include`](#include)
929 * [`architecture`](#architecture)
930 * [`allow_unsigned`](#allow_unsigned)
931 * [`notify_update`](#notify_update)
933 ##### <a name="location"></a>`location`
935 Data type: `Optional[String]`
937 Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
939 Default value: ``undef``
941 ##### <a name="comment"></a>`comment`
945 Supplies a comment for adding to the Apt source file.
947 Default value: `$name`
949 ##### <a name="ensure"></a>`ensure`
953 Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'.
955 Default value: `present`
957 ##### <a name="release"></a>`release`
959 Data type: `Optional[String]`
961 Specifies a distribution of the Apt repository.
963 Default value: ``undef``
965 ##### <a name="repos"></a>`repos`
969 Specifies a component of the Apt repository.
971 Default value: `'main'`
973 ##### <a name="include"></a>`include`
975 Data type: `Optional[Variant[Hash]]`
977 Configures include options. Valid options: a hash of available keys.
981 * **:deb** `Boolean`: Specifies whether to request the distribution's compiled binaries. Default true.
982 * **:src** `Boolean`: Specifies whether to request the distribution's uncompiled source code. Default false.
986 ##### <a name="key"></a>`key`
988 Data type: `Optional[Variant[String, Hash]]`
990 Creates a declaration of the apt::key defined type. Valid options: a string to be passed to the `id` parameter of the `apt::key`
991 defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or
992 `options` parameters.
994 Default value: ``undef``
996 ##### <a name="pin"></a>`pin`
998 Data type: `Optional[Variant[Hash, Numeric, String]]`
1000 Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the
1001 `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
1003 Default value: ``undef``
1005 ##### <a name="architecture"></a>`architecture`
1007 Data type: `Optional[String]`
1009 Tells Apt to only download information for specified architectures. Valid options: a string containing one or more architecture names,
1010 separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
1011 defined in the Apt::Architectures option).
1013 Default value: ``undef``
1015 ##### <a name="allow_unsigned"></a>`allow_unsigned`
1017 Data type: `Boolean`
1019 Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
1021 Default value: ``false``
1023 ##### <a name="notify_update"></a>`notify_update`
1025 Data type: `Boolean`
1027 Specifies whether to trigger an `apt-get update` run.
1029 Default value: ``true``
1035 ### <a name="aptauth_conf_entry"></a>`Apt::Auth_conf_entry`
1037 Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
1040 * https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html
1041 * for more information
1047 machine => String[1],
1055 The following parameters are available in the `Apt::Auth_conf_entry` data type:
1057 * [`machine`](#machine)
1059 * [`password`](#password)
1061 ##### <a name="machine"></a>`machine`
1063 Hostname of machine to connect to.
1065 ##### <a name="login"></a>`login`
1067 Specifies the username to connect with.
1069 ##### <a name="password"></a>`password`
1071 Specifies the password to connect with.
1073 ### <a name="aptproxy"></a>`Apt::Proxy`
1075 Configures Apt to connect to a proxy server.
1081 ensure => Optional[Enum['file', 'present', 'absent']],
1082 host => Optional[String],
1083 port => Optional[Integer[0, 65535]],
1084 https => Optional[Boolean],
1085 https_acng => Optional[Boolean],
1086 direct => Optional[Boolean],
1092 The following parameters are available in the `Apt::Proxy` data type:
1094 * [`ensure`](#ensure)
1098 * [`direct`](#direct)
1100 ##### <a name="ensure"></a>`ensure`
1102 Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
1104 ##### <a name="host"></a>`host`
1106 Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
1108 ##### <a name="port"></a>`port`
1110 Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
1112 ##### <a name="https"></a>`https`
1114 Specifies whether to enable https proxies.
1116 ##### <a name="direct"></a>`direct`
1118 Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
1122 ### <a name="init"></a>`init`
1124 Allows you to perform apt functions
1126 **Supports noop?** false
1132 Data type: `Enum[update, upgrade, dist-upgrade, autoremove]`