REFERENCE.md

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