Toolpack Application:tbconfig - Revision history

Luc Morissette: Added new use case

2019-05-10T15:43:56Z

Added new use case

Abrassard: /* Additional arguments */

2018-11-07T18:20:37Z

Additional arguments

Abrassard: Improving doc for HTTPS

2018-11-07T18:20:23Z

Improving doc for HTTPS

Luc Morissette: LM Added the -s option

2018-11-07T17:55:51Z

LM Added the -s option

Manon Bélanger: /* Additional arguments */

2016-01-13T13:32:43Z

Additional arguments

Manon Bélanger: Adding arguments and links to use cases

2015-10-13T19:35:16Z

Adding arguments and links to use cases

Manon Bélanger: First version of the page

2015-10-13T14:57:23Z

First version of the page

New page

== 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.

== 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

== 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

== 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

← Older revision		Revision as of 15:43, 10 May 2019
Line 46:		Line 46:
	* [[RESTful_API:_Importing_a_configuration\|Importing a configuration]]		* [[RESTful_API:_Importing_a_configuration\|Importing a configuration]]
	* [[RESTful_API:_Activating_a_configuration\|Activating a configuration]]		* [[RESTful_API:_Activating_a_configuration\|Activating a configuration]]
		+	* [[RESTful_API:_Updating_a_Route\|Updating a static route]]

@@ Line 40: / Line 40: @@
   TBCONFIG_USER	 : Replaces -u
   TBCONFIG_PASS	 : Replaces –p
-  TBCONFIG_SCHEME : Replaces -s
+  TBCONFIG_SCHEME  : Replaces -s
 == Use cases ==

@@ Line 32: / Line 32: @@
   -s       : [HTTPS] to connect using HTTPS
-For example, if the TMG’s web server has been reconfigured to use port 80 and you want to log with user my_username and password my_secret_password, tbconfig should be invoked using the following parameters:
+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 80 -u my_username -p my_secret_password
+  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_HOST	 : Replaces -h
-  TBCONFIG_PORT	: Replaces --port
+  TBCONFIG_PORT	 : Replaces --port
-  TBCONFIG_USER	: Replaces -u
+  TBCONFIG_USER	 : Replaces -u
-  TBCONFIG_PASS	: Replaces –p
+  TBCONFIG_PASS	 : Replaces –p
 == Use cases ==

@@ Line 30: / Line 30: @@
   -u       : [user] User name to use for connecting to HTTP server
   -p       : [pass] Password to use for connecting to HTTP server
 For example, if the TMG’s web server has been reconfigured to use port 80 and you want to log with user my_username and password my_secret_password, tbconfig should be invoked using the following parameters:

@@ Line 27: / Line 27: @@
 <br>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
+  --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
 For example, if the TMG’s web server has been reconfigured to use port 80 and you want to log with user my_username and password my_secret_password, tbconfig should be invoked using the following parameters:
-  tbconfig -port 80 -u my_username -p my_secret_password
+  tbconfig --port 80 -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_PORT	: Replaces --port
   TBCONFIG_USER	: Replaces -u
   TBCONFIG_PASS	: Replaces –p
 == Use cases ==

← Older revision		Revision as of 19:35, 13 October 2015
Line 21:		Line 21:
	*'''To get detailed commands examples :'''		*'''To get detailed commands examples :'''
	tbconfig --help		tbconfig --help
		+
		+
		+	== Additional arguments ==
		+	By default, tbconfig sends HTTP requests to the [[Toolpack_Application:web_server\|web server]] using 127.0.0.1:12358 with root/root as the username and password.
		+	<br>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
		+
		+	For example, if the TMG’s web server has been reconfigured to use port 80 and you want to log with user my_username and password my_secret_password, tbconfig should be invoked using the following parameters:
		+	tbconfig -port 80 -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
		+
		+
		+	== Use cases ==
		+	* [[RESTful_API:_Exporting_a_configuration\|Exporting a configuration]]
		+	* [[RESTful_API:_Importing_a_configuration\|Importing a configuration]]
		+	* [[RESTful_API:_Activating_a_configuration\|Activating a configuration]]