User Manual

Topology Editor

The topology editor is a graphical web-based tool to design and control your topology. It is the only way to access topologies in the webfrontend.

You must enable JavaScript for the editor to work.

The editor consists of two main parts: The menu and the workspace: editor overview

The Menu

The menu allows you to control the topology and add new elements to it. It consists of five main tabs, each of which will be discussed here:

Home

The home tab contains the mostly used tools:

  • Modes selects the mode. This is important since this defines what a left-click will do in the workspace. One of these tools is always active. You can see which mode is active either on these buttons, or on your cursor when hovering over an element.
    • Select & Move: This tool allows you to move elements via drag&drop on the workspace.
    • Connect: This tool allows you to connect elements. When the tool is active, click on one element and then on a second one to connect them. To cancel the operation after the first click, click on the same element again.
    • Delete: This will delete elements with one click. Caution!
  • Topology control contains the most important element actions. These actions will be conducted on all elements where it is possible.
  • Common elements contains the most important elements from the Devices and Network tabs.

Devices

The devices tab contains most templates for device elements. You can add a device to your topology by clicking on one of the buttons there, and then clicking on the target position on the workspace.

There are special Upload own image devices. These are devices which will be prepared directly, and you will be prompted to upload your own custom image directly.

Network

The network tab contains the remaining devices, as well as external networks.

Topology

The topology tab contains topology control functions:

  • Consoles (NoVNC) opens a window containing all consoles of all devices.
  • Notes opens a window where users can add notes. The notes window can be configured to automatically open when loading the editor.
  • Resource usage shows quota statistics for the topology.
  • Renew allows you to renew your topology to avoid a topology timeout
  • Rename allows you to change the name of your topology
  • Export can export your topology
  • Delete will remove your topology.
  • Users & Permissions opens the permissions window.

Note that Delete will destroy all elements in a topology, meaning you will lose all respective data!

Options

The options tab contains multiple options that change the editor’s behavior:

  • Topology are topology-specific settings which are synchronized between all its users.
  • User contains user-specific settings which are synchronized between all topologies, but different for each user.

The options are in detail:

  • Safe mode: Ask before performing destructive actions (stop, destroy, remove)
  • Snap to grid: Elements will use a grid for positioning - this creates a more ordered topology
  • Fixed positions: Prevents the user from moving elements
  • Big workspace: Increases the size of the workspace. The distances between elements will be adapted when resizing. This requires a reload of the topology.
  • Colorify segments: Colorify connections based on network segments
  • Show IDs: Show element and connection IDs in their right-click menus. This is useful when accessing the topology from the API.
  • Show element sites: Show elements’ sites in their right-click menu.
  • Debug mode: Show a debug menu entry in every right-click menu which grants access to the API info result. Useful when accessing the topology from the API.
  • Show connection controls: Show interface elements and the connection handle. This should always be active, but disabling it will result in better-looking screenshots.

Although topologies can be shared between users, the editor should not be used by multiple users at once when modifying a topology or running element actions.

The Workspace

The workspace is the place where you design your topology. It shows elements and their connections. Please refer to the individual manual pages to learn how to control and manipulate elements and connections.

Topology Right-Click Menu

When you right-click on any white space in the topology, you can open a right-click menu which gives you quick access to the most important functions from the menu.