remoteserver add


remoteserver add --n RemoteServerNameName --h Host --o Port --u Username --p Password --s UseHTTPS --t timeout --m MicrobatchSize
Required Argument Description
Yes --n ConnectionName Specifies a name for the remote server. The name can be anything you choose.
Yes --h Host Specifies the host name or IP address of the remote server.
No --o Port Specifies the network port to use for communication with the remote server.
Yes --u Username The username to use to connect to the remote server.
Yes --p Password The password to use to connect to the remote server.
No --s UseHTTPS Specifies whether to use HTTPS communication between the local server and the remote server. HTTPS must be enabled on the remote server in order for HTTPS to work.
No --t timeout The number of seconds to allow the system to wait for a response from the remote server before the connection times out. The default is 2 seconds.
No --m MicrobatchSize The number of records passed to the remote server in a single batch. The default is 50. Entering a higher number in this field will speed up input and output but slow down data transmission.

To determine the optimal microbatch size for your environment, create a test dataflow that uses the remote server in one of its stages. Run the dataflow with a microbatch size of 50 and record the time it takes to run the dataflow. Then run a test with the microbatch size at 60, and another one with a microbatch size of 70 and observe the results. You may also want to run tests with microbatch sizes of 40 and 30 to see if reducing the microbatch size improves execution time. Continue testing with different settings until you identify the best setting for your environment.


This example creates a connection to a remote server named SpectrumServer2.

remoteserver add --n SpectrumServer2 --h MyServer --u john123 --p examplepassword1