endpoint command¶

Manage Endpoint objects

If no subcommand is provided, the default behaviour is list.

list¶

List endpoints in workspace in a tabular view.

Arguments¶

-a, --all: include out of scope endpoints

-r <true|false>: show only reachable (true, default) or unreachable (false) endpoints

-c <true|false>: show only endpoint with (true, default) or without (false) a working connectioN

add¶

Add endpoint <ip>:<port> to the workspace. If port is not specified, default value is 22.

Arguments¶

<ip>: a valid IPv4 or IPv6 IP address.

<port>: an integer between 0 and 65535. Default is 22

tag¶

Add a Tag to an Endpoint

Arguments¶

<endpoint>: the Endpoint to add a tag to, given as a <ip>:<port> string

<tagname>: the name of the Tag to add. A “!” will be prepended to the name if it is not included.

untag¶

Remove a Tag from an Endpoint

Arguments¶

<endpoint>: the Endpoint to remove the tag from, given as a <ip>:<port> string

<tagname>: the name of the Tag to remove. A “!” will be prepended to the name if it is not included.

search¶

Search endpoints whose IP or Port match a pattern, and optionally tag the results.

Arguments¶

<search field>: the field in which to perform the search.

<value>: the value to search for.

-a, --all: include out of scope endpoints in the search results

-t <tag>, --tag <tag>: add the Tag to every endpoint in the search result

delete¶

Delete the endpoint Endpoint from the Workspace. Recursively deletes Path and Connection to the endpoint, as well as associated Host if the Endpoint was the last to its Host.

Arguments¶

<endpoint>: a registered endpoint in the workspace, given as a <ip>:<port> string