W3cubDocs

/Ansible

community.windows.win_computer_description – Set windows description, owner and organization

Note

This plugin is part of the community.windows collection (version 1.7.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 community.windows.

To use it in a playbook, specify: community.windows.win_computer_description.

Synopsis

  • 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.

Parameters

Parameter Choices/Defaults Comments
description
string
String value to apply to Windows descripton. Specify value of "" to clear the value.
organization
string
String value of organization that the Windows is licensed to. Specify value of "" to clear the value.
owner
string
String value of the persona that the Windows is licensed to. Specify value of "" to clear the value.

Examples

- name: Set Windows description, owner and organization
  community.windows.win_computer_description:
   description: Best Box
   owner: RusoSova
   organization: MyOrg
  register: result

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

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

- name: Clear organization, description and owner
  community.windows.win_computer_description:
   organization: ""
   owner: ""
   description: ""
  register: result

Authors

  • RusoSova (@RusoSova)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_computer_description_module.html