connect - 2023.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
Release Date
2023.2 English

Connect to hw_server/TCF agent.


connect [options]

Allows users to connect to a server, list connections, or switch between connections.


Option Description
-host <host name/ip> Name/IP address of the host machine.
-port <port num> TCP port number.
-url <url> URL description of hw_server/TCF agent.
-list List open connections.
-set <channel-id> Set active connection.
-new Create a new connection, even one existing to the same URL.
-xvc-url <url> Open Xilinx virtual cable connection.
-symbols Launch symbol server to enable source-level debugging for remote connections.


The return value depends on the options used.

-port, -host, -url, -new: <channel-id> of the new connection or error if the connection fails.

-list: List of open channels or nothing when there are no open channels.

-set: Nothing.


connect -host localhost -port 3121

Connect to hw_server/TCF agent on host localhost and port 3121.

connect -url tcp:localhost:3121

Identical to the previous example.