REFERENCE.md

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