summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/windows/win_computer_description.py
blob: b8aa2761857a98fff50e3dc1cf6d2a3a32209f93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright: (c) 2019, RusoSova
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

# this is a windows documentation stub.  actual code lives in the .ps1
# file of the same name

from __future__ import absolute_import, division, print_function
__metaclass__ = type

ANSIBLE_METADATA = {
    'metadata_version': '1.1',
    'status': ['preview'],
    'supported_by': 'community'
}

DOCUMENTATION = r'''
---
module: win_computer_description
short_description: Set windows description, owner and organization
description:
 - This module sets Windows description that is shown under My Computer properties. Module also sets
   Windows license owner and organization. License information can be viewed by running winver commad.
options:
 description:
   description:
     - String value to apply to Windows descripton. Specify value of "" to clear the value.
   required: false
   type: str
 organization:
   description:
     - String value of organization that the Windows is licensed to. Specify value of "" to clear the value.
   required: false
   type: str
 owner:
   description:
     - String value of the persona that the Windows is licensed to. Specify value of "" to clear the value.
   required: false
   type: str
version_added: '2.10'
author:
 - RusoSova (@RusoSova)
'''

EXAMPLES = r'''
- name: Set Windows description, owner and organization
  win_computer_description:
   description: Best Box
   owner: RusoSova
   organization: MyOrg
  register: result

- name: Set Windows description only
  win_computer_description:
   description: This is my Windows machine
  register: result

- name: Set organization and clear owner field
  win_computer_description:
   owner: ''
   organization: Black Mesa

- name: Clear organization, description and owner
  win_computer_description:
   organization: ""
   owner: ""
   description: ""
  register: result
'''

RETURN = r'''
#
'''