mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-06-19 23:15:30 +00:00
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
5.1 KiB
5.1 KiB
UpdateAgentToServerTestRequest
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| labels | List[str] | Contains list of test label IDs (get `labelId` from `/labels` endpoint) | [optional] |
| tags | List[str] | Contains list of test tag IDs (get `id` from `/tags` 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] |
| 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] |
| monitors | List[str] | Contains list of BGP monitor IDs (get `monitorId` from `/monitors` 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 | [optional] | |
| probe_mode | TestProbeMode | [optional] | |
| protocol | TestProtocol | [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. | [optional] |
| dscp | str | DSCP label. | [optional] [readonly] |
| dscp_id | TestDscpId | [optional] | |
| ipv6_policy | TestIpv6Policy | [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[TestAgentRequest]** | Contains list of Agent IDs (get `agentId` from `/agents` endpoint). | [optional] |
| interval | TestInterval | [optional] | |
| alerts_enabled | bool | Indicates if alerts are enabled. | [optional] |
| enabled | bool | Test is enabled. | [optional] [default to True] |
| description | str | A description of the test. | [optional] |
| test_name | str | Name of the test. | [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] |
| port | int | Port number to use for the test. The default port is 80. | [optional] |
Example
from thousandeyes_sdk.tests.models.update_agent_to_server_test_request import UpdateAgentToServerTestRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UpdateAgentToServerTestRequest from a JSON string
update_agent_to_server_test_request_instance = UpdateAgentToServerTestRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateAgentToServerTestRequest.to_json())
# convert the object into a dict
update_agent_to_server_test_request_dict = update_agent_to_server_test_request_instance.to_dict()
# create an instance of UpdateAgentToServerTestRequest from a dict
update_agent_to_server_test_request_from_dict = UpdateAgentToServerTestRequest.from_dict(update_agent_to_server_test_request_dict)