You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

chocolatey.chocolatey.win_chocolatey_facts – Create a facts collection for Chocolatey

Note

This plugin is part of the chocolatey.chocolatey collection (version 1.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install chocolatey.chocolatey.

To use it in a playbook, specify: chocolatey.chocolatey.win_chocolatey_facts.

New in version 0.2.8: of chocolatey.chocolatey

Synopsis

• This module shows information from Chocolatey, such as installed packages, configuration, feature and sources.

Notes

Note

• Chocolatey must be installed beforehand, use M(win_chocolatey) to do this.

See Also

See also

M(win_chocolatey)

The official documentation on the win_chocolatey module.

M(win_chocolatey_config)

The official documentation on the win_chocolatey_config module.

M(win_chocolatey_feature)

The official documentation on the win_chocolatey_feature module.

M(win_chocolatey_source)

The official documentation on the win_chocolatey_source module.

Examples

- name: Gather facts from chocolatey
  win_chocolatey_facts:

- name: Displays the Configuration
  debug:
    var: ansible_chocolatey.config

- name: Displays the Feature
  debug:
    var: ansible_chocolatey.feature

- name: Displays the Sources
  debug:
    var: ansible_chocolatey.sources

- name: Displays the Packages
  debug:
    var: ansible_chocolatey.packages

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
ansible_chocolatey complex	Detailed information about the Chocolatey installation Returned: always
config dictionary	Detailed information about stored the configurations Returned: always Sample: {“commandExecutionTimeoutSeconds”: 2700, “containsLegacyPackageInstalls”: true}
feature dictionary	Detailed information about enabled and disabled features Returned: always Sample: {“allowEmptyCheckums”: false, “autoUninstaller”: true, “failOnAutoUninstaller”: false}
packages complex	List of installed Packages Returned: always
package string	Name of the package Returned: always Sample: “vscode”
version string	Version of the package Returned: always Sample: “1.27.2”
sources complex	List of Chocolatey sources Returned: always
admin_only boolean	Is the source visible to Administrators only Returned: always Sample: false
allow_self_service boolean	Is the source allowed to be used with self-service Returned: always Sample: false
bypass_proxy boolean	Can the source explicitly bypass configured proxies Returned: always Sample: true
certificate string	Pth to a PFX certificate for X509 authenticated feeds Returned: always Sample: “C:\\chocolatey\\cert.pfx”
disabled boolean	Is the source disabled Returned: always Sample: false
name string	Name of the source Returned: always Sample: “chocolatey”
priority integer	The priority order of this source, lower is better, 0 is no priority Returned: always Sample: 0
source string	The source, can be a folder/file or an url Returned: always Sample: “https://chocolatey.org/api/v2/”
source_username string	Username used to access authenticated feeds Returned: always Sample: “username”

Authors

• Simon Bärlocher (@sbaerlocher)

• ITIGO AG (@itigoag)