Модуль community.windows.win_nssm – Установка службы с помощью NSSM

Примечание

Этот модуль является частью коллекции community.windows (версия 2.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.windows. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в книге задач укажите: community.windows.win_nssm.

Описание
Требования
Параметры
Примечания
См. также
Примеры

Описание

Установка службы Windows с помощью оболочки NSSM.
NSSM – вспомогательная программа для служб, которая работает хорошо. Дополнительную информацию см. на https://nssm.cc/.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

nssm >= 2.24.0 # (установка через chocolatey.chocolatey.win_chocolatey) win_chocolatey: name=nssm

Параметры

Параметр	Комментарии
app_environment dictionary добавлено в community.windows 1.2.0	Пары ключ/значение, которые будут добавлены в среду приложения службы.
app_rotate_bytes integer	NSSM не будет вращать файлы, размер которых меньше заданного числа байтов. По умолчанию: `104858`
app_rotate_online integer	Если установлено значение 1, nssm может вращать файлы, которые достигают заданного предела размера файла, пока служба работает. Варианты: `0` ← (по умолчанию) `1`
app_stop_method_console integer	Время ожидания после отправки Control-C.
app_stop_method_skip integer	Чтобы отключить методы выключения службы, установите сумму одного или нескольких чисел 1 - Не отправлять Control-C в консоль. 2 - Не отправлять WM_CLOSE в окна. 4 - Не отправлять WM_QUIT в потоки. 8 - Не вызывать TerminateProcess(). Варианты: `1` `2` `3` `4` `5` `6` `7` `8` `9` `10` `11` `12` `13` `14` `15`
application path	Исполняемый файл приложения для запуска в качестве службы Обязательно, когда state имеет значение `present`, `started`, `stopped`, или `restarted`.
arguments псевдонимы: app_parameters_free_form string	Параметры, которые будут переданы приложению при его запуске. Это может быть простая строка или список.
dependencies list / elements=string	Зависимости службы, которые должны быть запущены для запуска, разделенные запятой.
description string	Описание для установки для службы.
display_name string	Отображаемое имя для установки для службы.
executable path	Расположение утилиты NSSM (если она не находится в вашем PATH). По умолчанию: `"nssm.exe"`
name string / required	Имя службы, с которой нужно работать.
password string	Пароль для запуска службы. Это не требуется для известных учетных записей службы и учетных записей службы, управляемых группами.
start_mode string	Если выбран `auto`, служба будет запускаться при загрузке. `delayed` вызывает отложенный, но автоматический запуск после загрузки. `manual` означает, что служба будет запускаться только тогда, когда другая служба будет в ней нуждаться. `disabled` означает, что служба будет оставаться выключенной, независимо от того, нужна она или нет. Варианты: `"auto"` ← (по умолчанию) `"delayed"` `"disabled"` `"manual"`
state string	Состояние службы в системе. Варианты: `"absent"` `"present"` ← (по умолчанию) `"started"` `"stopped"` `"restarted"`
stderr_file path	Путь для получения выходных данных об ошибках.
stdout_file path	Путь для получения выходных данных.
username псевдонимы: user string	Пользователь, который будет использоваться для запуска службы. Учетные записи службы, управляемые группами, должны заканчиваться на `$`. До `1.8.0`, этот параметр был просто `user`.
working_directory псевдонимы: app_directory, chdir path	Рабочий каталог для запуска исполняемого файла службы (по умолчанию - каталог, содержащий исполняемый файл приложения)

Примечания

Примечание

Сервис НЕ будет запущен после его создания, когда state=present.
После создания сервиса вы можете использовать модуль ansible.windows.win_service, чтобы запустить его или настроить дополнительные свойства, такие как тип запуска, зависимости, учетная запись службы и так далее.

См. также

ansible.windows.win_service: Управление и запрос служб Windows.

Примеры

- 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

Авторы

Adam Keech (@smadam813)
George Frank (@georgefrank)
Hans-Joachim Kliemeck (@h0nIg)
Michael Wild (@themiwi)
Kevin Subileau (@ksubileau)
Shachaf Goldstein (@Shachaf92)

Ссылки на сборки

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