Merge pull request #865 from tphoney/FM-7709

[puppet-modules/puppetlabs-apt.git] / REFERENCE.md

diff --git a/REFERENCE.md b/REFERENCE.md
index 3e1347a9f9381370073d78e505055866113cefeb..06aff2140df92acfae30e2d77dcd2e171f50d552 100644 (file)
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -189,6 +189,15 @@ Creates new `apt::setting` resources. Valid options: a hash to be passed to the
 
 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`
 
 Data type: `Array[Apt::Auth_conf_entry]`
@@ -196,10 +205,18 @@ 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
 
+##### `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`
 
 Data type: `String`
@@ -455,9 +472,10 @@ Default value: $title
 
 ##### `ensure`
 
-Data type: `Enum['present', 'absent']`
+Data type: `Enum['present', 'absent', 'refreshed']`
 
-Specifies whether the key should exist. Valid options: 'present' and 'absent'.
+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
 
@@ -480,13 +498,21 @@ Default value: `undef`
 
 ##### `server`
 
-Data type: `Pattern[/\A((hkp|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})?$/]`
 
-Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
-hkp://).
+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://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
 
 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`
 
 Data type: `Optional[String]`
@@ -858,7 +884,7 @@ Allows you to perform apt functions
 
 ##### `action`
 
-Data type: `Enum[update, upgrade]`
+Data type: `Enum[update, upgrade, dist-upgrade, autoremove]`
 
 Action to perform