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

AgentToAgentTestRequest

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]
direction	TestDirection		[optional]
dscp	str	DSCP label.	[optional] [readonly]
dscp_id	TestDscpId		[optional]
mss	int	Maximum segment size, in bytes.	[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]
protocol	AgentToAgentTestProtocol		[optional]
randomized_start_time	bool	Indicates whether agents should randomize the start time in each test round.	[optional] [default to False]
target_agent_id	str	`agentId` of the target agent for the test.
throughput_measurements	bool	Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent.	[optional] [default to False]
throughput_duration	int	The throughput duration.	[optional] [default to 10000]
throughput_rate	int	The throughput rate, only applicable for UDP protocol.	[optional]
fixed_packet_rate	int	Sets packets rate sent to measure the network in packets per second.	[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]
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_agent_test_request import AgentToAgentTestRequest

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

# convert the object into a dict
agent_to_agent_test_request_dict = agent_to_agent_test_request_instance.to_dict()
# create an instance of AgentToAgentTestRequest from a dict
agent_to_agent_test_request_from_dict = AgentToAgentTestRequest.from_dict(agent_to_agent_test_request_dict)

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