# TBConfig Examples

### Role

tbconfig is used to provision the system using the RESTful API. It supports three different modes of operations : interactive mode, shell mode and command line mode.

<br>

### Interactive mode

This mode allows to explore and modify the configurations using arrow keys and simple commands. Multiple modifications can be made before they are applied to the unit. While inside the interactive mode, type the question mark (?) key to get a more detailed help.

* To launch the tool in interactive mode :

```
tbconfig
```

<br>

### Shell mode

This mode allows to explore and modify the configurations using cd (change directory), ls (list files) and other simple commands. Multiple modifications can be made before they are applied to the unit. While inside the shell mode, type "help" key to get a more detailed help.

* To launch the tool in shell mode :

```
tbconfig --shell
```

<br>

### Command line mode

This mode allows to export or import configurations to/from files. It also allows to instantly modify values.

* To use the tool in command line mode :

```
tbconfig [args]
```

* To get detailed commands examples :

```
tbconfig --help
```

<br>

### Additional arguments

By default, tbconfig sends HTTP requests to the [web server](/appendices/appendix-a-glossary/glossary-toolpack/glossary-web-server.md) using 127.0.0.1:12358 with root/root as the username and password.\
This can be changed using the following arguments:

```
-h       : [host] Host to connect to (IP address or domain name)
--port    : [port] Port to use for connecting to HTTP server 
-u       : [user] User name to use for connecting to HTTP server
-p       : [pass] Password to use for connecting to HTTP server
-s       : [HTTPS] to connect using HTTPS 
```

For example, if the TMG’s web server has been reconfigured to use HTTPS on port 443 and you want to log with user my\_username and password my\_secret\_password, tbconfig should be invoked using the following parameters:

```
tbconfig --port 443 -s HTTPS -u my_username -p my_secret_password
```

Unix environment variables can be set to avoid adding those parameters every time.

```
TBCONFIG_HOST	 : Replaces -h
TBCONFIG_PORT	 : Replaces --port
TBCONFIG_USER	 : Replaces -u  
TBCONFIG_PASS	 : Replaces –p
TBCONFIG_SCHEME  : Replaces -s
```

### Use cases

* [Exporting a configuration](/tools-tips-and-tricks/restful-api/tbconfig-examples/exporting-a-configuration.md)
* [Importing a configuration](/tools-tips-and-tricks/restful-api/tbconfig-examples/importing-a-configuration.md)
* [Activating a configuration](/tools-tips-and-tricks/restful-api/tbconfig-examples/activating-a-configuration.md)
* [Updating a static route](/tools-tips-and-tricks/restful-api/tbconfig-examples/updating-a-route.md)


---

# Agent Instructions: 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:

```
GET https://prosbcdocs.telcobridges.com/tools-tips-and-tricks/restful-api/tbconfig-examples.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.