Resource Type: chocolateysource

Defined in:
lib/puppet/type/chocolateysource.rb
Providers:
windows

Overview

Allows managing sources for Chocolatey. A source can be a folder, a CIFS share, a NuGet Http OData feed, or a full Package Gallery. Learn more about sources at chocolatey.org/docs/how-to-host-feed

Properties

  • admin_only (defaults to: false)

    Option to specify whether this source should visible to Windows user accounts in the Administrators group only.

    Requires Chocolatey for Business (C4B) v1.12.2+ and at least Chocolatey v0.10.8 for the setting to be respected. Defaults to false.

    Supported values:
    • true
    • false
  • allow_self_service (defaults to: false)

    Option to specify whether this source should be allowed to be used with Chocolatey Self Service.

    Requires Chocolatey for Business (C4B) v1.10.0+ with the feature useBackgroundServiceWithSelfServiceSourcesOnly turned on in order to be respected. Also requires at least Chocolatey v0.10.4 for the setting to be enabled. Defaults to false.

    Supported values:
    • true
    • false
  • bypass_proxy (defaults to: false)

    Option to specify whether this source should explicitly bypass any explicitly or system configured proxies. Requires at least Chocolatey v0.10.4. Defaults to false.

    Supported values:
    • true
    • false
  • ensure (defaults to: present)

    Specifies state of resource

    Supported values:
    • present
    • disabled
    • absent
  • location

    The location of the source repository. Can be a url pointing to an OData feed (like chocolatey/chocolatey_server), a CIFS (UNC) share, or a local folder. Required when ‘ensure => present` (the default for `ensure`).

  • priority (defaults to: 0)

    Optional priority for explicit feed order when searching for packages across multiple feeds. The lower the number the higher the priority. Sources with a 0 priority are considered no priority and are added after other sources with a priority number. Requires at least Chocolatey v0.9.9.9. Defaults to 0.

  • user (defaults to: '')

    Optional user name for authenticated feeds. Requires at least Chocolatey v0.9.9.0. Defaults to ‘nil`. Specifying an empty value is the same as setting the value to nil or not specifying the property at all.

Parameters

  • name (namevar)

    The name of the source. Used for uniqueness.

  • password (defaults to: '')

    Optional user password for authenticated feeds. Not ensurable. Value is not able to be checked with current value. If you need to update the password, update another setting as well. Requires at least Chocolatey v0.9.9.0. Defaults to ‘nil`. Specifying an empty value is the same as setting the value to nil or not specifying the property at all.

  • provider

    The specific backend to use for this ‘chocolateysource` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.