mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-03 23:50:58 +02:00
53 lines
1.2 KiB
Python
53 lines
1.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# this is a windows documentation stub. actual code lives in the .ps1
|
|
# file of the same name
|
|
|
|
# Copyright: (c) 2018, Ripon Banik (@riponbanik)
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = r'''
|
|
module: win_hostname
|
|
version_added: "2.6"
|
|
short_description: Manages local Windows computer name.
|
|
description:
|
|
- Manages local Windows computer name.
|
|
- A reboot is required for the computer name to take effect.
|
|
options:
|
|
name:
|
|
description:
|
|
- The hostname to set for the computer.
|
|
required: true
|
|
author:
|
|
- Ripon Banik (@riponbanik)
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Change the hostname to sample-hostname
|
|
win_hostname:
|
|
name: sample-hostname
|
|
register: res
|
|
|
|
- name: Reboot
|
|
win_reboot:
|
|
when: res.reboot_required
|
|
'''
|
|
|
|
RETURN = r'''
|
|
old_name:
|
|
description: The original hostname that was set before it was changed
|
|
returned: always
|
|
type: str
|
|
sample: old_hostname
|
|
reboot_required:
|
|
description: Whether a reboot is required to complete the hostname change
|
|
returned: always
|
|
type: bool
|
|
sample: true
|
|
'''
|