System Console and Toolkit Tcl Command Reference Manual

ID 683101
Date 7/08/2024
Public
Document Table of Contents

1.1.197. toolkit_load_toolkit_instance

Description

Load a toolkit (equivalent to launching a tookit in GUI but headlessly)

Usage

toolkit_load_toolkit_instance [-id <inst-id>] [-device <device-path>] [-log <log-flag>] [-output-file-path <output-file-path>] <toolkit-name> <version> <requirements>

ReturnType

String

Returns

Instance ID of the loaded toolkit

Arguments

inst-id (optional)
ID of the loaded toolkit instance, auto-assigned and returned if not specified
device-path (optional)
Device service-path obtained from "get_service_paths device"
log-flag (optional)
Flag used to start a toolkit with command logging enabled. System console must have been started with the "enable-command-logging" command line argument to enable option.
output-file-path (optional)
Name of file that logged commands will be captured in.
toolkit-name
Toolkit name
version
Toolkit version
requirements
List of requirements and paths of the selected elements in key-value pairs separated by colon

Example

toolkit_load_toolkit_instance my_toolkit 1.0 {req0:/designs/a/b/c req1:/devices/x/y/z}
	where:
	1. req0 is the requirement ID of type IP defined by "add_requirement" in Toolkit Tcl
	2. req1 is the requirement ID of type SERVICE defined by "add_requirement" in Toolkit Tcl
	3. req0 and req1 can be enumerated using toolkit_get_toolkit_requirement_ids
	4. /designs/a/b/c is the service service-path obtained from toolkit_get_toolkit_matching_services
	5. /devices/x/y/z is the module service-path obtained from toolkit_get_toolkit_matching_modules