sle-management-client

Documentation for the Space Link Extension Management Client.

Framework

Overview

• sle-common: Library for user and provider side Space Link Extension application development
• sle-provider: Provider (ground station side) Space Link Extension application
• sle-management-client: OpenAPI based client for sle-provider management

Installation & Usage

pip install

You can install this package directly from Github

pip3 install git+https://github.com/visionspacetec/sle-provider.git

(you may need to run pip with root permission: sudo pip3 install git+https://github.com/visionspacetec/sle-provider.git)

Setuptools

Install via Setuptools.

python3 setup.py install --user

(or sudo python3 setup.py install to install the package for all users)

Getting Started

Follow the installation procedure and be aware of the safety precautions!

Start the sle-provider with the 'http_no_auth_rest_protocol' and run the following:

import openapi_client

sle_instance = openapi_client.SleConfigApi()
param = openapi_client.SleConfigParams.AUTHENTICATION_DELAY
sle_instance.api_client.configuration.host = 'http://localhost:2048/api'

print('Getting: {}...'.format(param))
print('{}: {}'.format(param, sle_instance.get_sle_config(param)))

Documentation for API Endpoints

All URIs are relative to http://localhost:2048/api

Class	Method	HTTP request	Description
CortexCommandApi	get_cortex_command_list	GET /cortex-command	Returns a list of the availiable Cortex commands
CortexCommandApi	post_cortex_command	POST /cortex-command	Send a command to the Cortex
CortexConfigApi	get_cortex_config_table	GET /cortex-config/{param}	Returns the parameter names of a Cortex configuration table
CortexConfigApi	get_cortex_config_table_list	GET /cortex-config	Get a list of the available configuration tables
ServiceInstancesApi	delete_si	DELETE /service-instances/{si}	Deletes a service instance by name
ServiceInstancesApi	delete_si_list	DELETE /service-instances	Deletes all loaded service instances
ServiceInstancesApi	get_si	GET /service-instances/{si}	Find service instance by name
ServiceInstancesApi	get_si_list	GET /service-instances	Get a list of the loaded service instances
ServiceInstancesApi	patch_si	PATCH /service-instances/{si}	Updates one or more service instance parameters
ServiceInstancesApi	post_si	POST /service-instances/{si}	Adds a service instance
SleConfigApi	get_sle_config	GET /sle-config/{param}	Returns the current value of a SLE configuration parameter
SleConfigApi	get_sle_config_list	GET /sle-config	Get a list of the available configuration parameters
SleConfigApi	patch_sle_config	PATCH /sle-config/{param}	Update a SLE configuration parameter

Documentation for Models

• CortexCommand
• ServiceInstance
• SleConfigParams
• SleConfigParamsValues

Documentation for Authorization

BasicAuth

• Type: HTTP basic authentication

OpenAPI

This Python package is automatically generated by the OpenAPI Generator project

Generating from .yaml

openapi-generator generate -i sle-management-client.yaml -g python -o /home/admin/openapi-generator

The Python openapi-generator does not generate the BasicAuth scheme correctly. Use the existing code as a reference to upgrade generated code.

Contributing

If you would like help implementing a new feature or fix a bug, check out our Contributing page and the Code of Conduct!

Questions or need help?

Please open an issue for bug reporting, enhancement or feature requests.