Floating Server

The user has the ability to utilize either a Floating Client or a Floating Manager:

Floating Client:

• This object is responsible for managing the operations on Floating Server

Floating Manager:

• This object is responsible for managing operations with the Floating Server, while also integrating the Local License File

Floating Client

Initialization

To initialize a Floating Client, the user must specify the API protocol and domain.

• api_protocol: Defines the communication protocol between the client and the server (e.g., "http").

• api_domain: Specifies the domain or IP address and port of the Floating Server (e.g., "localhost:8080").

• hardware_id_provider (optional): Provides the client's hardware ID, which can be used to uniquely identify the client machine.

• certificate_chain_path (optional, str): The certificate path is provided during provisioning and is only applicable to Floating Server v2 (e.g "path_to_chain.chain.pem").

• verify_license_signature (optional, bool): Signature verification, if enforced, is only applicable to Floating Server v2. Default true

from licensespring.floating_server import FloatingAPIClient
from licensespring.hardware import HardwareIdProvider

api_client = FloatingAPIClient(api_protocol="http",api_domail="localhost:8080",certificate_chain_path="path_to_pem_file/chain.pem") 

auth

Authenticate

Parameters:

• username (str): username

• password (str): password

from licensespring.floating_server import FloatingAPIClient

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080",hardware_id_provider=HardwareIdProvider)
api_client.auth(username="admin",password="tetejac")

Return (dict): Response

register_user

Register user

Parameters:

• product (str,optional): product short code.

• user (str,optional): user. Defaults uses hardware id.

• os_hostname (str, optional): os hostname. Defaults to None.

• ip_local (str, optional): ip local. Defaults to None.

• user_info (str, optional): user info. Defaults to None.

• license_id (int, optional): license id. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.register_user(
    product="lkprod1",
    user="user_1",
    os_hostname="bla",
    ip_local="bla",
    user_info="bla",
    license_id=1728377159207169
)

print(response)

Return (dict): Response

unregister_user

Unregister user

Parameters

• product (str,optional): product short code.

• user (str,optional): user. Defaults uses hardware id.

• license_id (int, optional): license id. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.unregister_user(product="lkprod1",user="user_1",license_id=1728377159207169)

print(response)

Return (str): "user_unregistered"

unregister_all

Unregister all users

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

api_client.unregister_all()

borrow

Borrow license

Parameters

• product (str, optional): product short code.

• user (str,optional): user. Defaults uses hardware id.

• borrowed_until (str): borrow until date

• os_hostname (str, optional): os hostname. Defaults to None.

• ip_local (str, optional): ip local. Defaults to None.

• user_info (str, optional): user info. Defaults to None.

• license_id (int, optional): license id. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.borrow(
        product="lkprod1",
        user="user_1",
        borrowed_until="2029-05-06T00:00:00Z",
        os_hostname="bla",
        ip_local="bla",
        user_info="bla",
        license_id=1728377159207169,
    )
print(response)

Return (dict): Response

add_consumption

Add license consumption

Parameters

• product (str, optional): product short code

• consumptions (int, optional): consumptions. Defaults to 1.

• max_overages (int, optional): max overages. Defaults to None.

• allow_overages (bool, optional): allow overages. Defaults to None.

• user (str, optional): user (default uses hardware id)

• license_id (int, optional): license id. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.add_consumption(product="fs", consumptions=1)

Return (dict): Response

add_feature_consumption

Add feature consumption

Parameters

• product (str): product short code

• feature_code (str): feature code

• user (str, optional): user (default uses hardware id)

• consumptions (int, optional): consumptions. Defaults to 1.

• license_id (int, optional): license id. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.add_feature_consumption(product="fs", feature_code="f2", consumptions=1)

Return (dict): Response

feature_register

Register feature

Parameters

• product (str,optional): product short code

• feature_code (str): feature short code

• user (str, optional): user (default uses hardware id)

• license_id (int, optional): license id. Defaults to None.

• borrowed_until (str): borrow until (e.g. 2029-05-06T00:00:00Z)

