Модуль community.general.nosh — управление службами с помощью nosh

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.nosh.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управление состоянием запущенных служб и служб, включённых при загрузке, для всей системы или пользователя.
Поддерживаются системы BSD и Linux.

Требования

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

Система с активным диспетчером служб nosh; дополнительную информацию см. в разделе «Примечания».

Параметры

Параметр	Комментарии
enabled логическое значение	Включить или отключить службу независимо от предпочтений файла `.preset` или её текущего состояния. Взаимоисключающий параметр с `preset`. Действует до применения `state=reset`. Допустимые значения:* `false` `true`
name строка / обязательный	Имя службы, которой нужно управлять.
preset логическое значение	Включить или отключить службу в соответствии с локальными предпочтениями в файлах `.preset`. Взаимоисключающий параметр с `enabled`. Действует только при значении true. Применяется до `state=reset`. Допустимые значения:* `false` `true`
state строка	`started`/`stopped` — идемпотентные действия, которые не выполняют команды без необходимости. `restarted` всегда перезапускает службу. `reloaded` отправляет SIGHUP или запускает службу. `reset` запускает или останавливает службу в зависимости от того, включена ли она. Допустимые значения: `"started"` `"stopped"` `"reset"` `"restarted"` `"reloaded"`
user логическое значение	Запустить system-control, взаимодействуя с диспетчером служб вызывающего пользователя, а не с общесистемным диспетчером служб. Допустимые значения: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой узел.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примечания

Примечание

Информацию о наборе утилит nosh можно найти по адресу https://jdebp.eu/Softwares/nosh/.

Примеры

- name: Start dnscache if not running
  community.general.nosh:
    name: dnscache
    state: started

- name: Stop mpd, if running
  community.general.nosh:
    name: mpd
    state: stopped

- name: Restart unbound or start it if not already running
  community.general.nosh:
    name: unbound
    state: restarted

- name: Reload fail2ban or start it if not already running
  community.general.nosh:
    name: fail2ban
    state: reloaded

- name: Disable nsd
  community.general.nosh:
    name: nsd
    enabled: false

- name: For package installers, set nginx running state according to local enable settings, preset and reset
  community.general.nosh:
    name: nginx
    preset: true
    state: reset

- name: Reboot the host if nosh is the system manager, would need a "wait_for*" task at least, not recommended as-is
  community.general.nosh:
    name: reboot
    state: started

- name: Using conditionals with the module facts
  tasks:
    - name: Obtain information on tinydns service
      community.general.nosh:
        name: tinydns
      register: result

    - name: Fail if service not loaded
      ansible.builtin.fail:
        msg: "The {{ result.name }} service is not loaded"
      when: not result.status

    - name: Fail if service is running
      ansible.builtin.fail:
        msg: "The {{ result.name }} service is running"
      when: result.status and result.status['DaemontoolsEncoreState'] == "running"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
enabled boolean	Включена ли служба при загрузке системы. Возвращается: при успешном выполнении Пример: `true`
name string	Имя, используемое для поиска службы. Возвращается: при успешном выполнении Пример: `"sshd"`
preset boolean	Соответствует ли состояние включения значению, заданному в соответствующем файле `.preset`. Возвращается:* при успешном выполнении Пример: `false`
service_path string	Определённый путь к службе. Возвращается: при успешном выполнении Пример: `"/var/sv/sshd"`
state string	Состояние процесса службы; `none`, если служба не загружена и не будет запущена. Возвращается: если используется параметр state Пример: `"reloaded"`
status dictionary	Словарь с парами ключ=значение, возвращёнными командой `system-control show-json`, или `none`, если служба не загружена. Возвращается: при успешном выполнении
After list / elements=string	Возвращается: при успешном выполнении Пример: `["/etc/service-bundles/targets/basic", "../sshdgenkeys", "log"]`
Before list / elements=string	Возвращается: при успешном выполнении Пример: `["/etc/service-bundles/targets/shutdown"]`
Conflicts list / elements=string	Возвращается: при успешном выполнении Пример: `[]`
DaemontoolsEncoreState string	Возвращается: при успешном выполнении Пример: `"running"`
DaemontoolsState string	Возвращается: при успешном выполнении Пример: `"up"`
Enabled boolean	Возвращается: при успешном выполнении Пример: `true`
LogService string	Возвращается: при успешном выполнении Пример: `"../cyclog@sshd"`
MainPID integer	Возвращается: при успешном выполнении Пример: `661`
Paused boolean	Возвращается: при успешном выполнении Пример: `false`
ReadyAfterRun boolean	Возвращается: при успешном выполнении Пример: `false`
RemainAfterExit boolean	Возвращается: при успешном выполнении Пример: `false`
Required-By list / elements=string	Возвращается: при успешном выполнении Пример: `[]`
RestartExitStatusCode integer	Возвращается: при успешном выполнении Пример: `0`
RestartExitStatusNumber integer	Возвращается: при успешном выполнении Пример: `0`
RestartTimestamp integer	Возвращается: при успешном выполнении Пример: `4611686019935648081`
RestartUTCTimestamp integer	Возвращается: при успешном выполнении Пример: `1508260140`
RunExitStatusCode integer	Возвращается: при успешном выполнении Пример: `0`
RunExitStatusNumber integer	Возвращается: при успешном выполнении Пример: `0`
RunTimestamp integer	Возвращается: при успешном выполнении Пример: `4611686019935648081`
RunUTCTimestamp integer	Возвращается: при успешном выполнении Пример: `1508260140`
StartExitStatusCode integer	Возвращается: при успешном выполнении Пример: `1`
StartExitStatusNumber integer	Возвращается: при успешном выполнении Пример: `0`
StartTimestamp integer	Возвращается: при успешном выполнении Пример: `4611686019935648081`
StartUTCTimestamp integer	Возвращается: при успешном выполнении Пример: `1508260140`
StopExitStatusCode integer	Возвращается: при успешном выполнении Пример: `0`
StopExitStatusNumber integer	Возвращается: при успешном выполнении Пример: `0`
Stopped-By list / elements=string	Возвращается: при успешном выполнении Пример: `["/etc/service-bundles/targets/shutdown"]`
StopTimestamp integer	Возвращается: при успешном выполнении Пример: `4611686019935648081`
StopUTCTimestamp integer	Возвращается: при успешном выполнении Пример: `1508260140`
Timestamp integer	Возвращается: при успешном выполнении Пример: `4611686019935648081`
UTCTimestamp integer	Возвращается: при успешном выполнении Пример: `1508260140`
Want string	Возвращается: при успешном выполнении Пример: `"nothing"`
Wanted-By list / elements=string	Возвращается: при успешном выполнении Пример: `["/etc/service-bundles/targets/server", "/etc/service-bundles/targets/sockets"]`
Wants list / elements=string	Возвращается: при успешном выполнении Пример: `["/etc/service-bundles/targets/basic", "../sshdgenkeys"]`
user boolean	Вызывается ли менеджер служб пользовательского уровня. Возвращается: при успешном выполнении Пример: `false`

Авторы

Thomas Caravia (@tacatac)

Ссылки на коллекцию

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