thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/AgentToServerTestRequest.md

AgentToServerTestRequest

Properties

Name	Type	Description	Notes
interval	TestInterval
alerts_enabled	bool	Indicates if alerts are enabled.	[optional]
enabled	bool	Test is enabled.	[optional] [default to True]
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]
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		[optional]
labels	List[str]	Contains list of test label IDs (get `labelId` from `/labels` 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]
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]
port	int	Target port.	[optional] [default to 49153]
probe_mode	TestProbeMode		[optional]
protocol	TestProtocol		[optional]
server	str	Target name or IP address.
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]
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[str]	Contains list of BGP monitor IDs (get `monitorId` from `/monitors` endpoint)	[optional]
agents	**List[TestAgentRequest]**	Contains list of Agent IDs (get `agentId` from `/agents` endpoint).

Example

from thousandeyes_sdk.tests.models.agent_to_server_test_request import AgentToServerTestRequest

# TODO update the JSON string below
json = "{}"
# create an instance of AgentToServerTestRequest from a JSON string
agent_to_server_test_request_instance = AgentToServerTestRequest.from_json(json)
# print the JSON string representation of the object
print(AgentToServerTestRequest.to_json())

# convert the object into a dict
agent_to_server_test_request_dict = agent_to_server_test_request_instance.to_dict()
# create an instance of AgentToServerTestRequest from a dict
agent_to_server_test_request_from_dict = AgentToServerTestRequest.from_dict(agent_to_server_test_request_dict)

[Back to Model list] [Back to API list] [Back to README]