• os_hostname (str, optional): os hostname. Defaults to None.

• ip_local (str, optional): ip local. Defaults to None.

• user_info (str, optional): user info. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.feature_register(
        product="fs", feature_code="f1", os_hostname="w", ip_local="1.0", user_info="info"
    )
print(response)

Return (dict): Response

feature_release

Feature release

Parameters

• product (str): product short code

• feature_code (str): feature short code

• user (str, optional): user (default uses hardware id)

• license_id (int, optional): license id. Defaults to None.

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.feature_register(
        product="fs", feature_code="f1", os_hostname="w", ip_local="1.0", user_info="info"
    )

response = api_client.feature_release(product="fs", feature_code="f1")

Return (str): "feature_released"

fetch_licenses

List licenses

Parameters

• product (str,optional): product short code filter

api_client = FloatingAPIClient(api_protocol="http", api_domain="localhost:8080")

response = api_client.fetch_licenses(product="test")
print(response)

Floating Manager

To intialize Floating Manager Python SDK Configuration needs to be created. For Floating server you can set arbitrary values for shared_key and api_key keys. Signature verification is available in Floating Server v2. To enable it in the SDK, provide the .pem certificate path in the Configuration object.

auth

Authenticate

Parameters:

• username (str): username

• password (str): password

from licensespring.licensefile.config import Configuration
from licensespring.licensefile.floating_manager import FloatingManager

fs_manager = FloatingManager(conf=conf)
fs_manager.auth(username="admin",password="tetejac")

Return (dict): Response

register

Register license

Parameters:

• os_hostname (str, optional): os hostname. Defaults to None.

• ip_local (str, optional): ip local. Defaults to None.

• user_info (str, optional): user info. Defaults to None.

• license_id (int, optional): license id. Defaults to None.

from licensespring.licensefile.config import Configuration
from licensespring.licensefile.floating_manager import FloatingManager

conf = Configuration(
    product=product,
    api_key="arbitrary",
    shared_key="arbitrary",
    file_key="your_file_key",
    file_iv="your_file_iv",
    api_domain="api_domain",
    api_protocol="http/https",
    certificate_chain_path="path_to_chain.pem"
)

fs_manager = FloatingManager(conf=conf)
license = fs_manager.register()

Return (License): License object

unregister

Unregister license

Parameters

• license_id (int, optional): license id. Defaults to None.

fs_manager = FloatingManager(conf=conf)
# There are multiple options to unregister a license
# 1. floating client -> this one is documanted
fs_manager.unregister()
# 2.1. license object -> deactivate method
license.deactivate() 
#2.2 license object -> floating release
license.floating_release(False)

Return (str): "user_unregistered"

unregister_all

Unregister all users

fs_manager = FloatingManager(conf=conf)
fs_manager.unregister_all()

borrow

Borrow license

Parameters

• borrowed_until (str): borrow until date

• os_hostname (str, optional): os hostname. Defaults to None.

• ip_local (str, optional): ip local. Defaults to None.

• user_info (str, optional): user info. Defaults to None.

• license_id (int, optional): license id. Defaults to None.

fs_manager = FloatingManager(conf=conf)
license = fs_manager.borrow("2031-05-06T00:00:00Z")
# borrow can be also used within the License object
license.floating_borrow("2031-05-06T00:00:00Z")

Return (License): License object

is_online

Checks if floating server is online

Parameters

• throw_e (bool, optional): True if you want to raise an exception. Defaults to False.

fs_manager = FloatingManager(conf=conf)
response = fs_manager.is_online()

Raises:

• ex: Exception

Return (bool): True if server is online, otherwise False

fetch_licenses

List licenses

Parameters

• product (str,optional): product short code filter

fs_manager = FloatingManager(conf=conf)

response = fs_manager.fetch_licenses(product="test")
print(response)

Return (dict): Response

Methods supported inside License object

License consumptions, feature consumptions, register feature, release feature are supported with License object for Floating Server.