thousandeyes-sdk-python/thousandeyes-sdk-instant-tests/docs/AgentToServerProperties.md
Miguel Pragosa 4aeaaa4924
Some checks failed
Python CI / build (push) Has been cancelled
[GitHub Bot] Generated python SDK (#97)
Co-authored-by: API Team <api-team@thousandeyes.com>
2025-04-04 15:41:26 +01:00

45 lines
3.2 KiB
Markdown

# AgentToServerProperties
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bandwidth_measurements** | **bool** | Set to &#x60;true&#x60; to enable bandwidth measurements, only applies to Enterprise agents assigned to the test. | [optional]
**continuous_mode** | **bool** | To enable continuous monitoring, set this parameter to &#x60;true&#x60; to. When continuous monitoring is enabled, the following actions occur: * &#x60;fixedPacketRate&#x60; is enforced * &#x60;bandwidthMeasurements&#x60; are disabled * If the &#x60;protocol&#x60; is set to &#x60;tcp&#x60;, &#x60;probeMode&#x60; is set to &#x60;syn&#x60;. | [optional]
**fixed_packet_rate** | **int** | If continuousMode is &#x60;false&#x60;, set the fixedPacketRate to a value between 10-100. If &#x60;continuousMode&#x60; is &#x60;true&#x60;, set the &#x60;fixedPacketRate&#x60; to &#x60;1&#x60; | [optional]
**mtu_measurements** | **bool** | Set &#x60;true&#x60; to measure MTU sizes on network from agents to the target. | [optional]
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
**server** | **str** | The target name or IP address. If a port is set for the test, it is appended to the target name or IP address using a colon. |
**dscp** | **str** | DSCP label. | [optional] [readonly]
**dscp_id** | [**TestDscpId**](TestDscpId.md) | | [optional]
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
**ping_payload_size** | **int** | Payload size (not total packet size) for the end-to-end metric&#39;s probes, ping payload size allows values from 0 to 1400 bytes. When set to null, payload sizes are 0 bytes for ICMP-based tests and 1 byte for TCP-based tests. | [optional]
**network_measurements** | **bool** | View packet loss in 1-second intervals. This is only available for 1-minute interval tests. Set to &#x60;true&#x60; to enable network measurements. | [optional] [default to False]
**type** | **str** | | [optional] [readonly]
## Example
```python
from thousandeyes_sdk.instant_tests.models.agent_to_server_properties import AgentToServerProperties
# TODO update the JSON string below
json = "{}"
# create an instance of AgentToServerProperties from a JSON string
agent_to_server_properties_instance = AgentToServerProperties.from_json(json)
# print the JSON string representation of the object
print(AgentToServerProperties.to_json())
# convert the object into a dict
agent_to_server_properties_dict = agent_to_server_properties_instance.to_dict()
# create an instance of AgentToServerProperties from a dict
agent_to_server_properties_from_dict = AgentToServerProperties.from_dict(agent_to_server_properties_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)