thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/UpdateFtpServerTest.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

68 lines
5.0 KiB
Markdown

# UpdateFtpServerTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interval** | [**TestInterval**](TestInterval.md) | |
**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**](TestLinks.md) | | [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]
**download_limit** | **int** | Specify maximum number of bytes to download from the target object. | [optional]
**ftp_target_time** | **int** | Target time for operation completion; specified in milliseconds. | [optional]
**ftp_time_limit** | **int** | Set the time limit for the test in seconds. | [optional] [default to 10]
**mtu_measurements** | **bool** | Set `true` to measure MTU sizes on network from agents to the target. | [optional]
**network_measurements** | **bool** | Enable or disable network measurements. Set to true to enable or false to disable network measurements. | [optional] [default to True]
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
**password** | **str** | Password for Basic/NTLM authentication. |
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
**request_type** | [**FtpServerRequestType**](FtpServerRequestType.md) | |
**url** | **str** | Target for the test. |
**use_active_ftp** | **bool** | Explicitly set the flag to use active FTP. | [optional] [default to False]
**use_explicit_ftps** | **bool** | Use explicit FTPS (ftp over SSL). By default, tests will autodetect when it is appropriate to use FTPS. | [optional]
**username** | **str** | Username for Basic/NTLM authentication. |
**fixed_packet_rate** | **int** | Sets packets rate sent to measure the network in packets per second. | [optional]
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
**agents** | [**List[AgentRequest]**](AgentRequest.md) | | [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]
## Example
```python
from thousandeyes_sdk.tests.models.update_ftp_server_test import UpdateFtpServerTest
# TODO update the JSON string below
json = "{}"
# create an instance of UpdateFtpServerTest from a JSON string
update_ftp_server_test_instance = UpdateFtpServerTest.from_json(json)
# print the JSON string representation of the object
print(UpdateFtpServerTest.to_json())
# convert the object into a dict
update_ftp_server_test_dict = update_ftp_server_test_instance.to_dict()
# create an instance of UpdateFtpServerTest from a dict
update_ftp_server_test_from_dict = UpdateFtpServerTest.from_dict(update_ftp_server_test_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)