Модуль community.general.launchd — Управление службами macOS

Примечание

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

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

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

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

Новое в community.general 1.0.0

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

Описание

Управление службами launchd на целевых хостах macOS.

Требования

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

Система, управляемая launchd
Библиотека python plistlib

Параметры

Параметр	Комментарии
enabled boolean	Указывает, должна ли служба запускаться при загрузке. Требуется хотя бы один из параметров state и enabled. Варианты: `false` `true`
force_stop boolean	Указывает, должна ли служба не перезапускаться автоматически launchd. У служб может быть установлено свойство «KeepAlive» равным true в конфигурации launchd. В случае, если оно установлено в true, остановка службы приведет к тому, что launchd запустит службу снова. Установите этот параметр в значение `true` для того, чтобы этот модуль изменил свойство «KeepAlive» на `false`. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя службы.
state string	`started`/`stopped` — идемпотентные действия, которые не будут запускать команды, если это не нужно. Launchd не поддерживает `restarted` и `reloaded` напрямую. Они приведут к остановке/запуску (перезапуск) или разгрузке/загрузке (перезагрузка). `restarted` разгружает и загружает службу перед запуском, чтобы гарантировать, что используется последнее определение задания (plist). `reloaded` разгружает и загружает службу, чтобы гарантировать, что используется последнее определение задания (plist). Запуск или остановка службы зависит от содержимого файла определения. Варианты: `"reloaded"` `"restarted"` `"started"` `"stopped"` `"unloaded"`

Атрибуты

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

Примечания

Примечание

Пользователь должен иметь привилегии для управления службами с помощью этого модуля.

Примеры

- name: Make sure spotify webhelper is started
  community.general.launchd:
    name: com.spotify.webhelper
    state: started

- name: Deploy custom memcached job definition
  template:
    src: org.memcached.plist.j2
    dest: /Library/LaunchDaemons/org.memcached.plist

- name: Run memcached
  community.general.launchd:
    name: org.memcached
    state: started

- name: Stop memcached
  community.general.launchd:
    name: org.memcached
    state: stopped

- name: Stop memcached
  community.general.launchd:
    name: org.memcached
    state: stopped
    force_stop: true

- name: Restart memcached
  community.general.launchd:
    name: org.memcached
    state: restarted

- name: Unload memcached
  community.general.launchd:
    name: org.memcached
    state: unloaded

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

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

Ключ	Описание
status словарь	Метаданные о состоянии службы Возвращается: всегда Пример: `{"current_pid": "-", "current_state": "stopped", "previous_pid": "82636", "previous_state": "running"}`

Авторы

Martin Migasiewicz (@martinm82)

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

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