oneandone_monitoring_policy – Настройка политики мониторинга 1&1
Новая версия с 2.5.
Обзор
- Создание, удаление, обновление политик мониторинга (а также добавление/удаление портов, процессов и серверов). Этот модуль зависит от 1and1 >= 1.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 1and1
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 - / обязательно | Имя политики мониторинга, используемое для текущего состояния. Используется в качестве идентификатора (id или имя) при использовании состояния absent. maxLength=128 | ||
| ports - / обязательно | Массив портов, которые будут контролироваться. | ||
| alert_if - / обязательно |
| Случай срабатывания оповещения. | |
| email_notification - / обязательно | Установите значение true для отправки уведомлений по электронной почте. | ||
| port - / обязательно | Номер порта. min=1, max=65535 | ||
| protocol - / обязательно |
| Интернет-протокол. | |
| processes - / обязательно | Массив процессов, которые будут контролироваться. | ||
| alert_if - / обязательно |
| Случай срабатывания оповещения. | |
| process - / обязательно | Имя процесса. maxLength=50 | ||
| remove_ports - | Порты для удаления из политики мониторинга. | ||
| remove_processes - | Процессы для удаления из политики мониторинга. | ||
| remove_servers - | Серверы для удаления из политики мониторинга. | ||
| state - |
| Определите состояние политики мониторинга для создания, удаления, обновления. | |
| thresholds - / обязательно | Пороги политики мониторинга. Каждая из подвариантов имеет значения warning и critical, которые, в свою очередь, имеют подварианты alert и value. Warning используется для установки ограничений для предупреждающих оповещений, critical для критических оповещений. alert включает оповещения, а value используется для указания, когда значение превышено. | ||
| cpu - / обязательно | Предельные значения потребления ЦП. | ||
| disk - / обязательно | Предельные значения потребления жесткого диска. | ||
| internal_ping - / обязательно | Предельные значения ответа внутреннего пинга. | ||
| ram - / обязательно | Предельные значения потребления оперативной памяти. | ||
| transfer - / обязательно | Предельные значения потребления передачи данных. | ||
| update_ports - | Порты для обновления в политике мониторинга. | ||
| update_processes - | Процессы для обновления в политике мониторинга. | ||
| wait boolean |
| Ожидать, пока экземпляр не перейдет в состояние «запущен», перед возвратом. | |
| wait_interval - | Значение по умолчанию: 5 | Определяет количество секунд ожидания при использовании методов _wait_for. | |
| wait_timeout - | Значение по умолчанию: 600 | Сколько времени ожидание будет продолжаться, в секундах | |
Примеры
# Provisioning example. Create and destroy a monitoring policy.
- oneandone_moitoring_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
- oneandone_moitoring_policy:
auth_token: oneandone_private_api_key
state: absent
name: ansible monitoring policy
# Update a monitoring policy.
- oneandone_moitoring_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
# Add a port to a monitoring policy.
- oneandone_moitoring_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
# Update existing ports of a monitoring policy.
- oneandone_moitoring_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
# Remove a port from a monitoring policy.
- oneandone_moitoring_policy:
auth_token: oneandone_private_api_key
monitoring_policy: ansible monitoring policy updated
remove_ports:
- port_id
state: update
# Add a process to a monitoring policy.
- oneandone_moitoring_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
# Update existing processes of a monitoring policy.
- oneandone_moitoring_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
# Remove a process from a monitoring policy.
- oneandone_moitoring_policy:
auth_token: oneandone_private_api_key
monitoring_policy: ansible monitoring policy updated
remove_processes:
- process_id
wait: true
state: update
# Add server to a monitoring policy.
- oneandone_moitoring_policy:
auth_token: oneandone_private_api_key
monitoring_policy: ansible monitoring policy updated
add_servers:
- server id or name
wait: true
state: update
# Remove server from a monitoring policy.
- oneandone_moitoring_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": "Политика по умолчанию"} |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Amel Ajdinovic (@aajdinov)
- Ethan Devenport (@edevenport)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/oneandone_monitoring_policy_module.html