Spec-Zone.ru › Ansible 2.9

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

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

Обзор

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

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
app_parameters
строка
Строка, представляющая словарь параметров, которые должны быть переданы приложению при запуске.
УСТАРЕЛО, начиная с версии 2.8, используйте arguments вместо этого.
Исключительно с arguments.
application
путь
Бинарный файл приложения, который должен запускаться как служба.
Требуется, когда state равен present, started, stopped, или restarted.
arguments
строка
Параметры, которые нужно передать приложению при запуске.
Может быть простой строкой или списком.
Этот параметр был переименован из app_parameters_free_form в версии 2.8.
Исключительно с app_parameters.

псевдонимы: app_parameters_free_form
dependencies
список
Зависимости службы, которые должны быть запущены, чтобы инициировать запуск. Разделяются запятыми.
УСТАРЕЛО, начиная с версии 2.8, используйте модуль win_service вместо этого.
description
строка
добавлено в 2.8.0
Описание, которое нужно установить для службы.
display_name
строка
добавлено в 2.8.0
Имя для отображения службы.
executable
путь
добавлено в 2.8.0
По умолчанию:
"nssm.exe"
Расположение утилиты NSSM (если она не находится в вашей переменной среды PATH).
name
строка / обязательно
Имя службы, над которой необходимо выполнить операцию.
password
строка
Пароль, используемый для запуска службы.
УСТАРЕЛО, начиная с версии 2.8, используйте модуль win_service вместо этого.
start_mode
строка
    Варианты:
  • авто ←
  • отложенный
  • выключен
  • вручную
Если выбрано auto, служба будет запускаться при загрузке.
delayed вызывает отложенный, но автоматический запуск после загрузки (добавлено в версии 2.5).
manual означает, что служба запустится только при необходимости другой службы.
disabled означает, что служба останется выключенной независимо от необходимости.
УСТАРЕЛО, начиная с версии 2.8, используйте модуль win_service вместо этого.
state
строка
    Варианты:
  • отсутствует
  • есть ←
  • запущен
  • остановлен
  • перезапущен
Состояние службы в системе.
Значения started, stopped, и restarted устарели, начиная с версии 2.8, пожалуйста, используйте модуль win_service вместо него, чтобы запустить, остановить или перезапустить службу.
stderr_file
путь
Путь для приема вывода ошибок.
stdout_file
путь
Путь для приема вывода.
user
строка
Пользователь, который будет использоваться для запуска службы.
УСТАРЕЛО, начиная с версии 2.8, используйте модуль win_service вместо этого.
working_directory
путь
добавлено в 2.8.0
Рабочая директория для запуска исполняемого файла службы (по умолчанию — директория, содержащая бинарный файл приложения).

псевдонимы: app_directory, chdir

Примечания

Примечание

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

См. также

См. также

win_service – Управление и запросы служб Windows
Официальная документация модуля win_service.

Примеры

- name: Install the foo service
  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
  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
  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
  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
  win_service:
    name: foo
    dependencies: [ adf, tcpip ]
    user: foouser
    password: secret
    start_mode: manual
    state: started

- name: Remove the foo service
  win_nssm:
    name: foo
    state: absent

Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/win_nssm_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API