From 9ea258cf6f6064296ef4bdb0c17e77c3270351b5 Mon Sep 17 00:00:00 2001 From: Udo Walter Date: Mon, 22 Jul 2019 16:28:40 +0000 Subject: [documentation] add groups/clients module documentation --- documentation/webapp/modules.md | 49 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) (limited to 'documentation/webapp') diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md index 459e972..883b781 100644 --- a/documentation/webapp/modules.md +++ b/documentation/webapp/modules.md @@ -1,6 +1,53 @@ # Modules -## Group / Clients +## Groups / Clients + +BAS Groups and Clients + +Listed in the home view of the "Groups / Clients" module, accessible by the home icon in the top left 1, +are all groups and clients that have no parent group. +The data can be refreshed without reloading the page by clicking on the refresh button in the top right corner 2. + +Enabling the "All" switch 3 shows all groups and clients instead of top-level groups and clients only. +This switch also works in a group to show all subgroups and clients within this group instead of direct children only. + +::: tip +By clicking on the collapse button 5 the view can be switched from column to tabbed. +::: + +To naviate to a group or client click on the arrow on the right 4 or double click the row. + +### Subgroup / Client + +BAS Groups and Clients + +After naviating to a group or client general information about this group/client is displayed at the top. +The information can be edited by clicking on edit button 1. +In edit mode this button is replaced with a save button to confirm the changes. + +The group or client can be deleted by pressing the delete button 2. + +### Tables with Groups and Clients + +In the home view and in a group the groups and clients are displayed in two tables. +By clicking the checkbox on the left (or anywhere on the row) a group/client can be selected. +Below these tables are buttons for additional actions. + +Home view: +* CREATE GROUP - Create a new group +* CREATE CLIENT - Create a new client +* DELETE X GROUPS - Permanently delete the selected groups +* DELETE X CLIENTS - Permanently delete the selected clients + +Group view: +* ADD SUBGROUPS - Add already existing groups to this group +* ADD CLIENTS - Add already existing clients to this group +* REMOVE X SUBGROUPS - Remove the selected groups from this group (Does not permanently delete the groups) +* REMOVE X CLIENTS - Remove the selected clients from this group (Does not permanently delete the clients) + +Both: +* WAKE X CLIENTS UP - Start the selected clients via Wake On Lan (Experimental feature: Does not work on all clients) + ## IP Ranges ## iPXE Configurator ## Event Manager -- cgit v1.2.3-55-g7522