rax_mon_check – Создание или удаление проверки Rackspace Cloud Monitoring для существующего объекта

Описание
Требования
Параметры
Примечания
Примеры
Статус

Описание

Создание или удаление проверки 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 -	По умолчанию: "https://identity.api.rackspacecloud.com/v2.0/"	URI службы аутентификации.
check_type - / обязательно	Варианты: 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	Тип проверки для создания. `remote.` проверки могут быть созданы для любого объекта rax_mon_entity. `agent.` проверки могут быть созданы только для объектов rax_mon_entities, которые имеют непустое значение `agent_id`.
credentials -		Файл, в котором содержатся учетные данные Rackspace. Игнорируется, если указаны api_key и username. псевдонимы: creds_file
details -		Дополнительные детали, специфичные для типа проверки. Должно быть хэшем строк длиной от 1 до 255 символов или массивом или объектом, содержащим от 0 до 256 элементов.
disabled boolean	Варианты: no yes	Если "yes", проверка создается, но не используется.
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 -	По умолчанию: "DFW"	Регион для создания экземпляра.
state -	Варианты: present absent	Обеспечение существования или отсутствия проверки с данным `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 boolean	Варианты: no yes	Требовать или нет проверку 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.
    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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Ash Wilson (@smashwilson)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/rax_mon_check_module.html