1#!/usr/local/bin/python3.8
2# -*- coding: utf-8 -*-
3
4# Copyright: (c) 2018, Ansible Project
5# Copyright: (c) 2020, Chocolatey Software
6# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
7
8ANSIBLE_METADATA = {'metadata_version': '1.1',
9                    'status': ['preview'],
10                    'supported_by': 'community'}
11
12DOCUMENTATION = r'''
13---
14module: win_chocolatey_feature
15version_added: '0.2.7'
16short_description: Manages Chocolatey features
17description:
18- Used to enable or disable features in Chocolatey.
19options:
20  name:
21    description:
22    - The name of the feature to manage.
23    - Run C(choco.exe feature list) to get a list of features that can be
24      managed.
25    - For a list of options see L(Chocolatey feature docs,https://chocolatey.org/docs/chocolatey-configuration#features)
26    type: str
27    required: yes
28  state:
29    description:
30    - When C(disabled) then the feature will be disabled.
31    - When C(enabled) then the feature will be enabled.
32    type: str
33    choices: [ disabled, enabled ]
34    default: enabled
35seealso:
36- module: win_chocolatey
37- module: win_chocolatey_config
38- module: win_chocolatey_facts
39- module: win_chocolatey_source
40author:
41- Jordan Borean (@jborean93)
42'''
43
44EXAMPLES = r'''
45- name: Disable file checksum matching
46  win_chocolatey_feature:
47    name: checksumFiles
48    state: disabled
49
50- name: Stop Chocolatey on the first package failure
51  win_chocolatey_feature:
52    name: stopOnFirstPackageFailure
53    state: enabled
54'''
55
56RETURN = r'''
57'''
58