Documentation

win_chocolatey_config – Manages Chocolatey config settings

New in version 2.7.

Synopsis

  • Used to manage Chocolatey config settings as well as unset the values.

Parameters

Parameter Choices/Defaults Comments
name
- / required
The name of the config setting to manage.
See https://chocolatey.org/docs/chocolatey-configuration for a list of valid configuration settings that can be changed.
Any config values that contain encrypted values like a password are not idempotent as the plaintext value cannot be read.
state
-
    Choices:
  • absent
  • present ←
When absent, it will ensure the setting is unset or blank.
When present, it will ensure the setting is set to the value of value.
value
-
Used when state=present that contains the value to set for the config setting.
Cannot be null or an empty string, use state=absent to unset a config value instead.

Examples

- name: set the cache location
  win_chocolatey_config:
    name: cacheLocation
    state: present
    value: D:\chocolatey_temp

- name: unset the cache location
  win_chocolatey_config:
    name: cacheLocation
    state: absent

Status

Authors

  • Jordan Borean (@jborean93)

Hint

If you notice any issues in this documentation you can edit this document to improve it.