ansible.builtin.systemd – Управление службами

Примечание

Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев, вы можете использовать короткое имя модуля systemd даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для удобной ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.

Новое в версии 2.2: от ansible.builtin

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

Описание

Управляет службами systemd на удалённых хостах.

Требования

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

Система, управляемая systemd.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
daemon_reexec логический добавлен в 2.8 ansible.builtin	Варианты: нет ← да	Выполняет команду daemon_reexec перед выполнением любых других операций, менеджер systemd сериализует состояние менеджера. алиасы: daemon-reexec
daemon_reload логический	Варианты: нет ← да	Выполняет daemon-reload перед выполнением любых других операций, чтобы убедиться, что systemd прочитал все изменения. При значении `yes`, выполняет daemon-reload даже если модуль не запускает или останавливает ничего. алиасы: daemon-reload
enabled логический	Варианты: нет да	Указывает, должна ли служба запускаться при загрузке. Требуется хотя бы одно из значений state или enabled.
force логический добавлен в 2.6 ansible.builtin	Варианты: нет да	Указывает, нужно ли переопределять существующие символические ссылки.
masked логический	Варианты: нет да	Указывает, должна ли единица быть замаскированной или нет, замаскированная единица не может быть запущена.
name строка		Имя службы. Этот параметр принимает имя ровно одной службы для работы с ней. При использовании в среде chroot всегда необходимо указывать полное имя, например (crond.service). алиасы: service, unit
no_block логический добавлен в 2.3 ansible.builtin	Варианты: нет ← да	Не ждать синхронно завершения запрошенной операции. Запущенная задача продолжится без ожидания Ansible её завершения.
scope строка добавлен в 2.7 ansible.builtin	Варианты: system ← пользователь глобальный	Запустить systemctl в заданном объёме управления службой, либо в стандартном объёме системы `system`, в объёме текущего пользователя `user`, или в объёме всех пользователей `global`. Для работы systemd с 'пользователем', выполняющий пользователь должен иметь свой экземпляр dbus, запущенный и доступный (требование systemd). Процесс dbus пользователя обычно запускается во время обычного входа в систему, но не во время выполнения задач Ansible. В противном случае вы, вероятно, получите ошибку 'Failed to connect to bus: no such file or directory'. Пользователь должен иметь доступ, обычно предоставляемый через установку переменной ``XDG_RUNTIME_DIR``, см. пример ниже.
state строка	Варианты: перезагрузить перезапустить запустить остановить	`started`/`stopped` - идемпотентные действия, которые не будут запускать команды, если это не нужно. `restarted` всегда перезапустит службу. `reloaded` всегда перезагрузит.

Примечания

Примечание

С версии 2.4, требуется один из следующих вариантов: ‘state’, ‘enabled’, ‘masked’, ‘daemon_reload’, (‘daemon_reexec’ с версии 2.8), и все, кроме ‘daemon_reload’ (и ‘daemon_reexec’ с версии 2.8), также требуют ‘name’.
До версии 2.4 всегда требовалось ‘name’.
Шаблоны не поддерживаются в имени, т.е postgres*.service.
Поддерживает check_mode.

Примеры

- name: Make sure a service is running
  ansible.builtin.systemd:
    state: started
    name: httpd

- name: Stop service cron on debian, if running
  ansible.builtin.systemd:
    name: cron
    state: stopped

- name: Restart service cron on centos, in all cases, also issue daemon-reload to pick up config changes
  ansible.builtin.systemd:
    state: restarted
    daemon_reload: yes
    name: crond

- name: Reload service httpd, in all cases
  ansible.builtin.systemd:
    name: httpd
    state: reloaded

- name: Enable service httpd and ensure it is not masked
  ansible.builtin.systemd:
    name: httpd
    enabled: yes
    masked: no

- name: Enable a timer for dnf-automatic
  ansible.builtin.systemd:
    name: dnf-automatic.timer
    state: started
    enabled: yes

- name: Just force systemd to reread configs (2.4 and above)
  ansible.builtin.systemd:
    daemon_reload: yes

- name: Just force systemd to re-execute itself (2.8 and above)
  ansible.builtin.systemd:
    daemon_reexec: yes

- name: Run a user service when XDG_RUNTIME_DIR is not set on remote login
  ansible.builtin.systemd:
    name: myservice
    state: started
    scope: user
  environment:
    XDG_RUNTIME_DIR: "/run/user/{{ myuid }}"

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

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

