> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/telecom-references/apis-and-integration/installing-toolpack.md). # Installing Toolpack **Applies to version(s) v2.8 to v2.9** ### Get installation package * You need to obtain the new version of the Toolpack software from the designated location. Please contact the \[mailto: TelcoBridges support team] to know which version to use. The package name starts with TBToolPack. * Upload this package to the server running Toolpack with scp or a SFTP tool like [FileZilla](http://filezilla-project.org/) #### Usage examples Start the installer with no arguments will start the "Text-mode" installation. 1. ./TBToolPack-2.9.26-Linux-centos7-x86\_64-Install ### Toolpack installation options Those options will be prompt by the installer. | Option | Description | | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Primary Database IP (dbhost) | Toolpack database hostname or IP | | Primary Database Password (dbpass) | Toolpack database password | | Primary Database Username (dbuser) | Toolpack database user | | OdbcDriver (dbdriver) | Toolpack database ODBC driver (MySQL by default) | | System Id ([systemid](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/misc/system-id/README.md)) | Toolpack System Id (previously know as [tbxgwport](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/gateway-port/README.md)) | | Primary Local IP (primip) | This is the local host IP address of the Primary ethernet interface by which communication with the TMedia takes place. If the field is left blank, IP address gets auto-detected. Also known as [tbxgwaddr0](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/gateway-address/README.md) | | Redundant local IP (redid) | This is the local host IP address, of the Redundant ethernet interface, by which communication with the TMedia takes place when Primary interface is down. This Field can be left blank on a non-redundant network system. Also known as [tbxgwaddr1](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/gateway-address/README.md) | **TMG3200/TMG800** The --[primip](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/gateway-address/README.md) and --[redip](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/gateway-address/README.md) are mandatory and needs to be set to 172.31.1.2 for both "primip" and "redip". Usage example, installing release 2.9.26: 1. ./TBToolPack-2.9.26-Linux-centos7-x86\_64-Install --[primip](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/gateway-address/README.md) 172.31.1.2 --[redip](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/gateway-address/README.md) 172.31.1.2 #### Toolpack Multi system support Toolpack installer now allows to have more than one setup being configured on the same host. To enable this feature, the directory tree changed a little, here's what it looks like now: /lib/tb/toolpack/setup/12358/service /lib/tb/toolpack/setup/12358/2.4/apps /lib/tb/toolpack/setup/12358/2.4/licenses /lib/tb/toolpack/setup/12358/2.4 **Note:** *12358* was added in the setup path. Each setup is installed as a service of the Operating System, under the following name: tbtoolpack\_${\[\[System\_Id|SystemId]]} -> ie: tbtoolpack\_12358 Each service instance can be managed individually using "tbtoolpack" command. tbtoolpack start 12358 tbtoolpack stop 12390 **Note:** If no [SystemId](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/misc/system-id/README.md) is given, the tbtoolpack will prompt the user to select one among the installed one. ### Toolpack Text-mode Installation 1. ./TBToolPack-2.9.26-Linux-centos7-x86\_64-Install --nodeps This will install TBToolpack version 2.9.26 on your computer. Continue? \[n/Y] **Basic parameters** ``` Where do you want to install TBToolpack? [/lib/tb] ``` * **/lib/tb** is the default directory where all TelcoBridges packages is installed. \[\[System Id|System Id]] \[12358] * This is the tbx gateway port and will install **tbtoolpack\_${**[**SystemId**](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/misc/system-id/README.md)**}** OS service. Service Start Type ("Auto Start" "Demand Start") \[Auto Start] * "Auto Start" is use to start the Toolpack service at host boot up, "Demand Start" requires manual start. Primary local IP \[] Redundant local IP \[] * Local host IP address of the Primary and Secondary ethernet interface by which communication with the TMedia takes place. If the field is left blank, IP address gets auto-detected. **Multi-Host parameters** ``` Multi-Host System [y/N] N ``` * Tells if the system wil be composed of more than one host. For TMG, only choose "N" (unless installing for 1+1 system) **Primary Database Connection** ``` OdbcDriver (MySQL) [MySQL] Primary Database Hostname [centos-tb] ``` * localhost and 127.0.0.1 are not allowed. Put the hostname or the IP of the primary control interface. Primary Database Redundant IP \[] * localhost and 127.0.0.1 are not allowed. Can be left blank on a non Multi-Host System. Primary Database Username \[tbdb] Primary Database Password \[tbdbpw] Primary Database Port \[3306] * press "Enter" to use the default values. ***Optional***** License Installation** ``` License Location (*.zip/*.dat) ``` * If you want to add a new license after the installation, simply copy it in the pkg/licenses/ of your toolpack installation. **Installation Progress** ``` Installing TBToolPack... Copying Copying /lib/tb/toolpack/setup/12358/2.9/apps/toolpack_sys_manager/toolpack_sys_manager Copying /lib/tb/toolpack/tbtoolpack ... ``` **Installation Complete** ``` Installation of TBToolPack complete. To start tbtoolpack service, type the following command at a shell prompt: tbtoolpack start For more options: tbtoolpack help ``` 1\. Note: It is not necessary for you to start tbtoolpack again if you didn't stop it before. If you are not sure, always start tbtoolpack at this point. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://prosbcdocs.telcobridges.com/telecom-references/apis-and-integration/installing-toolpack.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.