Try SpotterInstall a service using NSSM
Authors: Adam Keech (@smadam813), George Frank (@georgefrank), Hans-Joachim Kliemeck (@h0nIg), Michael Wild (@themiwi), Kevin Subileau (@ksubileau), Shachaf Goldstein (@Shachaf92)
Install with ansible-galaxy collection install community.windows:==2.2.0
collections:
- name: community.windows
version: 2.2.0Install a Windows service using the NSSM wrapper.
NSSM is a service helper which doesn't suck. See U(https://nssm.cc/) for more information.
- name: Install the foo service
community.windows.win_nssm:
name: foo
application: C:\windows\foo.exe
# This will yield the following command: C:\windows\foo.exe bar "true"
- name: Install the Consul service with a list of parameters
community.windows.win_nssm:
name: Consul
application: C:\consul\consul.exe
arguments:
- agent
- -config-dir=C:\consul\config
# This is strictly equivalent to the previous example
- name: Install the Consul service with an arbitrary string of parameters
community.windows.win_nssm:
name: Consul
application: C:\consul\consul.exe
arguments: agent -config-dir=C:\consul\config
# Install the foo service, and then configure and start it with win_service
- name: Install the foo service, redirecting stdout and stderr to the same file
community.windows.win_nssm:
name: foo
application: C:\windows\foo.exe
stdout_file: C:\windows\foo.log
stderr_file: C:\windows\foo.log
- name: Configure and start the foo service using win_service
ansible.windows.win_service:
name: foo
dependencies: [ adf, tcpip ]
username: foouser
password: secret
start_mode: manual
state: started
- name: Install a script based service and define custom environment variables
community.windows.win_nssm:
name: <ServiceName>
application: C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe
arguments:
- <path-to-script>
- <script arg>
app_environment:
AUTH_TOKEN: <token value>
SERVER_URL: https://example.com
PATH: "<path-prepends>;{{ ansible_env.PATH }};<path-appends>"
- name: Remove the foo service
community.windows.win_nssm:
name: foo
state: absent
name:
description:
- Name of the service to operate on.
required: true
type: str
state:
choices:
- absent
- present
- started
- stopped
- restarted
default: present
description:
- State of the service on the system.
type: str
password:
description:
- Password to be used for service startup.
- This is not required for the well known service accounts and group managed service
accounts.
type: str
username:
aliases:
- user
description:
- User to be used for service startup.
- Group managed service accounts must end with C($).
- Before C(1.8.0), this parameter was just C(user).
type: str
arguments:
aliases:
- app_parameters_free_form
description:
- Parameters to be passed to the application when it starts.
- This can be either a simple string or a list.
type: str
executable:
default: nssm.exe
description:
- The location of the NSSM utility (in case it is not located in your PATH).
type: path
start_mode:
choices:
- auto
- delayed
- disabled
- manual
default: auto
description:
- If C(auto) is selected, the service will start at bootup.
- C(delayed) causes a delayed but automatic start after boot.
- 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.
type: str
application:
description:
- The application binary to run as a service
- Required when I(state) is C(present), C(started), C(stopped), or C(restarted).
type: path
description:
description:
- The description to set for the service.
type: str
stderr_file:
description:
- Path to receive error output.
type: path
stdout_file:
description:
- Path to receive output.
type: path
dependencies:
description:
- Service dependencies that has to be started to trigger startup, separated by comma.
elements: str
type: list
display_name:
description:
- The display name to set for the service.
type: str
app_environment:
description:
- Key/Value pairs which will be added to the environment of the service application.
type: dict
version_added: 1.2.0
version_added_collection: community.windows
app_rotate_bytes:
default: 104858
description:
- NSSM will not rotate any file which is smaller than the configured number of bytes.
type: int
app_rotate_online:
choices:
- 0
- 1
default: 0
description:
- If set to 1, nssm can rotate files which grow to the configured file size limit
while the service is running.
type: int
working_directory:
aliases:
- app_directory
- chdir
description:
- The working directory to run the service executable from (defaults to the directory
containing the application binary)
type: path
app_stop_method_skip:
choices:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
description:
- To disable service shutdown methods, set to the sum of one or more of the numbers
- 1 - Don't send Control-C to the console.
- 2 - Don't send WM_CLOSE to windows.
- 4 - Don't send WM_QUIT to threads.
- 8 - Don't call TerminateProcess().
type: int
app_stop_method_console:
description:
- Time to wait after sending Control-C.
type: int