Ключ	Возвращаемое значение	Описание
status сложный	успех	Словарь с парами ключ-значение, возвращёнными из `systemctl show`. Пример: {'ActiveEnterTimestamp': 'Вс 2016-05-15 18:28:49 EDT', 'ActiveEnterTimestampMonotonic': '8135942', 'ActiveExitTimestampMonotonic': '0', 'ActiveState': 'активно', 'After': 'auditd.service systemd-user-sessions.service time-sync.target systemd-journald.socket basic.target system.slice', 'AllowIsolate': 'нет', 'Before': 'shutdown.target multi-user.target', 'BlockIOAccounting': 'нет', 'BlockIOWeight': '1000', 'CPUAccounting': 'нет', 'CPUSchedulingPolicy': '0', 'CPUSchedulingPriority': '0', 'CPUSchedulingResetOnFork': 'нет', 'CPUShares': '1024', 'CanIsolate': 'нет', 'CanReload': 'да', 'CanStart': 'да', 'CanStop': 'да', 'CapabilityBoundingSet': '18446744073709551615', 'ConditionResult': 'да', 'ConditionTimestamp': 'Вс 2016-05-15 18:28:49 EDT', 'ConditionTimestampMonotonic': '7902742', 'Conflicts': 'shutdown.target', 'ControlGroup': '/system.slice/crond.service', 'ControlPID': '0', 'DefaultDependencies': 'да', 'Delegate': 'нет', 'Description': 'Планировщик команд', 'DevicePolicy': 'авто', 'EnvironmentFile': '/etc/sysconfig/crond (ignore_errors=no)', 'ExecMainCode': '0', 'ExecMainExitTimestampMonotonic': '0', 'ExecMainPID': '595', 'ExecMainStartTimestamp': 'Вс 2016-05-15 18:28:49 EDT', 'ExecMainStartTimestampMonotonic': '8134990', 'ExecMainStatus': '0', 'ExecReload': '{ path=/bin/kill ; argv[]=/bin/kill -HUP $MAINPID ; ignore_errors=no ; start_time=[n/a] ; stop_time=[n/a] ; pid=0 ; code=(null) ; status=0/0 }', 'ExecStart': '{ path=/usr/sbin/crond ; argv[]=/usr/sbin/crond -n $CRONDARGS ; ignore_errors=no ; start_time=[n/a] ; stop_time=[n/a] ; pid=0 ; code=(null) ; status=0/0 }', 'FragmentPath': '/usr/lib/systemd/system/crond.service', 'GuessMainPID': 'да', 'IOScheduling': '0', 'Id': 'crond.service', 'IgnoreOnIsolate': 'нет', 'IgnoreOnSnapshot': 'нет', 'IgnoreSIGPIPE': 'да', 'InactiveEnterTimestampMonotonic': '0', 'InactiveExitTimestamp': 'Вс 2016-05-15 18:28:49 EDT', 'InactiveExitTimestampMonotonic': '8135942', 'JobTimeoutUSec': '0', 'KillMode': 'процесс', 'KillSignal': '15', 'LimitAS': '18446744073709551615', 'LimitCORE': '18446744073709551615', 'LimitCPU': '18446744073709551615', 'LimitDATA': '18446744073709551615', 'LimitFSIZE': '18446744073709551615', 'LimitLOCKS': '18446744073709551615', 'LimitMEMLOCK': '65536', 'LimitMSGQUEUE': '819200', 'LimitNICE': '0', 'LimitNOFILE': '4096', 'LimitNPROC': '3902', 'LimitRSS': '18446744073709551615', 'LimitRTPRIO': '0', 'LimitRTTIME': '18446744073709551615', 'LimitSIGPENDING': '3902', 'LimitSTACK': '18446744073709551615', 'LoadState': 'загружен', 'MainPID': '595', 'MemoryAccounting': 'нет', 'MemoryLimit': '18446744073709551615', 'MountFlags': '0', 'Names': 'crond.service', 'NeedDaemonReload': 'нет', 'Nice': '0', 'NoNewPrivileges': 'нет', 'NonBlocking': 'нет', 'NotifyAccess': 'нет', 'OOMScoreAdjust': '0', 'OnFailureIsolate': 'нет', 'PermissionsStartOnly': 'нет', 'PrivateNetwork': 'нет', 'PrivateTmp': 'нет', 'RefuseManualStart': 'нет', 'RefuseManualStop': 'нет', 'RemainAfterExit': 'нет', 'Requires': 'basic.target', 'Restart': 'нет', 'RestartUSec': '100мс', 'Result': 'успех', 'RootDirectoryStartOnly': 'нет', 'SameProcessGroup': 'нет', 'SecureBits': '0', 'SendSIGHUP': 'нет', 'SendSIGKILL': 'да', 'Slice': 'system.slice', 'StandardError': 'унаследован', 'StandardInput': 'null', 'StandardOutput': 'журнал', 'StartLimitAction': 'нет', 'StartLimitBurst': '5', 'StartLimitInterval': '10000000', 'StatusErrno': '0', 'StopWhenUnneeded': 'нет', 'SubState': 'запущен', 'SyslogLevelPrefix': 'да', 'SyslogPriority': '30', 'TTYReset': 'нет', 'TTYVHangup': 'нет', 'TTYVTDisallocate': 'нет', 'TimeoutStartUSec': '1мин 30с', 'TimeoutStopUSec': '1мин 30с', 'TimerSlackNSec': '50000', 'Transient': 'нет', 'Type': 'простой', 'UMask': '0022', 'UnitFileState': 'включен', 'WantedBy': 'multi-user.target', 'Wants': 'system.slice', 'WatchdogTimestampMonotonic': '0', 'WatchdogUSec': '0'}

Авторы

Команда разработчиков Ansible

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/systemd_module.html