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

Примечание

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

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

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

Для использования в playbook укажите: community.general.nosh.

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

Обзор

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

Требования

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

Система с активным менеджером служб nosh, см. Примечания для получения дополнительной информации.

Параметры

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

Атрибуты

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

Примечания

Примечание

Дополнительную информацию о пакете утилит 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	включен ли сервис при загрузке системы Возвращаемое значение: success Пример: `true`
name string	имя, используемое для поиска сервиса Возвращаемое значение: success Пример: `"sshd"`
preset boolean	указывает, отражает ли состояние включения значение, установленное в соответствующем файле `.preset` Возвращаемое значение:* success Пример: `false`
service_path string	рассчитанный путь к сервису Возвращаемое значение: success Пример: `"/var/sv/sshd"`
state string	состояние выполнения процесса сервиса, `none`, если сервис не загружен и не будет запущен Возвращаемое значение: если используется опция state Пример: `"reloaded"`
status complex	Словарь со значениями пар ключ=значение, возвращаемых `system-control show-json`, или `none`, если сервис не загружен Возвращаемое значение: success
After list / elements=string	Возвращаемое значение: success Пример: `["/etc/service-bundles/targets/basic", "../sshdgenkeys", "log"]`
Before list / elements=string	Возвращаемое значение: success Пример: `["/etc/service-bundles/targets/shutdown"]`
Conflicts list / elements=string	Возвращаемое значение: success Пример: `[]`
DaemontoolsEncoreState string	Возвращаемое значение: success Пример: `"running"`
DaemontoolsState string	Возвращаемое значение: success Пример: `"up"`
Enabled boolean	Возвращаемое значение: success Пример: `true`
LogService string	Возвращаемое значение: success Пример: `"../cyclog@sshd"`
MainPID integer	Возвращаемое значение: success Пример: `661`
Paused boolean	Возвращаемое значение: success Пример: `false`
ReadyAfterRun boolean	Возвращаемое значение: success Пример: `false`
RemainAfterExit boolean	Возвращаемое значение: success Пример: `false`
Required-By list / elements=string	Возвращаемое значение: success Пример: `[]`

RestartExitStatusCode integer	Возвращено: success Пример: `0`
RestartExitStatusNumber integer	Возвращено: success Пример: `0`
RestartTimestamp integer	Возвращено: success Пример: `4611686019935648081`
RestartUTCTimestamp integer	Возвращено: success Пример: `1508260140`
RunExitStatusCode integer	Возвращено: success Пример: `0`
RunExitStatusNumber integer	Возвращено: success Пример: `0`
RunTimestamp integer	Возвращено: success Пример: `4611686019935648081`
RunUTCTimestamp integer	Возвращено: success Пример: `1508260140`
StartExitStatusCode integer	Возвращено: success Пример: `1`
StartExitStatusNumber integer	Возвращено: success Пример: `0`
StartTimestamp integer	Возвращено: success Пример: `4611686019935648081`
StartUTCTimestamp integer	Возвращено: success Пример: `1508260140`
StopExitStatusCode integer	Возвращено: success Пример: `0`
StopExitStatusNumber integer	Возвращено: success Пример: `0`
Stopped-By list / elements=string	Возвращено: success Пример: `["/etc/service-bundles/targets/shutdown"]`
StopTimestamp integer	Возвращено: success Пример: `4611686019935648081`
StopUTCTimestamp integer	Возвращено: success Пример: `1508260140`
Timestamp integer	Возвращено: success Пример: `4611686019935648081`
UTCTimestamp integer	Возвращено: success Пример: `1508260140`

Нужно строка	Возвращено: успех Пример: `"nothing"`
Нужно для список / элементы=строка	Возвращено: успех Пример: `["/etc/service-bundles/targets/server", "/etc/service-bundles/targets/sockets"]`
Требуется список / элементы=строка	Возвращено: успех Пример: `["/etc/service-bundles/targets/basic", "../sshdgenkeys"]`
пользователь логический	вызывается ли менеджер служб уровня пользователя Возвращено: успех Пример: `false`

Авторы

Thomas Caravia (@tacatac)

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

© 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/general/nosh_module.html