Syntropy Universal Command Line Interface
Project description
Syntropy CLI
Syntropy CLI allows you to manage Syntropy endpoints, networks, and connections using command line interface.
Requirements.
Python 3.6+
Installation & Usage
pip install
The latest package can be installed from PyPi:
pip install syntropycli
Command line usage
In order to be able to perform operations with platform API keys, networks, connections or endpoints you can use syntropyctl
utility.
First you must set proper environment variables:
$ export SYNTROPY_API_SERVER={Syntropy Stack API URL}
$ export SYNTROPY_API_TOKEN={API authorization token}
In case you have a registered user on the platform you can retrieve the API token using this command(deprecated):
$ syntropyctl login {user name} {password}
{your API authorization token}
You can omit {password}
on the command line, then the utility will ask you to type the password.
In case you are using SSO to login to the platform the API authorization token can be retrieved from the Platform itself.
Or you can set the SYNTROPY_API_TOKEN
environment variable like this(Set SYNTROPY_API_SERVER
to the server address and SYNTROPY_API_TOKEN
to empty value before that):
export SYNTROPY_API_TOKEN=`syntropyctl login {user name} {password}`
You can learn about the types of actions this utility can perform by running:
$ syntropyctl --help
Usage: syntropyctl [OPTIONS] COMMAND [ARGS]...
Syntropy Networks cli tool
Options:
--help Show this message and exit.
Commands:
configure-endpoints Configures an endpoint with provided provider,...
create-api-key Create a API key.
create-connections Create connections between endpoints.
create-network Create a network.
delete-api-key Delete API key either by name or by id.
delete-connection Delete a connection.
delete-network Delete a network.
get-api-keys List all API keys.
get-connections Retrieves network connections.
get-endpoints List all endpoints.
get-networks List all networks.
get-providers Retrieve a list of endpoint providers.
get-topology Retrieves networks topology.
login Login with username and password.
manage-network-endpoints Add/Remove endpoints to/from a network.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for syntropycli-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2ff672167216690412de46fca7b1697467be8f3e18f63850b716c8f41415fb7 |
|
MD5 | b4d454fd9cf64946a693096a48ac987c |
|
BLAKE2b-256 | 0fa482badb8efd5edd6d442e46ce41ce317d66632ab5f888eb2409799c3eec81 |