community.general.rax_mon_check – Создание или удаление проверки Rackspace Cloud Monitoring для существующего объекта.
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.rax_mon_check.
Обзор
- Создание или удаление проверки 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. алиасы: password | |
| auth_endpoint строка | URI службы аутентификации. Если не указано, будет установлено https://identity.api.rackspacecloud.com/v2.0/
| |
| check_type строка / обязательно | Тип создаваемой проверки. remote. проверки можно создать для любого объекта rax_mon_entity. agent. проверки можно создать только для объектов rax_mon_entities, у которых agent_id не пусто.Варианты для этого параметра: - remote.dns - remote.ftp-banner - remote.http - remote.imap-banner - remote.mssql-banner - remote.mysql-banner - remote.ping - remote.pop3-banner - remote.postgresql-banner - remote.smtp-banner - remote.smtp - remote.ssh - remote.tcp - remote.telnet-banner - agent.filesystem - agent.memory - agent.load_average - agent.cpu - agent.disk - agent.network - agent.plugin
| |
| credentials путь | Файл с данными учетных записей Rackspace. Игнорируется, если заданы api_key и username. алиасы: creds_file | |
| details словарь | Дополнительные детали, специфичные для типа проверки. Должен быть хэшем строк длиной от 1 до 255 символов, или массивом или объектом, содержащим от 0 до 256 элементов. | |
| disabled логическое значение |
| Если "да", то проверка создаётся, но фактически не используется. |
| entity_id строка / обязательно | Идентификатор объекта rax_mon_entity, который будет использовать данную проверку. | |
| env строка | Среда, настроенная в ~/.pyrax.cfg, см. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| identity_type строка | По умолчанию: "rackspace" | Метод аутентификации, например, rackspace или keystone. |
| label строка / обязательно | Определяет метку для этой проверки, длина которой составляет от 1 до 64 символов. | |
| metadata словарь | Хэш произвольных пар «ключ-значение» для сопровождения этой проверки, если она срабатывает. Ключи и значения должны быть строками длиной от 1 до 255 символов. | |
| monitoring_zones_poll строка | Список зон мониторинга, разделенный запятыми, из которых должна выполняться проверка. Доступные зоны мониторинга включают mzdfw, mzhkg, mziad, mzlon, mzord и mzsyd. Необходимо для проверок remote.*; запрещено для проверок agent.*. | |
| period целое число | Количество секунд между каждым выполнением проверки. Должно быть больше минимального периода, установленного в вашей учетной записи. | |
| region строка | Регион для создания экземпляра. | |
| 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 строка | Идентификатор клиента, используемый для аутентификации. | |
| tenant_name строка | Имя клиента, используемое для аутентификации. | |
| timeout целое число | Количество секунд, которые эта проверка будет ожидать при попытке сбора результатов. Должен быть меньше периода. | |
| username строка | Имя пользователя Rackspace, переопределяет credentials. | |
| validate_certs логическое значение |
| Требуется ли валидация SSL API-точек входа. алиасы: verify_ssl |
Примечания
Примечание
- Следующие переменные среды могут быть использованы,
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.
community.general.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
Авторы
- Эш Вильсон (@smashwilson)
© 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/community/general/rax_mon_check_module.html