purity_fb_1dot12.AlertWatchersApi
All URIs are relative to https://purity_fb_server/api
| Method | HTTP request | Description |
|---|---|---|
| create_alert_watchers | POST /1.12/alert-watchers | |
| delete_alert_watchers | DELETE /1.12/alert-watchers | |
| list_alert_watchers | GET /1.12/alert-watchers | |
| test_alert_watchers | GET /1.12/alert-watchers/test | |
| update_alert_watchers | PATCH /1.12/alert-watchers |
create_alert_watchers
AlertWatcherResponse create_alert_watchers(names=names, watcher_settings=watcher_settings)
Create alert watchers.
Example
from purity_fb import PurityFb, AlertWatcherPost, rest
fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
print("Exception when logging in to the array: %s\n" % e)
if res:
try:
# create an alert watcher with a given email address such that they'll receive emails
# about all system alerts
res = fb.alert_watchers.create_alert_watchers(names=['i_get_everything@example.com'])
print(res)
# create an alert watcher with a given email address such that they'll only receive emails
# about alerts of severity 'warning' and above
watcher_create_settings = AlertWatcherPost(minimum_notification_severity='warning')
res = fb.alert_watchers.create_alert_watchers(names=['rack_monitor@example.com'],
watcher_settings=watcher_create_settings)
print(res)
except rest.ApiException as e:
print("Exception when creating alert watchers: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| names | list[str] | A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional] |
| watcher_settings | AlertWatcherPost | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]
delete_alert_watchers
delete_alert_watchers(names=names)
Delete alert watchers.
Example
from purity_fb import PurityFb, rest
fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
print("Exception when logging in to the array: %s\n" % e)
if res:
try:
# delete an alert watcher with a given email address. this address will no longer receive
# any emails about any alerts, new or updated, from the system
res = fb.alert_watchers.delete_alert_watchers(names=['moved_teams@mydomain.com'])
print(res)
except rest.ApiException as e:
print("Exception when deleting alert watchers: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| names | list[str] | A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional] |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]
list_alert_watchers
AlertWatcherResponse list_alert_watchers(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)
List alert watchers.
Example
from purity_fb import PurityFb, rest
fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
print("Exception when logging in to the array: %s\n" % e)
if res:
try:
# list alert watchers with email address matching the below wildcard patterns. the first
# pattern includes all emails with "on_call" in them, and second pattern includes all
# emails ending with "@dc1.domain.com"
res = fb.alert_watchers.list_alert_watchers(
names=['*on_call*', '*@dc1.domain.com'], sort='name-')
print(res)
except rest.ApiException as e:
print("Exception when listing alert watchers: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | str | The filter to be used for query. | [optional] |
| ids | list[str] | A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional] |
| limit | int | limit, should be >= 0 | [optional] |
| names | list[str] | A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional] |
| sort | str | Sort the response by the specified fields (in descending order if '-' is appended to the field name). | [optional] |
| start | int | The offset of the first resource to return from a collection. | [optional] |
| token | str | An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]
test_alert_watchers
AlertWatcherTestResponse test_alert_watchers(names=names)
Test alert watchers
Example
from purity_fb import PurityFb, rest
fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
print("Exception when logging in to the array: %s\n" % e)
if res:
try:
# test alert watchers with given email addresses
res = fb.alert_watchers.test_alert_watchers(
names=['test1@example.com', 'test2@example.com'])
print(res)
except rest.ApiException as e:
print("Exception when testing alert watchers: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| names | list[str] | A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]
update_alert_watchers
AlertWatcherResponse update_alert_watchers(watcher_settings, ids=ids, names=names)
Update alert watchers.
Example
from purity_fb import PurityFb, AlertWatcher, rest
fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
print("Exception when logging in to the array: %s\n" % e)
if res:
try:
# An example of how to disable an alert watcher, so they stop receiving all emails about
# alerts
watcher_settings = AlertWatcher(enabled=False)
res = fb.alert_watchers.update_alert_watchers(
names=['person_on_vacation@mydomain.com'], watcher_settings=watcher_settings)
print(res)
# An example of how to set an alert watcher to only receive emails about alerts of severity
# 'critical'. This can be useful if there's an email alias tied directly into an on-call
# paging system or if there's an email alias of people who should be contacted about issues
# that need to be escalated quickly
watcher_settings = AlertWatcher(minimum_notification_severity='critical')
res = fb.alert_watchers.update_alert_watchers(
names=['storage_admins_on_call@mydomain.com'], watcher_settings=watcher_settings)
print(res)
except rest.ApiException as e:
print("Exception when updating alert watchers: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| watcher_settings | AlertWatcher | ||
| ids | list[str] | A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional] |
| names | list[str] | A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]