mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 07:55:31 +00:00
4aeaaa4924
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
58 lines
4.8 KiB
Markdown
58 lines
4.8 KiB
Markdown
# AgentToServerInstantTestRequest
|
|
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**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**](TestLinks.md) | | [optional]
|
|
**labels** | **List[str]** | A list of test label identifiers (get `labelId` from `/labels` endpoint). | [optional]
|
|
**shared_with_accounts** | **List[str]** | A list of account group identifiers that the test is shared with (get `aid` from `/account-groups` endpoint). | [optional]
|
|
**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]
|
|
**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'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]
|
|
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test_request import AgentToServerInstantTestRequest
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of AgentToServerInstantTestRequest from a JSON string
|
|
agent_to_server_instant_test_request_instance = AgentToServerInstantTestRequest.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(AgentToServerInstantTestRequest.to_json())
|
|
|
|
# convert the object into a dict
|
|
agent_to_server_instant_test_request_dict = agent_to_server_instant_test_request_instance.to_dict()
|
|
# create an instance of AgentToServerInstantTestRequest from a dict
|
|
agent_to_server_instant_test_request_from_dict = AgentToServerInstantTestRequest.from_dict(agent_to_server_instant_test_request_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)
|
|
|
|
|