X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=REFERENCE.md;h=dc1e5edd7a7ab75e809420fbc1acdfe6029ec2f1;hb=a3b82bc64f4c643631f7841119518dc2ec09fdac;hp=be2e9810babacc5a760af9d8b936f71e36da8731;hpb=238898455f0d9c4d5fc0d4a2ad950982835a72ab;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/REFERENCE.md b/REFERENCE.md index be2e981..dc1e5ed 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,53 +1,60 @@ # Reference + ## Table of Contents -**Classes** +### Classes -_Public Classes_ +#### Public Classes * [`apt`](#apt): Main class, includes all other classes. * [`apt::backports`](#aptbackports): Manages backports. -_Private Classes_ +#### Private Classes * `apt::params`: Provides defaults for the Apt module parameters. * `apt::update`: Updates the list of available packages using apt-get update. -**Defined types** +### Defined types * [`apt::conf`](#aptconf): Specifies a custom Apt configuration file. * [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages. +* [`apt::mark`](#aptmark): defined typeapt::mark * [`apt::pin`](#aptpin): Manages Apt pins. Does not trigger an apt-get update run. * [`apt::ppa`](#aptppa): Manages PPA repositories using `add-apt-repository`. Not supported on Debian. * [`apt::setting`](#aptsetting): Manages Apt configuration files. * [`apt::source`](#aptsource): Manages the Apt sources in /etc/apt/sources.list.d/. -**Resource types** +### Resource types -_Public Resource types_ +#### Public Resource types -_Private Resource types_ +#### Private Resource types * `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed by apt to perform package validation. Apt has it's own GPG keyring that can be manipulated through the `apt-key` command. -**Tasks** +### Data types + +* [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`. +* [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server. + +### Tasks * [`init`](#init): Allows you to perform apt functions ## Classes -### apt +### `apt` Main class, includes all other classes. * **See also** -https://docs.puppetlabs.com/references/latest/function.html#createresources -for the create resource function + * https://docs.puppetlabs.com/references/latest/function.html#createresources + * for the create resource function #### Parameters @@ -59,16 +66,24 @@ Data type: `String` Specifies the provider that should be used by apt::update. -Default value: $apt::params::provider +Default value: `$apt::params::provider` ##### `keyserver` Data type: `String` -Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, -hkp:// or hkps://). +Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or +hkp://). + +Default value: `$apt::params::keyserver` -Default value: $apt::params::keyserver +##### `key_options` + +Data type: `Optional[String]` + +Specifies the default options for apt::key resources. + +Default value: `$apt::params::key_options` ##### `ppa_options` @@ -76,7 +91,7 @@ Data type: `Optional[String]` Supplies options to be passed to the `add-apt-repository` command. -Default value: $apt::params::ppa_options +Default value: `$apt::params::ppa_options` ##### `ppa_package` @@ -84,7 +99,7 @@ Data type: `Optional[String]` Names the package that provides the `apt-add-repository` command. -Default value: $apt::params::ppa_package +Default value: `$apt::params::ppa_package` ##### `backports` @@ -98,7 +113,7 @@ Options: * **:repos** `String`: See apt::backports for documentation. * **:key** `String`: See apt::backports for documentation. -Default value: $apt::params::backports +Default value: `$apt::params::backports` ##### `confs` @@ -106,7 +121,7 @@ Data type: `Hash` Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above. -Default value: $apt::params::confs +Default value: `$apt::params::confs` ##### `update` @@ -124,7 +139,7 @@ Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_upd * **:timeout** `Integer`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef. * **:tries** `Integer`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef. -Default value: $apt::params::update +Default value: `$apt::params::update` ##### `purge` @@ -139,7 +154,7 @@ Options: * **:preferences** `Boolean`: Specifies whether to purge any unmanaged entries from preferences. Default false. * **:preferences.d.** `Boolean`: Specifies whether to purge any unmanaged entries from preferences.d. Default false. -Default value: $apt::params::purge +Default value: `$apt::params::purge` ##### `proxy` @@ -147,7 +162,7 @@ Data type: `Apt::Proxy` Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy. -Default value: $apt::params::proxy +Default value: `$apt::params::proxy` ##### `sources` @@ -155,7 +170,7 @@ Data type: `Hash` Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above. -Default value: $apt::params::sources +Default value: `$apt::params::sources` ##### `keys` @@ -163,7 +178,7 @@ Data type: `Hash` Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above. -Default value: $apt::params::keys +Default value: `$apt::params::keys` ##### `ppas` @@ -171,7 +186,7 @@ Data type: `Hash` Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above. -Default value: $apt::params::ppas +Default value: `$apt::params::ppas` ##### `pins` @@ -179,7 +194,7 @@ Data type: `Hash` Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above. -Default value: $apt::params::pins +Default value: `$apt::params::pins` ##### `settings` @@ -187,7 +202,16 @@ Data type: `Hash` Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above. -Default value: $apt::params::settings +Default value: `$apt::params::settings` + +##### `manage_auth_conf` + +Data type: `Boolean` + +Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in +the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent. + +Default value: `$apt::params::manage_auth_conf` ##### `auth_conf_entries` @@ -196,9 +220,17 @@ Data type: `Array[Apt::Auth_conf_entry]` An optional array of login configuration settings (hashes) that are recorded in the file /etc/apt/auth.conf. This file has a netrc-like format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details. If specified each hash must contain the keys machine, login and -password and no others. +password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent. -Default value: $apt::params::auth_conf_entries +Default value: `$apt::params::auth_conf_entries` + +##### `auth_conf_owner` + +Data type: `String` + +The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases. + +Default value: `$apt::params::auth_conf_owner` ##### `root` @@ -206,7 +238,7 @@ Data type: `String` Specifies root directory of Apt executable. -Default value: $apt::params::root +Default value: `$apt::params::root` ##### `sources_list` @@ -214,7 +246,7 @@ Data type: `String` Specifies the path of the sources_list file to use. -Default value: $apt::params::sources_list +Default value: `$apt::params::sources_list` ##### `sources_list_d` @@ -222,7 +254,7 @@ Data type: `String` Specifies the path of the sources_list.d file to use. -Default value: $apt::params::sources_list_d +Default value: `$apt::params::sources_list_d` ##### `conf_d` @@ -230,7 +262,7 @@ Data type: `String` Specifies the path of the conf.d file to use. -Default value: $apt::params::conf_d +Default value: `$apt::params::conf_d` ##### `preferences` @@ -238,7 +270,7 @@ Data type: `String` Specifies the path of the preferences file to use. -Default value: $apt::params::preferences +Default value: `$apt::params::preferences` ##### `preferences_d` @@ -246,7 +278,7 @@ Data type: `String` Specifies the path of the preferences.d file to use. -Default value: $apt::params::preferences_d +Default value: `$apt::params::preferences_d` ##### `config_files` @@ -254,7 +286,15 @@ Data type: `Hash` A hash made up of the various configuration files used by Apt. -Default value: $apt::params::config_files +Default value: `$apt::params::config_files` + +##### `sources_list_force` + +Data type: `Boolean` + +Specifies whether to perform force purge or delete. Default false. + +Default value: `$apt::params::sources_list_force` ##### `update_defaults` @@ -262,7 +302,7 @@ Data type: `Hash` -Default value: $apt::params::update_defaults +Default value: `$apt::params::update_defaults` ##### `purge_defaults` @@ -270,7 +310,7 @@ Data type: `Hash` -Default value: $apt::params::purge_defaults +Default value: `$apt::params::purge_defaults` ##### `proxy_defaults` @@ -278,7 +318,7 @@ Data type: `Hash` -Default value: $apt::params::proxy_defaults +Default value: `$apt::params::proxy_defaults` ##### `include_defaults` @@ -286,7 +326,15 @@ Data type: `Hash` -Default value: $apt::params::include_defaults +Default value: `$apt::params::include_defaults` + +##### `apt_conf_d` + +Data type: `String` + + + +Default value: `$apt::params::apt_conf_d` ##### `source_key_defaults` @@ -294,18 +342,18 @@ Data type: `Hash` -Default value: $apt::params::source_key_defaults +Default value: `$apt::params::source_key_defaults` -### apt::backports +### `apt::backports` Manages backports. #### Examples -##### Set up a backport for linuxmint qiana +##### Set up a backport source for Linux Mint qiana ```puppet -apt::backports { 'qiana': +class { 'apt::backports': location => 'http://us.archive.ubuntu.com/ubuntu', release => 'trusty-backports', repos => 'main universe multiverse restricted', @@ -331,7 +379,7 @@ Ubuntu varies: - Ubuntu: 'http://archive.ubuntu.com/ubuntu' -Default value: `undef` +Default value: ``undef`` ##### `release` @@ -341,7 +389,7 @@ Specifies a distribution of the Apt repository containing the backports to manag Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating systems. -Default value: `undef` +Default value: ``undef`` ##### `repos` @@ -354,7 +402,7 @@ Default value for Debian and Ubuntu varies: - Ubuntu: 'main universe multiverse restricted' -Default value: `undef` +Default value: ``undef`` ##### `key` @@ -368,7 +416,7 @@ for Debian and Ubuntu varies: - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5' -Default value: `undef` +Default value: ``undef`` ##### `pin` @@ -377,11 +425,19 @@ Data type: `Optional[Variant[Integer, String, Hash]]` Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. -Default value: 200 +Default value: `200` + +##### `include` + +Data type: `Optional[Variant[Hash]]` + +Specifies whether to include 'deb' or 'src', or both. + +Default value: `{}` ## Defined types -### apt::conf +### `apt::conf` Specifies a custom Apt configuration file. @@ -395,7 +451,7 @@ Data type: `Optional[String]` Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file. -Default value: `undef` +Default value: ``undef`` ##### `ensure` @@ -403,7 +459,7 @@ Data type: `Enum['present', 'absent']` Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. -Default value: present +Default value: `present` ##### `priority` @@ -412,7 +468,7 @@ Data type: `Variant[String, Integer]` Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. Valid options: a string containing an integer or an integer. -Default value: 50 +Default value: `50` ##### `notify_update` @@ -420,9 +476,9 @@ Data type: `Optional[Boolean]` Specifies whether to trigger an `apt-get update` run. -Default value: `undef` +Default value: ``undef`` -### apt::key +### `apt::key` Manages the GPG keys that Apt uses to authenticate packages. @@ -451,7 +507,7 @@ Data type: `Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/, /\A(0x)?[0-9a-fA-F]{16}\Z/, /\A(0 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). -Default value: $title +Default value: `$title` ##### `ensure` @@ -460,7 +516,7 @@ Data type: `Enum['present', 'absent', 'refreshed']` Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto update when they have expired (assuming a new key exists on the key server). -Default value: present +Default value: `present` ##### `content` @@ -468,7 +524,7 @@ Data type: `Optional[String]` Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. -Default value: `undef` +Default value: ``undef`` ##### `source` @@ -477,16 +533,24 @@ Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]` Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. -Default value: `undef` +Default value: ``undef`` ##### `server` -Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/]` +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\-_.]+)*\/?$/]` Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, -hkp:// or hkps://). +hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04. -Default value: $::apt::keyserver +Default value: `$::apt::keyserver` + +##### `weak_ssl` + +Data type: `Boolean` + +Specifies whether strict SSL verification on a https URL should be disabled. Valid options: true or false. + +Default value: ``false`` ##### `options` @@ -494,15 +558,31 @@ Data type: `Optional[String]` Passes additional options to `apt-key adv --keyserver-options`. -Default value: `undef` +Default value: `$::apt::key_options` + +### `apt::mark` -### apt::pin +defined typeapt::mark + +#### Parameters + +The following parameters are available in the `apt::mark` defined type. + +##### `setting` + +Data type: `Enum['auto','manual','hold','unhold']` + +auto, manual, hold, unhold +specifies the behavior of apt in case of no more dependencies installed +https://manpages.debian.org/sretch/apt/apt-mark.8.en.html + +### `apt::pin` Manages Apt pins. Does not trigger an apt-get update run. * **See also** -http://linux.die.net/man/5/apt_preferences -for context on these parameters + * http://linux.die.net/man/5/apt_preferences + * for context on these parameters #### Parameters @@ -514,7 +594,7 @@ Data type: `Optional[Enum['file', 'present', 'absent']]` Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. -Default value: present +Default value: `present` ##### `explanation` @@ -522,7 +602,7 @@ Data type: `Optional[String]` Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}". -Default value: `undef` +Default value: ``undef`` ##### `order` @@ -530,7 +610,7 @@ Data type: `Variant[Integer]` Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first. -Default value: 50 +Default value: `50` ##### `packages` @@ -538,7 +618,7 @@ Data type: `Variant[String, Array]` Specifies which package(s) to pin. -Default value: '*' +Default value: `'*'` ##### `priority` @@ -547,7 +627,7 @@ Data type: `Variant[Numeric, String]` Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest priority number (subject to dependency constraints). Valid options: an integer. -Default value: 0 +Default value: `0` ##### `release` @@ -555,7 +635,7 @@ Data type: `Optional[String]` Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'. -Default value: '' +Default value: `''` ##### `release_version` @@ -563,7 +643,7 @@ Data type: `Optional[String]` Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7). -Default value: '' +Default value: `''` ##### `component` @@ -571,7 +651,7 @@ Data type: `Optional[String]` Names the licensing component associated with the packages in the directory tree of the Release file. -Default value: '' +Default value: `''` ##### `originator` @@ -579,7 +659,7 @@ Data type: `Optional[String]` Names the originator of the packages in the directory tree of the Release file. -Default value: '' +Default value: `''` ##### `label` @@ -587,7 +667,7 @@ Data type: `Optional[String]` Names the label of the packages in the directory tree of the Release file. -Default value: '' +Default value: `''` ##### `origin` @@ -595,7 +675,7 @@ Data type: `Optional[String]` -Default value: '' +Default value: `''` ##### `version` @@ -603,7 +683,7 @@ Data type: `Optional[String]` -Default value: '' +Default value: `''` ##### `codename` @@ -611,9 +691,9 @@ Data type: `Optional[String]` -Default value: '' +Default value: `''` -### apt::ppa +### `apt::ppa` Manages PPA repositories using `add-apt-repository`. Not supported on Debian. @@ -635,7 +715,7 @@ Data type: `String` Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. -Default value: 'present' +Default value: `'present'` ##### `options` @@ -643,7 +723,7 @@ Data type: `Optional[String]` Supplies options to be passed to the `add-apt-repository` command. Default: '-y'. -Default value: $::apt::ppa_options +Default value: `$::apt::ppa_options` ##### `release` @@ -652,7 +732,16 @@ Data type: `Optional[String]` Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint). Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename. -Default value: $facts['lsbdistcodename'] +Default value: `$facts['lsbdistcodename']` + +##### `dist` + +Data type: `Optional[String]` + +Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint). +Specifies the distribution of your node. Valid options: a string containing a valid distribution codename. + +Default value: `$facts['lsbdistid']` ##### `package_name` @@ -660,7 +749,7 @@ Data type: `Optional[String]` Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'. -Default value: $::apt::ppa_package +Default value: `$::apt::ppa_package` ##### `package_manage` @@ -668,15 +757,15 @@ Data type: `Boolean` Specifies whether Puppet should manage the package that provides `apt-add-repository`. -Default value: `false` +Default value: ``false`` -### apt::setting +### `apt::setting` Manages Apt configuration files. * **See also** -https://docs.puppetlabs.com/references/latest/type.html#file-attributes -for more information on source and content parameters + * https://docs.puppetlabs.com/references/latest/type.html#file-attributes + * for more information on source and content parameters #### Parameters @@ -688,7 +777,7 @@ Data type: `Variant[String, Integer, Array]` Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first. -Default value: 50 +Default value: `50` ##### `ensure` @@ -696,7 +785,7 @@ Data type: `Optional[Enum['file', 'present', 'absent']]` Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. -Default value: file +Default value: `file` ##### `source` @@ -705,7 +794,7 @@ Data type: `Optional[String]` Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination with `content`. Valid options: see link above for Puppet's native file type source attribute. -Default value: `undef` +Default value: ``undef`` ##### `content` @@ -714,7 +803,7 @@ Data type: `Optional[String]` Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid options: see link above for Puppet's native file type content attribute. -Default value: `undef` +Default value: ``undef`` ##### `notify_update` @@ -722,9 +811,9 @@ Data type: `Boolean` Specifies whether to trigger an `apt-get update` run. -Default value: `true` +Default value: ``true`` -### apt::source +### `apt::source` Manages the Apt sources in /etc/apt/sources.list.d/. @@ -753,7 +842,7 @@ Data type: `Optional[String]` Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL. -Default value: `undef` +Default value: ``undef`` ##### `comment` @@ -761,7 +850,7 @@ Data type: `String` Supplies a comment for adding to the Apt source file. -Default value: $name +Default value: `$name` ##### `ensure` @@ -769,7 +858,7 @@ Data type: `String` Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. -Default value: present +Default value: `present` ##### `release` @@ -777,7 +866,7 @@ Data type: `Optional[String]` Specifies a distribution of the Apt repository. -Default value: `undef` +Default value: ``undef`` ##### `repos` @@ -785,7 +874,7 @@ Data type: `String` Specifies a component of the Apt repository. -Default value: 'main' +Default value: `'main'` ##### `include` @@ -798,7 +887,7 @@ Options: * **:deb** `Boolean`: Specifies whether to request the distribution's compiled binaries. Default true. * **:src** `Boolean`: Specifies whether to request the distribution's uncompiled source code. Default false. -Default value: {} +Default value: `{}` ##### `key` @@ -808,7 +897,7 @@ Creates a declaration of the apt::key defined type. Valid options: a string to b defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. -Default value: `undef` +Default value: ``undef`` ##### `pin` @@ -817,7 +906,7 @@ Data type: `Optional[Variant[Hash, Numeric, String]]` Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. -Default value: `undef` +Default value: ``undef`` ##### `architecture` @@ -827,7 +916,7 @@ Tells Apt to only download information for specified architectures. Valid option separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures defined in the Apt::Architectures option). -Default value: `undef` +Default value: ``undef`` ##### `allow_unsigned` @@ -835,7 +924,7 @@ Data type: `Boolean` Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked. -Default value: `false` +Default value: ``false`` ##### `notify_update` @@ -843,13 +932,82 @@ Data type: `Boolean` Specifies whether to trigger an `apt-get update` run. -Default value: `true` +Default value: ``true`` ## Resource types +## Data types + +### `Apt::Auth_conf_entry` + +Login configuration settings that are recorded in the file `/etc/apt/auth.conf`. + +* **See also** + * https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html + * for more information + +Alias of `Struct[{ + machine => String[1], + login => String, + password => String + }]` + +#### Parameters + +The following parameters are available in the `Apt::Auth_conf_entry` data type. + +##### `machine` + +Hostname of machine to connect to. + +##### `login` + +Specifies the username to connect with. + +##### `password` + +Specifies the password to connect with. + +### `Apt::Proxy` + +Configures Apt to connect to a proxy server. + +Alias of `Struct[{ + ensure => Optional[Enum['file', 'present', 'absent']], + host => Optional[String], + port => Optional[Integer[0, 65535]], + https => Optional[Boolean], + https_acng => Optional[Boolean], + direct => Optional[Boolean], + }]` + +#### Parameters + +The following parameters are available in the `Apt::Proxy` data type. + +##### `ensure` + +Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'. + +##### `host` + +Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. + +##### `port` + +Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number. + +##### `https` + +Specifies whether to enable https proxies. + +##### `direct` + +Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not. + ## Tasks -### init +### `init` Allows you to perform apt functions @@ -859,7 +1017,7 @@ Allows you to perform apt functions ##### `action` -Data type: `Enum[update, upgrade]` +Data type: `Enum[update, upgrade, dist-upgrade, autoremove]` Action to perform