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): Manages apt-mark settings
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`
379 'server' => $keyserver,
385 ### <a name="aptbackports"></a>`apt::backports`
391 ##### Set up a backport source for Linux Mint qiana
394 class { 'apt::backports':
395 location => 'http://us.archive.ubuntu.com/ubuntu',
396 release => 'trusty-backports',
397 repos => 'main universe multiverse restricted',
399 id => '630239CC130E1A7FD81A27B140976EAF437D05B5',
400 server => 'keyserver.ubuntu.com',
407 The following parameters are available in the `apt::backports` class:
409 * [`location`](#location)
410 * [`release`](#release)
414 * [`include`](#include)
416 ##### <a name="location"></a>`location`
418 Data type: `Optional[String]`
420 Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Default value for Debian and
423 - Debian: 'http://deb.debian.org/debian'
425 - Ubuntu: 'http://archive.ubuntu.com/ubuntu'
427 Default value: ``undef``
429 ##### <a name="release"></a>`release`
431 Data type: `Optional[String]`
433 Specifies a distribution of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
434 Default: on Debian and Ubuntu, `${facts['os']['distro']['codename']}-backports`. We recommend keeping this default, except on other operating
437 Default value: ``undef``
439 ##### <a name="repos"></a>`repos`
441 Data type: `Optional[String]`
443 Specifies a component of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
444 Default value for Debian and Ubuntu varies:
446 - Debian: 'main contrib non-free'
448 - Ubuntu: 'main universe multiverse restricted'
450 Default value: ``undef``
452 ##### <a name="key"></a>`key`
454 Data type: `Optional[Variant[String, Hash]]`
456 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
457 hash of parameter => value pairs to be passed to apt::key's id, server, content, source, and/or options parameters. Default value
458 for Debian and Ubuntu varies:
460 - Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
462 - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
464 Default value: ``undef``
466 ##### <a name="pin"></a>`pin`
468 Data type: `Optional[Variant[Integer, String, Hash]]`
470 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
471 type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
475 ##### <a name="include"></a>`include`
477 Data type: `Optional[Variant[Hash]]`
479 Specifies whether to include 'deb' or 'src', or both.
485 ### <a name="aptconf"></a>`apt::conf`
487 Specifies a custom Apt configuration file.
491 The following parameters are available in the `apt::conf` defined type:
493 * [`content`](#content)
494 * [`ensure`](#ensure)
495 * [`priority`](#priority)
496 * [`notify_update`](#notify_update)
498 ##### <a name="content"></a>`content`
500 Data type: `Optional[String]`
502 Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
504 Default value: ``undef``
506 ##### <a name="ensure"></a>`ensure`
508 Data type: `Enum['present', 'absent']`
510 Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'.
512 Default value: `present`
514 ##### <a name="priority"></a>`priority`
516 Data type: `Variant[String, Integer]`
518 Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first.
519 Valid options: a string containing an integer or an integer.
523 ##### <a name="notify_update"></a>`notify_update`
525 Data type: `Optional[Boolean]`
527 Specifies whether to trigger an `apt-get update` run.
529 Default value: ``undef``
531 ### <a name="aptkey"></a>`apt::key`
533 Manages the GPG keys that Apt uses to authenticate packages.
535 * **Note** The apt::key defined type makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.
539 ##### Declare Apt key for apt.puppetlabs.com source
542 apt::key { 'puppetlabs':
543 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
544 server => 'keyserver.ubuntu.com',
545 options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
551 The following parameters are available in the `apt::key` defined type:
554 * [`ensure`](#ensure)
555 * [`content`](#content)
556 * [`source`](#source)
557 * [`server`](#server)
558 * [`weak_ssl`](#weak_ssl)
559 * [`options`](#options)
561 ##### <a name="id"></a>`id`
563 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/]`
565 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
566 characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
568 Default value: `$title`
570 ##### <a name="ensure"></a>`ensure`
572 Data type: `Enum['present', 'absent', 'refreshed']`
574 Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
575 update when they have expired (assuming a new key exists on the key server).
577 Default value: `present`
579 ##### <a name="content"></a>`content`
581 Data type: `Optional[String]`
583 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.
585 Default value: ``undef``
587 ##### <a name="source"></a>`source`
589 Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]`
591 Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
594 Default value: ``undef``
596 ##### <a name="server"></a>`server`
598 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\-_.]+)*\/?$/]`
600 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
601 hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
603 Default value: `$::apt::keyserver`
605 ##### <a name="weak_ssl"></a>`weak_ssl`
609 Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false.
611 Default value: ``false``
613 ##### <a name="options"></a>`options`
615 Data type: `Optional[String]`
617 Passes additional options to `apt-key adv --keyserver-options`.
619 Default value: `$::apt::key_options`
621 ### <a name="aptmark"></a>`apt::mark`
623 Manages apt-mark settings
627 The following parameters are available in the `apt::mark` defined type:
629 * [`setting`](#setting)
631 ##### <a name="setting"></a>`setting`
633 Data type: `Enum['auto','manual','hold','unhold']`
635 auto, manual, hold, unhold
636 specifies the behavior of apt in case of no more dependencies installed
637 https://manpages.debian.org/stable/apt/apt-mark.8.en.html
639 ### <a name="aptpin"></a>`apt::pin`
641 Manages Apt pins. Does not trigger an apt-get update run.
644 * http://linux.die.net/man/5/apt_preferences
645 * for context on these parameters
649 The following parameters are available in the `apt::pin` defined type:
651 * [`ensure`](#ensure)
652 * [`explanation`](#explanation)
654 * [`packages`](#packages)
655 * [`priority`](#priority)
656 * [`release`](#release)
657 * [`release_version`](#release_version)
658 * [`component`](#component)
659 * [`originator`](#originator)
661 * [`origin`](#origin)
662 * [`version`](#version)
663 * [`codename`](#codename)
665 ##### <a name="ensure"></a>`ensure`
667 Data type: `Optional[Enum['file', 'present', 'absent']]`
669 Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'.
671 Default value: `present`
673 ##### <a name="explanation"></a>`explanation`
675 Data type: `Optional[String]`
677 Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
679 Default value: ``undef``
681 ##### <a name="order"></a>`order`
683 Data type: `Variant[Integer]`
685 Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first.
689 ##### <a name="packages"></a>`packages`
691 Data type: `Variant[String, Array]`
693 Specifies which package(s) to pin.
697 ##### <a name="priority"></a>`priority`
699 Data type: `Variant[Numeric, String]`
701 Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest
702 priority number (subject to dependency constraints). Valid options: an integer.
706 ##### <a name="release"></a>`release`
708 Data type: `Optional[String]`
710 Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
714 ##### <a name="release_version"></a>`release_version`
716 Data type: `Optional[String]`
718 Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
722 ##### <a name="component"></a>`component`
724 Data type: `Optional[String]`
726 Names the licensing component associated with the packages in the directory tree of the Release file.
730 ##### <a name="originator"></a>`originator`
732 Data type: `Optional[String]`
734 Names the originator of the packages in the directory tree of the Release file.
738 ##### <a name="label"></a>`label`
740 Data type: `Optional[String]`
742 Names the label of the packages in the directory tree of the Release file.
746 ##### <a name="origin"></a>`origin`
748 Data type: `Optional[String]`
754 ##### <a name="version"></a>`version`
756 Data type: `Optional[String]`
762 ##### <a name="codename"></a>`codename`
764 Data type: `Optional[String]`
770 ### <a name="aptppa"></a>`apt::ppa`
772 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
776 ##### Example declaration of an Apt PPA
779 apt::ppa{ 'ppa:openstack-ppa/bleeding-edge': }
784 The following parameters are available in the `apt::ppa` defined type:
786 * [`ensure`](#ensure)
787 * [`options`](#options)
788 * [`release`](#release)
790 * [`package_name`](#package_name)
791 * [`package_manage`](#package_manage)
793 ##### <a name="ensure"></a>`ensure`
797 Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
799 Default value: `'present'`
801 ##### <a name="options"></a>`options`
803 Data type: `Optional[String]`
805 Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
807 Default value: `$::apt::ppa_options`
809 ##### <a name="release"></a>`release`
811 Data type: `Optional[String]`
813 Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
814 Optional if `puppet facts show os.distro.codename` returns your correct distribution release codename.
816 Default value: `$facts['os']['distro']['codename']`
818 ##### <a name="dist"></a>`dist`
820 Data type: `Optional[String]`
822 Specifies the distribution of your node. Valid options: a string containing a valid distribution codename.
823 Optional if `puppet facts show os.name` returns your correct distribution name.
825 Default value: `$facts['os']['name']`
827 ##### <a name="package_name"></a>`package_name`
829 Data type: `Optional[String]`
831 Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
833 Default value: `$::apt::ppa_package`
835 ##### <a name="package_manage"></a>`package_manage`
839 Specifies whether Puppet should manage the package that provides `apt-add-repository`.
841 Default value: ``false``
843 ### <a name="aptsetting"></a>`apt::setting`
845 Manages Apt configuration files.
848 * https://docs.puppetlabs.com/references/latest/type.html#file-attributes
849 * for more information on source and content parameters
853 The following parameters are available in the `apt::setting` defined type:
855 * [`priority`](#priority)
856 * [`ensure`](#ensure)
857 * [`source`](#source)
858 * [`content`](#content)
859 * [`notify_update`](#notify_update)
861 ##### <a name="priority"></a>`priority`
863 Data type: `Variant[String, Integer, Array]`
865 Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
869 ##### <a name="ensure"></a>`ensure`
871 Data type: `Optional[Enum['file', 'present', 'absent']]`
873 Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
875 Default value: `file`
877 ##### <a name="source"></a>`source`
879 Data type: `Optional[String]`
881 Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination
882 with `content`. Valid options: see link above for Puppet's native file type source attribute.
884 Default value: ``undef``
886 ##### <a name="content"></a>`content`
888 Data type: `Optional[String]`
890 Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid
891 options: see link above for Puppet's native file type content attribute.
893 Default value: ``undef``
895 ##### <a name="notify_update"></a>`notify_update`
899 Specifies whether to trigger an `apt-get update` run.
901 Default value: ``true``
903 ### <a name="aptsource"></a>`apt::source`
905 Manages the Apt sources in /etc/apt/sources.list.d/.
909 ##### Install the puppetlabs apt source
912 apt::source { 'puppetlabs':
913 location => 'http://apt.puppetlabs.com',
916 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
917 server => 'keyserver.ubuntu.com',
924 The following parameters are available in the `apt::source` defined type:
926 * [`location`](#location)
927 * [`comment`](#comment)
928 * [`ensure`](#ensure)
929 * [`release`](#release)
931 * [`include`](#include)
933 * [`keyring`](#keyring)
935 * [`architecture`](#architecture)
936 * [`allow_unsigned`](#allow_unsigned)
937 * [`notify_update`](#notify_update)
939 ##### <a name="location"></a>`location`
941 Data type: `Optional[String]`
943 Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
945 Default value: ``undef``
947 ##### <a name="comment"></a>`comment`
951 Supplies a comment for adding to the Apt source file.
953 Default value: `$name`
955 ##### <a name="ensure"></a>`ensure`
959 Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'.
961 Default value: `present`
963 ##### <a name="release"></a>`release`
965 Data type: `Optional[String]`
967 Specifies a distribution of the Apt repository.
969 Default value: ``undef``
971 ##### <a name="repos"></a>`repos`
975 Specifies a component of the Apt repository.
977 Default value: `'main'`
979 ##### <a name="include"></a>`include`
981 Data type: `Optional[Variant[Hash]]`
983 Configures include options. Valid options: a hash of available keys.
987 * **:deb** `Boolean`: Specifies whether to request the distribution's compiled binaries. Default true.
988 * **:src** `Boolean`: Specifies whether to request the distribution's uncompiled source code. Default false.
992 ##### <a name="key"></a>`key`
994 Data type: `Optional[Variant[String, Hash]]`
996 Creates a declaration of the apt::key defined type. Valid options: a string to be passed to the `id` parameter of the `apt::key`
997 defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, `weak_ssl`,
998 and/or `options` parameters.
1000 Default value: ``undef``
1002 ##### <a name="keyring"></a>`keyring`
1004 Data type: `Optional[Stdlib::AbsolutePath]`
1006 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.
1007 See https://wiki.debian.org/DebianRepository/UseThirdParty for details.
1009 Default value: ``undef``
1011 ##### <a name="pin"></a>`pin`
1013 Data type: `Optional[Variant[Hash, Numeric, String]]`
1015 Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the
1016 `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
1018 Default value: ``undef``
1020 ##### <a name="architecture"></a>`architecture`
1022 Data type: `Optional[String]`
1024 Tells Apt to only download information for specified architectures. Valid options: a string containing one or more architecture names,
1025 separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
1026 defined in the Apt::Architectures option).
1028 Default value: ``undef``
1030 ##### <a name="allow_unsigned"></a>`allow_unsigned`
1032 Data type: `Boolean`
1034 Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
1036 Default value: ``false``
1038 ##### <a name="notify_update"></a>`notify_update`
1040 Data type: `Boolean`
1042 Specifies whether to trigger an `apt-get update` run.
1044 Default value: ``true``
1050 ### <a name="aptauth_conf_entry"></a>`Apt::Auth_conf_entry`
1052 Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
1055 * https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html
1056 * for more information
1062 machine => String[1],
1070 The following parameters are available in the `Apt::Auth_conf_entry` data type:
1072 * [`machine`](#machine)
1074 * [`password`](#password)
1076 ##### <a name="machine"></a>`machine`
1078 Hostname of machine to connect to.
1080 ##### <a name="login"></a>`login`
1082 Specifies the username to connect with.
1084 ##### <a name="password"></a>`password`
1086 Specifies the password to connect with.
1088 ### <a name="aptproxy"></a>`Apt::Proxy`
1090 Configures Apt to connect to a proxy server.
1096 ensure => Optional[Enum['file', 'present', 'absent']],
1097 host => Optional[String],
1098 port => Optional[Integer[0, 65535]],
1099 https => Optional[Boolean],
1100 https_acng => Optional[Boolean],
1101 direct => Optional[Boolean],
1107 The following parameters are available in the `Apt::Proxy` data type:
1109 * [`ensure`](#ensure)
1113 * [`direct`](#direct)
1115 ##### <a name="ensure"></a>`ensure`
1117 Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
1119 ##### <a name="host"></a>`host`
1121 Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
1123 ##### <a name="port"></a>`port`
1125 Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
1127 ##### <a name="https"></a>`https`
1129 Specifies whether to enable https proxies.
1131 ##### <a name="direct"></a>`direct`
1133 Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
1137 ### <a name="init"></a>`init`
1139 Allows you to perform apt functions
1141 **Supports noop?** false
1147 Data type: `Enum[update, upgrade, dist-upgrade, autoremove]`