mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
5b9eb92722
* Windows: Fix documentation strings to be raw strings Especially when using Windows paths they easily get confused as escaped sequences or unicode characters. So by default use raw strings This fixes #20295 * Fixed as hinted by @abadger And some trailing whitespace fixes.
76 lines
2 KiB
Python
76 lines
2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2014, Chris Hoffman <choffman@chathamfinancial.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# this is a windows documentation stub. actual code lives in the .ps1
|
|
# file of the same name
|
|
|
|
ANSIBLE_METADATA = {'status': ['stableinterface'],
|
|
'supported_by': 'core',
|
|
'version': '1.0'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_service
|
|
version_added: "1.7"
|
|
short_description: Manages Windows services
|
|
description:
|
|
- Manages Windows services
|
|
options:
|
|
name:
|
|
description:
|
|
- Name of the service
|
|
required: true
|
|
default: null
|
|
aliases: []
|
|
start_mode:
|
|
description:
|
|
- Set the startup type for the service
|
|
required: false
|
|
choices:
|
|
- auto
|
|
- manual
|
|
- disabled
|
|
state:
|
|
description:
|
|
- C(started)/C(stopped) are idempotent actions that will not run
|
|
commands unless necessary. C(restarted) will always bounce the
|
|
service.
|
|
required: false
|
|
choices:
|
|
- started
|
|
- stopped
|
|
- restarted
|
|
default: null
|
|
aliases: []
|
|
author: "Chris Hoffman (@chrishoffman)"
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Restart a service
|
|
win_service:
|
|
name: spooler
|
|
state: restarted
|
|
|
|
- name: Set service startup mode to auto and ensure it is started
|
|
win_service:
|
|
name: spooler
|
|
start_mode: auto
|
|
state: started
|
|
'''
|