rax_mon_check - Создание или удаление проверки Rackspace Cloud Monitoring для существующего объекта.
Новое в версии 2.0.
Обзор
- Создание или удаление проверки Rackspace Cloud Monitoring, связанной с существующим объектом rax_mon_entity. Проверка — это определенный тест или измерение, выполняемое, возможно, из разных зон мониторинга, на отслеживаемых системах. Поток модуля мониторинга Rackspace | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- pyrax
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key | Ключ API Rackspace, переопределяет credentials. псевдонимы: пароль | |
| auth_endpoint (добавлено в 1.5) | По умолчанию: https://identity.api.rackspacecloud.com/v2.0/ | URI службы аутентификации. |
| check_type обязательно |
| Тип проверки для создания. Проверки remote. могут быть созданы для любого rax_mon_entity. Проверки agent. могут быть созданы только для rax_mon_entities, у которых есть непустое поле agent_id. |
| credentials | По умолчанию: None | Файл, в котором находятся учетные данные Rackspace. Игнорируется, если заданы api_key и username. псевдонимы: creds_file |
| details | Дополнительные данные, специфичные для типа проверки. Должно быть хэш-таблицей строк длиной от 1 до 255 символов или массивом или объектом, содержащим от 0 до 256 элементов. | |
| disabled |
| Если "yes", проверка создается, но пока не используется. |
| entity_id обязательно | Идентификатор rax_mon_entity, к которому относится данная проверка. | |
| env (добавлено в 1.5) | Среда, как настроено в ~/.pyrax.cfg, см. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| identity_type (добавлено в 1.5) | По умолчанию: rackspace | Метод аутентификации, например, rackspace или keystone. |
| label обязательно | Определяет метку для этой проверки, длиной от 1 до 64 символов. | |
| metadata | Хэш произвольных пар «ключ-значение» для сопровождения этой проверки, если она сработает. Ключи и значения должны быть строками длиной от 1 до 255 символов. | |
| monitoring_zones_poll | Список зон мониторинга через запятую, из которых должна выполняться проверка. Доступные зоны мониторинга включают mzdfw, mzhkg, mziad, mzlon, mzord и mzsyd. Требуется для проверок remote.*; запрещено для проверок agent.*. | |
| period | Количество секунд между каждым выполнением проверки. Должно быть больше минимального периода, установленного для вашей учетной записи. | |
| region | По умолчанию: DFW | Регион для создания экземпляра. |
| state |
| Обеспечить, что проверка с этим label существует или не существует. |
| target_alias | Один из `target_alias` и `target_hostname` требуется для проверок remote.*, но запрещен для проверок agent.*. Используйте соответствующий ключ в хэше `ip_addresses` объекта для преобразования имени в IP-адрес. | |
| target_hostname | Один из `target_hostname` и `target_alias` требуется для проверок remote.*, но запрещен для проверок agent.*. Имя хоста, на который должна быть нацелена эта проверка. Должен быть допустимым IPv4, IPv6 или FQDN. | |
| tenant_id (добавлено в 1.5) | Идентификатор арендатора, используемый для аутентификации. | |
| tenant_name (добавлено в 1.5) | Имя арендатора, используемое для аутентификации. | |
| timeout | Количество секунд, которые эта проверка будет ожидать при попытке сбора результатов. Должно быть меньше, чем период. | |
| username | Имя пользователя Rackspace, переопределяет credentials. | |
| verify_ssl (добавлено в 1.5) | Требуется ли проверка SSL для API-точек входа. |
Примечания
Примечание
- Следующие переменные окружения могут использоваться:
RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION. -
RAX_CREDENTIALSиRAX_CREDS_FILEуказывают на файл учетных данных, соответствующий pyrax. См. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating -
RAX_USERNAMEиRAX_API_KEYисключают использование файла учетных данных. -
RAX_REGIONопределяет регион Rackspace Public Cloud (DFW, ORD, LON, ...)
Примеры
- name: Create a monitoring check
gather_facts: False
hosts: local
connection: local
tasks:
- name: Associate a check with an existing entity.
rax_mon_check:
credentials: ~/.rax_pub
state: present
entity_id: "{{ the_entity['entity']['id'] }}"
label: the_check
check_type: remote.ping
monitoring_zones_poll: mziad,mzord,mzdfw
details:
count: 10
meta:
hurf: durf
register: the_check
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- Эш Уилсон
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/rax_mon_check_module.html