Skip to content

Quick Start JavaFX Tool

AndreKutzleb edited this page Nov 10, 2015 · 1 revision

We provide an still experimental start-up tool with which you can easily start and stop instances of ZSDN modules. You can find the executable under "util/startup-selector/target". Once the program is started you should see the UI with the following functions:

ZeroSDN StartUpSelector initial screen

1. Load Modules
Here you can specify a path to a folder from which then all executables of ZSDN Modules are loaded into the application recursively (lists also modules in subdirectories).

2. Add
If you click the button 'add' you also have the possibility to add another module to the list manually. You need to add the additional information, e.g. path to the module, on your own. For details see also how to edit an existing module.

ZeroSDN StartUpSelector initial screen

3. Edit
In the picture above you can see the windows that appears if you want to edit existing module. It looks the same if you want to add a new one. As you can see you can add/change here the following configurations:

  • Module Name: The name the module should carry, for example 'SwitchAdapter'.
  • Description: Here you may add a description of this module that is displayed in the tool afterwards.
  • Path: The path to the folder containing the compiled executable of the module. If you add modules via 'Load Modules', this is filled in automatically.
  • Config File: Every modules needs a config text file which contains the specified configuration the module should be started with. You can find a default config file under "/ZSDN-Controller/config/default.config".
  • Additional Parameters: Your module may need to be started with some additional parameters. You can add theme here, each separated by ' '(space). If you wish no additional parameters, you can leave this field empty.

4. Remove
Here you can remove an existing module from the list.

5. Start All
Press this button to start all modules that are currently in the list. If starting was successful, they will change their state from 'Stopped' to 'Running'.

6. Stop All
This shuts down every module that is currently running. Their state should then change from 'Running' to 'Stopped'.

7. Start
This starts the specific module that you have selected from the list on the left side. Once it is running, you can see it's console- and logging output in the area above.

8. Stop
This shuts down the selected module. You should see a message in the output area that the module has been stopped after you pressed this button.

Saving the list
Additionally you can save the current module list over the File menu on top. It will be saved as an xml file which can be loaded again the next time you start the application.

How to create a module list:

  • Click on "Load Modules" and select a directory containing the modules.
  • Then select the modules in the module list on the left side.
  • Click on "edit"
  • You need to select a config file in order to run a module. We provide a example config file under "/examples/example-configs/zmf_module.config"
  • If needed, also add parameters separated by a blank (e.g. for SwitchAdapter "1.3 6633" for OpenFlow version and port)
  • If you selected a config file and possible parameters, you now can start the module
  • You can also save the created module list by clicking on "File" at the menu bar. You then can save it as a .xml file

Clone this wiki locally