thousandeyes-sdk-python/tests_api/docs/UpdateSipServerTest.md
2023-12-11 09:29:15 +00:00

4.6 KiB

UpdateSipServerTest

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. [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 UnexpandedInstantTestLinks [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]
agents **List[TestRequestAllOfAgents]** Contains list of object with required `agentId` and optional `sourceIpAddress`
auth_user str Username for authentication with SIP server. [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]
options_regex str Options regex, this field does not require escaping. [optional]
password str Password for Basic/NTLM authentication. [optional]
path_trace_mode TestPathTraceMode [optional]
port int Target port. [default to 49153]
protocol SipTestProtocol [optional]
register_enabled bool Set to true to perform SIP registration on the test target with the SIP REGISTER command. [optional] [default to False]
sip_registrar str SIP server to be tested, specified by domain name or IP address. [optional]
sip_target_time int Target time for test completion in milliseconds. [optional]
sip_time_limit int Time limit in milliseconds. [optional] [default to 5]
target_sip_credentials TestSipCredentials
user str Username for SIP registration, should be unique within a ThousandEyes account group. [optional]
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]

Example

from tests_api.models.update_sip_server_test import UpdateSipServerTest

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

# convert the object into a dict
update_sip_server_test_dict = update_sip_server_test_instance.to_dict()
# create an instance of UpdateSipServerTest from a dict
update_sip_server_test_form_dict = update_sip_server_test.from_dict(update_sip_server_test_dict)

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