(FM-7318) - Added Puppet Strings formatting to documentation
[puppet-modules/puppetlabs-apt.git] / types / proxy.pp
1 # @summary Configures Apt to connect to a proxy server.
2
3 # @param ensure
4 #   Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
5 #
6 # @param host
7 #   Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
8 #
9 # @param port
10 #   Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
11 #
12 # @param https
13 #   Specifies whether to enable https proxies.
14 #
15 # @param direct
16 #   Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
17 #
18 type Apt::Proxy = Struct[
19   {
20     ensure => Optional[Enum['file', 'present', 'absent']],
21     host   => Optional[String],
22     port   => Optional[Integer[0, 65535]],
23     https  => Optional[Boolean],
24     direct => Optional[Boolean],
25   }
26 ]