forester-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.0.4
• Package version: 0.0.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import forester_client

Setuptools

Install via Setuptools.

python setup.py install --user

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

Then import the package:

import forester_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import forester_client
from forester_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://forester.example.com:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = forester_client.Configuration(
    host = "https://forester.example.com:8000"
)



# Enter a context with an instance of the API client
with forester_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forester_client.DefaultApi(api_client)
    appliance_service_create_request = forester_client.ApplianceServiceCreateRequest() # ApplianceServiceCreateRequest |  (optional)

    try:
        api_response = api_instance.rpc_appliance_service_create_post(appliance_service_create_request=appliance_service_create_request)
        print("The response of DefaultApi->rpc_appliance_service_create_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->rpc_appliance_service_create_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://forester.example.com:8000

Class	Method	HTTP request	Description
DefaultApi	rpc_appliance_service_create_post	POST /rpc/ApplianceService/Create
DefaultApi	rpc_appliance_service_delete_post	POST /rpc/ApplianceService/Delete
DefaultApi	rpc_appliance_service_enlist_post	POST /rpc/ApplianceService/Enlist
DefaultApi	rpc_appliance_service_find_post	POST /rpc/ApplianceService/Find
DefaultApi	rpc_appliance_service_list_post	POST /rpc/ApplianceService/List
DefaultApi	rpc_image_service_create_post	POST /rpc/ImageService/Create
DefaultApi	rpc_image_service_delete_post	POST /rpc/ImageService/Delete
DefaultApi	rpc_image_service_find_post	POST /rpc/ImageService/Find
DefaultApi	rpc_image_service_get_by_id_post	POST /rpc/ImageService/GetByID
DefaultApi	rpc_image_service_list_post	POST /rpc/ImageService/List
DefaultApi	rpc_snippet_service_create_post	POST /rpc/SnippetService/Create
DefaultApi	rpc_snippet_service_delete_post	POST /rpc/SnippetService/Delete
DefaultApi	rpc_snippet_service_edit_post	POST /rpc/SnippetService/Edit
DefaultApi	rpc_snippet_service_find_post	POST /rpc/SnippetService/Find
DefaultApi	rpc_snippet_service_list_post	POST /rpc/SnippetService/List
DefaultApi	rpc_system_service_acquire_post	POST /rpc/SystemService/Acquire
DefaultApi	rpc_system_service_boot_local_post	POST /rpc/SystemService/BootLocal
DefaultApi	rpc_system_service_boot_network_post	POST /rpc/SystemService/BootNetwork
DefaultApi	rpc_system_service_find_post	POST /rpc/SystemService/Find
DefaultApi	rpc_system_service_kickstart_post	POST /rpc/SystemService/Kickstart
DefaultApi	rpc_system_service_list_post	POST /rpc/SystemService/List
DefaultApi	rpc_system_service_logs_post	POST /rpc/SystemService/Logs
DefaultApi	rpc_system_service_register_post	POST /rpc/SystemService/Register
DefaultApi	rpc_system_service_release_post	POST /rpc/SystemService/Release
DefaultApi	rpc_system_service_rename_post	POST /rpc/SystemService/Rename

Documentation For Models

• Appliance
• ApplianceServiceCreateRequest
• ApplianceServiceDeleteRequest
• ApplianceServiceEnlistRequest
• ApplianceServiceFindRequest
• ApplianceServiceFindResponse
• ApplianceServiceListRequest
• ApplianceServiceListResponse
• ErrorWebrpcBadMethod
• ErrorWebrpcBadRequest
• ErrorWebrpcBadResponse
• ErrorWebrpcBadRoute
• ErrorWebrpcEndpoint
• ErrorWebrpcInternalError
• ErrorWebrpcRequestFailed
• ErrorWebrpcServerPanic
• Image
• ImageServiceCreateRequest
• ImageServiceCreateResponse
• ImageServiceDeleteRequest
• ImageServiceFindRequest
• ImageServiceFindResponse
• ImageServiceGetByIDRequest
• ImageServiceGetByIDResponse
• ImageServiceListRequest
• ImageServiceListResponse
• LogEntry
• NewSystem
• RpcImageServiceCreatePost4XXResponse
• RpcImageServiceCreatePost5XXResponse
• Snippet
• SnippetServiceCreateRequest
• SnippetServiceDeleteRequest
• SnippetServiceEditRequest
• SnippetServiceFindRequest
• SnippetServiceFindResponse
• SnippetServiceListRequest
• SnippetServiceListResponse
• System
• SystemServiceAcquireRequest
• SystemServiceBootLocalRequest
• SystemServiceBootNetworkRequest
• SystemServiceFindRequest
• SystemServiceFindResponse
• SystemServiceKickstartRequest
• SystemServiceKickstartResponse
• SystemServiceListRequest
• SystemServiceListResponse
• SystemServiceLogsRequest
• SystemServiceLogsResponse
• SystemServiceRegisterRequest
• SystemServiceReleaseRequest
• SystemServiceRenameRequest

Documentation For Authorization

Endpoints do not require authorization.

Author