Connections
Connections
List Connections
List the connections on a network:
$ syntropyctl get-connections --help
Usage: syntropyctl get-connections [OPTIONS]
Retrieves network connections.
Connection service status is added to the end of the service name with the
following possible symbols:
^ - Service is online.
! - There was an error exposing the service
~ - Service is in PENDING state
? - Unknown state
By default this command will retrieve up to 42 connections. You can use
--take parameter to get more connections.
Options:
--id INTEGER Filter endpoints by ID.
--name TEXT Filter endpoints by ID or name.
--skip INTEGER Skip N connections.
--take INTEGER Take N connections.
--show-services Retrieves services that are configured for each endpoint.
-j, --json Outputs a JSON instead of a table.
--help Show this message and exit.
Create Network Connection
$ syntropyctl create-connections --help
Usage: syntropyctl create-connections [OPTIONS] [AGENTS]...
Create connections between endpoints. Number of endpoints must be even.
Arguments:
agents - a list of endpoint ids or names separated by spaces.
In order to use endpoint names instead of ids provide --use-names option.
Example:
syntropyctl create-connections 1 2 3 4 5 6 7 8
This command will create 4 connections from Endpoint 1 to Endpoint 2
like this:
Endpoint 1 ID | Endpoint 2 ID
1 | 2
3 | 4
5 | 6
7 | 8
Options:
--use-names Use endpoint names instead of ids. Will not work
with name duplicates.
-j, --json Outputs a JSON instead of a table.
--help Show this message and exit.
Delete Connection
Remove a connection between endpoints using their IDs
$ syntropyctl delete-connection --help
Usage: syntropyctl delete-connection [OPTIONS] ENDPOINT_1 ENDPOINT_2
Delete a connection.
Options:
--help Show this message and exit.
Updated over 1 year ago