thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/AgentToServerProperties.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5)
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

45 lines
3.0 KiB
Markdown

# AgentToServerProperties
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bandwidth_measurements** | **bool** | Set to `true` 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 `true` to. When continuous monitoring is enabled, the following actions occur: * `fixedPacketRate` is enforced * `bandwidthMeasurements` are disabled * If the `protocol` is set to `tcp`, `probeMode` is set to `syn`. | [optional]
**fixed_packet_rate** | **int** | If continuousMode is `false`, set the fixedPacketRate to a value between 10-100. If `continuousMode` is `true`, set the `fixedPacketRate` to `1` | [optional]
**mtu_measurements** | **bool** | Set `true` 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]
**port** | **int** | Target port. | [optional] [default to 49153]
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
**server** | **str** | Target name or IP address. |
**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'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 `true` to enable network measurements. | [optional] [default to False]
**type** | **str** | | [optional] [readonly]
## Example
```python
from thousandeyes_sdk.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)