Spec-Zone.ru › Ansible 2.6

win_nssm - NSSM - the Non-Sucking Service Manager

New in version 2.0.

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

Обзор

  • nssm — это вспомогательный модуль для управления службами, который не «заедает». Дополнительная информация доступна на https://nssm.cc/.

Требования

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

  • nssm >= 2.24.0 # (установка с помощью win_chocolatey) win_chocolatey: name=nssm

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
app_parameters
Строка, представляющая словарь параметров, которые будут переданы приложению при запуске.
Используйте либо этот параметр, либо app_parameters_free_form, но не оба одновременно.
app_parameters_free_form
(добавлено в 2.3.0)
Одна строка параметров, которые будут переданы службе.
Используйте либо этот параметр, либо app_parameters, но не оба одновременно.
application
Исполняемый файл приложения, который будет работать как служба.
Укажите, когда служба должна быть установлена (состояние: присутствует, запущена, остановлена, перезапущена).
Обратите внимание, что имя приложения должно выглядеть следующим образом, если в каталоге есть пробелы:
nssm install service "C:\\Program Files\\app.exe\\" "C:\\Path with spaces\\"
Дополнительная информация доступна в коммите 0b386fc1984ab74ee59b7bed14b7e8f57212c22b проекта nssm.git: https://git.nssm.cc/?p=nssm.git;a=commit;h=0b386fc1984ab74ee59b7bed14b7e8f57212c22b
dependencies
Зависимости службы, которые должны быть запущены для запуска, разделенные запятыми.
name
обязательно
Имя службы, с которой необходимо взаимодействовать.
password
Пароль, используемый для запуска службы.
start_mode
    Варианты:
  • автоматически ←
  • отложенный
  • отключен
  • вручную
Если выбран auto, служба будет запускаться при загрузке.
delayed вызывает отложенный, но автоматический запуск после загрузки (добавлено в версии 2.5).
manual означает, что служба будет запускаться только тогда, когда ей понадобится другая служба.
disabled означает, что служба будет выключена, независимо от того, нужна она или нет.
state
    Варианты:
  • отсутствует
  • присутствует
  • запущена ←
  • остановлена
  • перезапущена
Состояние службы в системе.
Обратите внимание, что действия NSSM, такие как «пауза», «продолжение», «поворот», не подходят для декларативного стиля Ansible, поэтому их следует реализовать с помощью модуля команды Ansible.
stderr_file
Путь для получения вывода ошибок.
stdout_file
Путь для получения вывода.
user
Пользователь, используемый для запуска службы.

Примеры

# Install and start the foo service
- win_nssm:
    name: foo
    application: C:\windows\foo.exe

# Install and start the foo service with a key-value pair argument
# This will yield the following command: C:\windows\foo.exe -bar true
- win_nssm:
    name: foo
    application: C:\windows\foo.exe
    app_parameters: -bar=true

# Install and start the foo service with a single parameter
# This will yield the following command: C:\windows\\foo.exe bar
- win_nssm:
    name: foo
    application: C:\windows\foo.exe
    app_parameters: _=bar

# Install and start the foo service with a mix of single params, and key value pairs
# This will yield the following command: C:\windows\\foo.exe bar -file output.bat -foo false
- win_nssm:
    name: foo
    application: C:\windows\foo.exe
    app_parameters: _=bar; -file=output.bat; -foo=false

# Use the single line parameters option to specify an arbitrary string of parameters
# for the service executable
- name: Make sure the Consul service runs
  win_nssm:
    name: consul
    application: C:\consul\consul.exe
    app_parameters_free_form: agent -config-dir=C:\consul\config
    stdout_file: C:\consul\log.txt
    stderr_file: C:\consul\error.txt

# Install and start 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

# Install and start the foo service, but wait for dependencies tcpip and adf
- win_nssm:
    name: foo
    application: C:\windows\foo.exe
    dependencies: 'adf,tcpip'

# Install and start the foo service with dedicated user
- win_nssm:
    name: foo
    application: C:\windows\foo.exe
    user: foouser
    password: secret

# Install the foo service but do not start it automatically
- win_nssm:
    name: foo
    application: C:\windows\foo.exe
    state: present
    start_mode: manual

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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительная информация доступна на странице Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, находится здесь.

Автор

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

Подсказка

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

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

Spec-Zone.ru

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