Endpoints

Endpoints

List Endpoints

You may see alternative references to endpoints as being "agents". There is an important distinction between these two concepts. An agent is a special application/container that runs Syntropy software and allows you to connect an endpoint to the Syntropy network.

$ syntropyctl get-endpoints --help
Usage: syntropyctl get-endpoints [OPTIONS]

  List all endpoints.

  By default this command will retrieve up to 42 endpoints. You can use
  --take parameter to get more endpoints.

  Endpoint service status is added to the end of the service name with the
  following possible symbols:

  ^ - Enabled
  ! - Disabled
  ~ - Subnets partially enabled

  For example:
      `nginx^^` - the service is enabled as well as all subnets it exposes.
      `nginx^~` - the service is enabled, but only some subnets are enabled.
      `nginx!~` - the service is disabled, but some subnets are enabled.
      `nginx!!` - the service and subnets are disabled.

Options:
  --name TEXT      Filter endpoints by name.
  --id INTEGER     Filter endpoints by IDs.
  --tag TEXT       Filter endpoints by tag.
  --skip INTEGER   Skip N endpoints.
  --take INTEGER   Take N endpoints.
  --show-services  Retrieves services that are configured for each endpoint.
  --online         List only online endpoints.
  --offline        List only offline endpoints.
  -j, --json       Outputs a JSON instead of a table.
  --help           Show this message and exit.

Configure Endpoints

You can configure the endpoint provider, tags, and services using configure-endpoints command.

$ syntropyctl configure-endpoints --help
Usage: syntropyctl configure-endpoints [OPTIONS] ENDPOINT

  Configures an endpoint with provided provider, tags. Also, allows to
  enable/disable services. Endpoint can be an ID or a name. Multiple
  endpoints can be configured if names match partially with the provided
  name.

  It is possible to supply multiple --set-tag, --add-tag and --remove-tag
  options. The sequence of operations is set, add and then remove. So if you
  run this:

      syntropyctl endpoint-name --set-tag tag1 --set-tag tag2 --add-tag tag3
      --add-tag4 --remove-tag tag1

  then syntropyctl will:
      1. clear all tags and add tag1 and tag2,
      2. add tag3 and tag4,
      3. remove tag1.

  The same applies to services.

Options:
  -j, --json                  Outputs a JSON instead of a table.
  -p, --set-provider TEXT     Set a provider to the endpoint.
  -t, --set-tag TEXT          Set a tag to the endpoint(removes all other
                              tags). Supports multiple options.

  -s, --set-service TEXT      Enable a service for the endpoint(disables all
                              other services). Supports multiple options.

  -T, --add-tag TEXT          Add a tag to the endpoint(won't affect other
                              tags). Supports multiple options.

  -S, --enable-service TEXT   Enable a service for the endpoint(won't affect
                              other services). Supports multiple options.

  -R, --remove-tag TEXT       Remove a tag from the endpoint(won't affect
                              other tags). Supports multiple options.

  --clear-tags                Removes all tags.
  -D, --disable-service TEXT  Disable a service for the endpoint(won't affect
                              other services). Supports multiple options.

  --disable-all-services      Disable all services.
  --enable-all-services       Enable all services.
  --skip INTEGER              Skip N endpoints.
  --take INTEGER              Take N endpoints.
  --help                      Show this message and exit.

Did this page help you?