win_chocolatey_facts – Create a facts collection for Chocolatey
New in version 2.8.
Synopsis
- This module shows information from Chocolatey, such as installed packages, configuration, feature and sources.
Notes
Note
- Chocolatey must be installed beforehand, use win_chocolatey to do this.
See Also
See also
- win_chocolatey – Manage packages using chocolatey
- The official documentation on the win_chocolatey module.
- win_chocolatey_config – Manages Chocolatey config settings
- The official documentation on the win_chocolatey_config module.
- win_chocolatey_feature – Manages Chocolatey features
- The official documentation on the win_chocolatey_feature module.
- win_chocolatey_source – Manages Chocolatey sources
- 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.
| Fact | Returned | Description | ||
|---|---|---|---|---|
| ansible_chocolatey
complex
|
always |
Detailed information about the Chocolatey installation
|
||
| config
dictionary
|
always |
Detailed information about stored the configurations
Sample:
{'commandExecutionTimeoutSeconds': 2700, 'containsLegacyPackageInstalls': True}
|
||
| feature
dictionary
|
always |
Detailed information about enabled and disabled features
Sample:
{'allowEmptyCheckums': False, 'autoUninstaller': True, 'failOnAutoUninstaller': False}
|
||
| packages
complex
|
always |
List of installed Packages
|
||
| package
string
|
always |
Name of the package
Sample:
vscode
|
||
| version
string
|
always |
Version of the package
Sample:
1.27.2
|
||
| sources
complex
|
always |
List of Chocolatey sources
|
||
| admin_only
boolean
|
always |
Is the source visible to Administrators only
|
||
| allow_self_service
boolean
|
always |
Is the source allowed to be used with self-service
|
||
| bypass_proxy
boolean
|
always |
Can the source explicitly bypass configured proxies
Sample:
True
|
||
| certificate
string
|
always |
Pth to a PFX certificate for X509 authenticated feeds
Sample:
C:\chocolatey\cert.pfx
|
||
| disabled
boolean
|
always |
Is the source disabled
|
||
| name
string
|
always |
Name of the source
Sample:
chocolatey
|
||
| priority
integer
|
always |
The priority order of this source, lower is better, 0 is no priority
|
||
| source
string
|
always |
The source, can be a folder/file or an url
Sample:
https://chocolatey.org/api/v2/
|
||
| source_username
string
|
always |
Username used to access authenticated feeds
Sample:
username
|
||
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Simon Bärlocher (@sbaerlocher)
- ITIGO AG (@itigoag)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/win_chocolatey_facts_module.html