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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 логический	Должна ли служба запускаться при загрузке системы. Необходимо указать как минимум один из параметров state и enabled. Варианты: `false` `true`
force_stop логический	Должна ли служба быть защищена от автоматического перезапуска launchd. В конфигурации launchd для служб может быть задан атрибут `KeepAlive` со значением `true`. Если задано это значение `true`, при остановке службы `launchd` запускает её снова. Задайте для этого параметра значение `true`, чтобы этот модуль изменил атрибут `KeepAlive` на `false`. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательный	Имя службы.
plist строка добавлено в community.general 10.1.0	Имя файла `.plist` службы. По умолчанию используется `{name}.plist`.
state строка	`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

- name: restart sshd
  community.general.launchd:
    name: com.openssh.sshd
    plist: ssh.plist
    state: restarted

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

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

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

Авторы

Martin Migasiewicz (@martinm82)

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

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