Defines the request payload that can be sent to start a test session for a client. Each request defines a specific set of connection tests to run over a specified local port range with associated settings.
| Name | Type | Description | Attributes |
|---|---|---|---|
| client-ip | xs:string | The local IP that should be used to send the test from. | Mandatory |
| port-range-start | PortRangeStart | Identifies the start of the local port range to test. | Mandatory |
| port-range-end | PortRangeEnd | Identifies the start of the local port range to test. | Mandatory |
| test-server-address | TestServerAddress | Address of the communications/admin port of the test server to setup connection sessions to. If performing a manual (session-less) test this will be the address the tests attempt to connect to. | Mandatory |
| test-server-port | TestServerPort | Port of the communications/admin port of the test server to setup connections/sessions to (default will be 80, 8443, etc...). If performing a manual (session-less) test this will be the port the tests attempt to connect to. | |
| network-protocol | NetworkProtocol | The desired network protocol of the test (UDP|TCP), defaults to UDP | |
| uname | xs:string | A Username to setup the test session on the server with (for possible authentication). | |
| password | xs:string | Password for the test server. | |
| test-packet-format | xs:string | An optional indicator to the test client that a certain test packet format should be used. Values are arbiratry and implementation specific, but could include values such as: RTP, SIP, ... | |
| manual-test | xs:boolean | Instructs to perform a test using supplied server data as the test target instead of attempting to contact the test server to obtain a session with information first (session-less). | |
| invasive-test | xs:boolean | Run tests in an invasive way to ensure all ports can be tested. System may need to stop/start services or even reboot to perfom the testing. | |
| divide-test | xs:boolean | Run the test in two batches, waiting for each batch to complete and clean up before beginning the next one. |
| Name | Type | Restrictions |
|---|---|---|
| NetworkProtocol | xs:string | Value must be one of:
|
| TestServerPort | xs:int | |
| TestServerAddress | xs:string | Length of value must be >=0 Length of value must be <=255 |
| PortRangeEnd | xs:int | |
| PortRangeStart | xs:int |