mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -07:00
Windows: Clean up documentation (#36684)
This PR includes: - Further cleanup of BOTMETA.yml - Cleanup of author github handles - Use of proper booleans - One-line license statement - Copyright format statement - Smaller cleanups
This commit is contained in:
parent
4ab96722cf
commit
07e8fb5dbb
81 changed files with 751 additions and 1591 deletions
|
@ -1,22 +1,8 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2015, Heyo
|
||||
#
|
||||
# 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/>.
|
||||
# Copyright: (c) 2015, Heyo
|
||||
# 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
|
||||
|
@ -25,7 +11,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: win_nssm
|
||||
|
@ -38,70 +23,61 @@ requirements:
|
|||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the service to operate on
|
||||
- Name of the service to operate on.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- State of the service on the system
|
||||
- State of the service on the system.
|
||||
- Note that NSSM actions like "pause", "continue", "rotate" do not fit the declarative style of ansible, so these should be implemented via the
|
||||
ansible command module
|
||||
choices:
|
||||
- present
|
||||
- started
|
||||
- stopped
|
||||
- restarted
|
||||
- absent
|
||||
ansible command module.
|
||||
choices: [ absent, present, started, stopped, restarted ]
|
||||
default: started
|
||||
application:
|
||||
description:
|
||||
- The application binary to run as a service
|
||||
- "Specify this whenever the service may need to be installed (state: present, started, stopped, restarted)"
|
||||
- "Note that the application name must look like the following, if the directory includes spaces:"
|
||||
- 'nssm install service "c:\\Program Files\\app.exe\\" "C:\\Path with spaces\\"'
|
||||
- 'nssm install service "C:\\Program Files\\app.exe\\" "C:\\Path with spaces\\"'
|
||||
- >
|
||||
See commit 0b386fc1984ab74ee59b7bed14b7e8f57212c22b in the nssm.git project for more info:
|
||||
U(https://git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b)
|
||||
stdout_file:
|
||||
description:
|
||||
- Path to receive output
|
||||
- Path to receive output.
|
||||
stderr_file:
|
||||
description:
|
||||
- Path to receive error output
|
||||
- Path to receive error output.
|
||||
app_parameters:
|
||||
description:
|
||||
- Parameters to be passed to the application when it starts.
|
||||
- Use either this or C(app_parameters_free_form), not both
|
||||
- Use either this or C(app_parameters_free_form), not both.
|
||||
app_parameters_free_form:
|
||||
version_added: "2.3.0"
|
||||
description:
|
||||
- Single string of parameters to be passed to the service.
|
||||
- Use either this or C(app_parameters), not both
|
||||
- Use either this or C(app_parameters), not both.
|
||||
dependencies:
|
||||
description:
|
||||
- Service dependencies that has to be started to trigger startup, separated by comma.
|
||||
user:
|
||||
description:
|
||||
- User to be used for service startup
|
||||
- User to be used for service startup.
|
||||
password:
|
||||
description:
|
||||
- Password to be used for service startup
|
||||
- Password to be used for service startup.
|
||||
start_mode:
|
||||
description:
|
||||
- If C(auto) is selected, the service will start at bootup.
|
||||
- C(delayed) causes a delayed but automatic start after boot (added in version 2.5).
|
||||
- C(manual) means that the service will start only when another service needs it.
|
||||
- C(disabled) means that the service will stay off, regardless if it is needed or not.
|
||||
choices: [ auto, delayed, disabled, manual ]
|
||||
default: auto
|
||||
choices:
|
||||
- auto
|
||||
- delayed
|
||||
- manual
|
||||
- disabled
|
||||
author:
|
||||
- "Adam Keech (@smadam813)"
|
||||
- "George Frank (@georgefrank)"
|
||||
- "Hans-Joachim Kliemeck (@h0nIg)"
|
||||
- "Michael Wild (@themiwi)"
|
||||
- Adam Keech (@smadam813)
|
||||
- George Frank (@georgefrank)
|
||||
- Hans-Joachim Kliemeck (@h0nIg)
|
||||
- Michael Wild (@themiwi)
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
|
@ -116,7 +92,7 @@ EXAMPLES = r'''
|
|||
name: foo
|
||||
application: C:\windows\foo.exe
|
||||
app_parameters:
|
||||
bar: true
|
||||
bar: 'true'
|
||||
|
||||
# Install and start the foo service with a key-value pair argument, where the argument needs to start with a dash
|
||||
# This will yield the following command: C:\windows\\foo.exe -bar "true"
|
||||
|
@ -124,7 +100,7 @@ EXAMPLES = r'''
|
|||
name: foo
|
||||
application: C:\windows\foo.exe
|
||||
app_parameters:
|
||||
"-bar": true
|
||||
"-bar": 'true'
|
||||
|
||||
# Install and start the foo service with a single parameter
|
||||
# This will yield the following command: C:\windows\\foo.exe bar
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue