thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/SipServerTestRequest.md
Miguel Pragosa dcf0f54d56
Some checks failed
Python CI / build (push) Has been cancelled
[GitHub Bot] Generated python SDK (#96)
Co-authored-by: API Team <api-team@thousandeyes.com>
2025-04-02 12:58:49 +01:00

4.8 KiB

SipServerTestRequest

Properties

Name Type Description Notes
interval TestInterval
alerts_enabled bool Indicates if alerts are enabled. [optional]
enabled bool Test is enabled. [optional] [default to True]
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]
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. Note: Saved Events are now called Private Snapshots in the user interface. This change does not affect API. [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]
mtu_measurements bool Set `true` to measure MTU sizes on network from agents to the target. [optional]
network_measurements bool Enable or disable network measurements. Set to true to enable or false to disable network measurements. [optional] [default to True]
num_path_traces int Number of path traces executed by the agent. [optional] [default to 3]
options_regex str Options regex, this field does not require escaping. [optional]
path_trace_mode TestPathTraceMode [optional]
probe_mode TestProbeMode [optional]
randomized_start_time bool Indicates whether agents should randomize the start time in each test round. [optional] [default to False]
register_enabled bool Set to true to perform SIP registration on the test target with the SIP REGISTER command. [optional] [default to False]
sip_target_time int Target time for test completion in milliseconds. [optional]
sip_time_limit int Time limit in milliseconds. [optional] [default to 5]
fixed_packet_rate int Sets packets rate sent to measure the network in packets per second. [optional]
ipv6_policy TestIpv6Policy [optional]
bgp_measurements bool Set to `true` to enable bgp measurements. [optional] [default to True]
use_public_bgp bool Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value. [optional] [default to True]
monitors **List[Monitor]** Contains list of enabled BGP monitors. [optional] [readonly]
target_sip_credentials TestSipCredentials
agents **List[TestAgentRequest]** Contains list of Agent IDs (get `agentId` from `/agents` endpoint).

Example

from thousandeyes_sdk.tests.models.sip_server_test_request import SipServerTestRequest

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

# convert the object into a dict
sip_server_test_request_dict = sip_server_test_request_instance.to_dict()
# create an instance of SipServerTestRequest from a dict
sip_server_test_request_from_dict = SipServerTestRequest.from_dict(sip_server_test_request_dict)

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