community.general.oneandone_monitoring_policy модуль – Настройка политики мониторинга 1&1

Примечание

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

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

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

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

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

Обзор

Создание, удаление, обновление политик мониторинга (и добавление/удаление портов, процессов и серверов). Этот модуль зависит от 1and1 >= 1.0.

Требования

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

1and1

Параметры

Параметр	Комментарии
add_ports список / элементы=словарь	Порты для добавления в политику мониторинга. По умолчанию: `[]`
add_processes список / элементы=словарь	Процессы для добавления в политику мониторинга. По умолчанию: `[]`
add_servers список / элементы=строка	Серверы для добавления в политику мониторинга. По умолчанию: `[]`
agent строка	Установите значение true для использования агента.
api_url строка	Пользовательский URL API. Переопределяет переменную окружения ONEANDONE_API_URL.
auth_token строка	Токен аутентификации API, предоставленный 1&1.
description строка	Описание политики мониторинга. maxLength=256
email строка	Электронная почта пользователя. maxLength=128
monitoring_policy строка	Идентификатор (id или имя) политики мониторинга, используемой для обновления состояния.
name строка	Имя политики мониторинга, используемой для состояния «present». Используется в качестве идентификатора (id или имя) при использовании состояния «absent». maxLength=128
ports список / элементы=словарь	Массив портов, которые будут отслеживаться. По умолчанию: `[]`
alert_if строка / обязательно	Случай срабатывания оповещения. Варианты: `"RESPONDING"` `"NOT_RESPONDING"`
email_notification строка / обязательно	Установите значение true для отправки уведомлений по электронной почте.
port строка / обязательно	Номер порта. minimum=1, maximum=65535
protocol строка / обязательно	Интернет-протокол. Варианты: `"TCP"` `"UDP"`
processes список / элементы=словарь	Массив процессов, которые будут отслеживаться. По умолчанию: `[]`
alert_if строка / обязательно	Случай срабатывания оповещения. Варианты: `"RUNNING"` `"NOT_RUNNING"`
process строка / обязательно	Имя процесса. maxLength=50
remove_ports список / элементы=строка	Порты для удаления из политики мониторинга. По умолчанию: `[]`
remove_processes список / элементы=строка	Процессы для удаления из политики мониторинга. По умолчанию: `[]`
remove_servers список / элементы=строка	Серверы для удаления из политики мониторинга. По умолчанию: `[]`

END_OF_DOCUMENT_MARKER

состояние строка	Определите состояние политики мониторинга для создания, удаления, обновления. Варианты: `"present"` ← (по умолчанию) `"absent"` `"update"`
пороговые значения список / элементы=словарь	Пороговые значения политики мониторинга. Каждый из подвариантов имеет значения предупреждения и критические, которые оба имеют подварианты оповещения и значения. Предупреждение используется для установки ограничений для предупреждающих оповещений, критические — для установки критических оповещений. оповещение включает оповещение, а значение используется для указания, когда значение превышено. По умолчанию: `[]`
cpu строка / обязательно	Предельные значения потребления ЦП.
диск строка / обязательно	Предельные значения потребления жесткого диска.
internal_ping строка / обязательно	Предельные значения отклика внутреннего пинга.
оперативная память строка / обязательно	Предельные значения потребления оперативной памяти.
передача строка / обязательно	Предельные значения потребления для передачи.
update_ports список / элементы=словарь	Порты, которые необходимо обновить в политике мониторинга. По умолчанию: `[]`
update_processes список / элементы=словарь	Процессы, которые необходимо обновить в политике мониторинга. По умолчанию: `[]`
ждать логический	ожидание, пока экземпляр не перейдет в состояние «запущен» перед возвратом Варианты: `false` `true` ← (по умолчанию)
wait_interval целое число	Определяет количество секунд ожидания при использовании методов _wait_for По умолчанию: `5`
wait_timeout целое число	Сколько времени ожидание будет продолжаться, в секундах По умолчанию: `600`

Атрибуты

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

Примеры

- name: Create a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    name: ansible monitoring policy
    description: Testing creation of a monitoring policy with ansible
    email: your@emailaddress.com
    agent: true
    thresholds:
     -
       cpu:
         warning:
           value: 80
           alert: false
         critical:
           value: 92
           alert: false
     -
       ram:
         warning:
           value: 80
           alert: false
         critical:
           value: 90
           alert: false
     -
       disk:
         warning:
           value: 80
           alert: false
         critical:
           value: 90
           alert: false
     -
       internal_ping:
         warning:
           value: 50
           alert: false
         critical:
           value: 100
           alert: false
     -
       transfer:
         warning:
           value: 1000
           alert: false
         critical:
           value: 2000
           alert: false
    ports:
     -
       protocol: TCP
       port: 22
       alert_if: RESPONDING
       email_notification: false
    processes:
     -
       process: test
       alert_if: NOT_RUNNING
       email_notification: false
    wait: true

- name: Destroy a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    state: absent
    name: ansible monitoring policy

- name: Update a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy
    name: ansible monitoring policy updated
    description: Testing creation of a monitoring policy with ansible updated
    email: another@emailaddress.com
    thresholds:
     -
       cpu:
         warning:
           value: 70
           alert: false
         critical:
           value: 90
           alert: false
     -
       ram:
         warning:
           value: 70
           alert: false
         critical:
           value: 80
           alert: false
     -
       disk:
         warning:
           value: 70
           alert: false
         critical:
           value: 80
           alert: false
     -
       internal_ping:
         warning:
           value: 60
           alert: false
         critical:
           value: 90
           alert: false
     -
       transfer:
         warning:
           value: 900
           alert: false
         critical:
           value: 1900
           alert: false
    wait: true
    state: update

- name: Add a port to a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    add_ports:
     -
       protocol: TCP
       port: 33
       alert_if: RESPONDING
       email_notification: false
    wait: true
    state: update

- name: Update existing ports of a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    update_ports:
     -
       id: existing_port_id
       protocol: TCP
       port: 34
       alert_if: RESPONDING
       email_notification: false
     -
       id: existing_port_id
       protocol: TCP
       port: 23
       alert_if: RESPONDING
       email_notification: false
    wait: true
    state: update

- name: Remove a port from a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    remove_ports:
     - port_id
    state: update

- name: Add a process to a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    add_processes:
     -
       process: test_2
       alert_if: NOT_RUNNING
       email_notification: false
    wait: true
    state: update

- name: Update existing processes of a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    update_processes:
     -
       id: process_id
       process: test_1
       alert_if: NOT_RUNNING
       email_notification: false
     -
       id: process_id
       process: test_3
       alert_if: NOT_RUNNING
       email_notification: false
    wait: true
    state: update

- name: Remove a process from a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    remove_processes:
     - process_id
    wait: true
    state: update

- name: Add server to a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    add_servers:
     - server id or name
    wait: true
    state: update

- name: Remove server from a monitoring policy
  community.general.oneandone_monitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    remove_servers:
     - server01
    wait: true
    state: update

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

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

Ключ	Описание
monitoring_policy словарь	Информация о политике мониторинга, которая была обработана Возвращается: всегда Пример: `{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}`

Авторы

Amel Ajdinovic (@aajdinov)
Ethan Devenport (@edevenport)

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

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