thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/BgpTestRequest.md
2024-09-25 12:41:31 +00:00

3.2 KiB

BgpTestRequest

Properties

Name Type Description Notes
created_by str User that created the test. [optional] [readonly]
created_date datetime UTC created date (ISO date-time format). [optional] [readonly]
description str A description of the test. [optional]
live_share bool Indicates if the test is shared with the account group. [optional] [readonly]
modified_by str User that modified the test. [optional] [readonly]
modified_date datetime UTC last modification date (ISO date-time format). [optional] [readonly]
saved_event bool Indicates if the test is a saved event. [optional] [readonly]
test_id str Each test is assigned an unique ID; this is used to access test information and results from other endpoints. [optional] [readonly]
test_name str The name of the test. Test name must be unique. [optional]
type str [optional] [readonly]
links TestLinks [optional]
labels List[str] Contains list of test label IDs (get `labelId` from `/labels` endpoint) [optional]
shared_with_accounts List[str] Contains list of account group IDs. Test is shared with the listed account groups (get `aid` from `/account-groups` endpoint) [optional]
enabled bool Test is enabled. [optional] [default to True]
monitors List[str] Contains list of BGP monitor IDs (get `monitorId` from `/monitors` endpoint) [optional]
include_covered_prefixes bool Indicate if queries for subprefixes detected under this prefix should included. [optional]
use_public_bgp bool Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value. [optional] [default to True]
alerts_enabled bool Indicates if alerts are enabled. [optional]
alert_rules List[str] List of alert rules IDs to apply to the test (get `ruleId` from `/alerts/rules` endpoint. If `alertsEnabled` is set to `true` and `alertRules` is not included on test creation or update, applicable user default alert rules will be used) [optional]
prefix str a.b.c.d is a network address, with the prefix length defined as e. Prefixes can be any length from 8 to 24.

Example

from thousandeyes_sdk.tests.models.bgp_test_request import BgpTestRequest

# TODO update the JSON string below
json = "{}"
# create an instance of BgpTestRequest from a JSON string
bgp_test_request_instance = BgpTestRequest.from_json(json)
# print the JSON string representation of the object
print(BgpTestRequest.to_json())

# convert the object into a dict
bgp_test_request_dict = bgp_test_request_instance.to_dict()
# create an instance of BgpTestRequest from a dict
bgp_test_request_from_dict = BgpTestRequest.from_dict(bgp_test_request_dict)

[Back to Model list] [Back to API list] [Back to README]