mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 16:05:30 +00:00
62bed5b328
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
67 lines
4.5 KiB
Markdown
67 lines
4.5 KiB
Markdown
# SipServerTest
|
|
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**interval** | [**TestInterval**](TestInterval.md) | |
|
|
**alerts_enabled** | **bool** | Indicates if alerts are enabled. | [optional]
|
|
**enabled** | **bool** | Test is enabled. | [optional] [default to True]
|
|
**alert_rules** | [**List[AlertRule]**](AlertRule.md) | Contains list of enabled alert rule objects. | [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]**](Monitor.md) | Contains list of enabled BGP monitors. | [optional] [readonly]
|
|
**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**](TestLinks.md) | | [optional]
|
|
**labels** | [**List[TestLabel]**](TestLabel.md) | | [optional] [readonly]
|
|
**shared_with_accounts** | [**List[SharedWithAccount]**](SharedWithAccount.md) | | [optional] [readonly]
|
|
**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**](TestPathTraceMode.md) | | [optional]
|
|
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [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**](TestIpv6Policy.md) | | [optional]
|
|
**auth_user** | **str** | Username for authentication with SIP server. | [optional]
|
|
**password** | **str** | Password for Basic/NTLM authentication. | [optional]
|
|
**port** | **int** | Target port. | [default to 49153]
|
|
**protocol** | [**SipTestProtocol**](SipTestProtocol.md) | | [optional]
|
|
**sip_registrar** | **str** | SIP server to be tested, specified by domain name or IP address. | [optional]
|
|
**user** | **str** | Username for SIP registration, should be unique within a ThousandEyes account group. | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.tests.models.sip_server_test import SipServerTest
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of SipServerTest from a JSON string
|
|
sip_server_test_instance = SipServerTest.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(SipServerTest.to_json())
|
|
|
|
# convert the object into a dict
|
|
sip_server_test_dict = sip_server_test_instance.to_dict()
|
|
# create an instance of SipServerTest from a dict
|
|
sip_server_test_from_dict = SipServerTest.from_dict(sip_server_test_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|