Python API - Launcher Services

Table of Contents

• List assets
  • list_projects
  • list_servers
  • list_users
  • list_vms
• Project
  • project_create
  • project_delete
  • project_details
  • project_download_file
  • project_download_file_as
  • project_generate_scenario
  • project_list_files
  • project_remove_file
  • project_rename
  • project_rename_file
  • project_scenario
  • project_stop_scenario_generation
  • project_upload_file
• Server
  • server_kill
  • server_launch
  • server_restart
  • server_unblock
• System information
  • system_disk_info
  • system_licenses_info

In this page, we will show the various launcher services available through the Python API.

List assets

list_projects

list_projects(user) -> list(project_id)

Request list of projects for given user.

Parameters

user	Name of user to request projects from -> string

Returns

list(project_id)

list_servers

list_servers() -> list(server_info)

Request list of running Reven servers.

Returns

list(server_info)

list_users

list_users() -> list(string)

Request list of reven users.

Returns

list(string)

list_vms

list_vms() -> list(vm_info)

Request list of available Virtual Machine configurations.

Returns

list(vm_info)

Project

project_create

project_create(project) -> None

Create a new project.

Parameters

project

Project id (user, project name). -> project_id

project_delete

project_delete(project) -> None

Delete a project.

Parameters

project

Project id (user, project name). -> project_id

project_details

project_details(project) -> server_info

Retrieve server information of a project.

Parameters

project

Project id (user, project name). -> project_id

Returns

server_info

project_download_file

project_download_file(project, filename) -> file_chunk

Download and return a file chunk.

Parameters

project	Project id (user, project name). -> project_id
filename	Name of file to download. -> string

Returns

file_chunk

project_download_file_as

project_download_file_as(project, filename, destination) -> None

Download a file to a client side location.

Parameters

project	Project id (user, project name). -> project_id
filename	Name of file to download. -> string
destination	Filepath to save downloaded file as. -> string

project_generate_scenario

project_generate_scenario(project, scenario) -> None

Remove an input file from a project.

Parameters

project	Project id (user, project name). -> project_id
scenario	Scenario configuration. -> scenario_generation_config

project_list_files

project_list_files(project) -> list(file_info)

List input files of a project.

Parameters

project

Project id (user, project name). -> project_id

Returns

list(file_info)

project_remove_file

project_remove_file(project, filename) -> None

Remove an input file from a project.

Parameters

project	Project id (user, project name). -> project_id
filename	Name of file to remove. -> string

project_rename

project_rename(project, new_project) -> None

Rename a project.

Parameters

project	Id of project to rename. -> project_id
new_project	New project id (user, project name). -> project_id

project_rename_file

project_rename_file(project, filename, new_filename) -> None

Rename an input file from a project.

Parameters

project	Project id (user, project name). -> project_id
filename	Name of file to rename. -> string
new_filename	New name for given file. -> string

project_scenario

project_scenario(project) -> scenario_generation_info

Retrieve scenario generation status for a project.

Parameters

project

Project id (user, project name). -> project_id

Returns

scenario_generation_info

project_stop_scenario_generation

project_stop_scenario_generation(project) -> None

Stop current scenario generation for a project.

Parameters

project

Project id (user, project name). -> project_id

project_upload_file

project_upload_file(project, filepath) -> None

Upload input file to a project.

Parameters

project	Project id (user, project name). -> project_id
filepath	Path of the file to upload. -> string

Server

server_kill

server_kill(port) -> None

Kill Reven server by port.

Parameters

port	Port of Reven server. -> integer

server_launch

server_launch(project, launch_config) -> integer

Launch Reven server for given project and return server port.

Parameters

project	id of project to launch. -> project_id
launch_config	launch configuration (license, port, etc.). -> reven_launch_config

Returns

integer

server_restart

server_restart(port) -> integer

Restart Reven server by port, return new server port.

Parameters

port	Port of Reven server. -> integer

Returns

integer

server_unblock

server_unblock(port) -> None

Unblock Reven server by port (stop current service).

Parameters

port	Port of Reven server. -> integer

System information

system_disk_info

system_disk_info() -> disk_info

Return disk usage.

Returns

disk_info

system_licenses_info

system_licenses_info() -> licenses_info

Return licenses usage.

Returns

licenses_info