KeexyBox's wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== KeexyBox - Manage devices ======

For KeexyBox, a device is a hardware that can have a connectivity to the Internet. It can be a PC, smartphone, tablet, IP Camera, Smart TV or a voice assistant.

:!: **Since version 21.04.1, you can avoid registering your devices in KeexyBox to connect them to the internet. You just need to set ''Internet access conditions'' to ''None'' in the [[system_settings_captiveportal|captive portal]] settings.** :!:

To manage devices:

  - Use your browser and connect to the [[using_admin_access|KeexyBox Management Web interface]].
  - On left menu, go to ''Connection settings -> Devices''.
  - You will be redirected to the ''Devices'' page.
===== Declare devices of your network to KeexyBox =====

You will need to declare your devices in the following cases :

  * Your devices does not allow you to enter a login and password in a browser to connect it to the Internet (IP camera, TV, voice assistant...).
  * You don't want to bother entering a login and password on the [[using_connect|captive portal]] to connect your PCs or smartphones to the Internet.
  * You want to set a DHCP IP address reservation for your device.
  * If the captive portal is disable (''Internet access conditions'' set to ''None'' in the [[system_settings_captiveportal|captive portal]] settings) and the device must use a profile other than the one defined by default for the whole network. 

There are 2 ways to declare devices to KeexyBox:
  * Manually.
  * By scanning your network.

=== Add devices manually ===

  - Click on {{:keexybox_ico:plus.png?nolink}} at the top of ''Devices'' page.
  - [[#Edit a device|Edit the device settings]].
  - Click ''Save''.

=== Add devices by scanning your network ===

It an easier and faster method than the manual to declare your devices. Before, you must ensure that all the devices to be declared are powered on and connected to the same physical network as KeexyBox. Then follow this steps to add your devices:

  - Click on {{:keexybox_ico:search.png?nolink}} at the top of ''Devices'' page (This may take time depending on the size of your network).
  - You will get a list of devices found on your network.
  - The device brand ''Name'' and the ''IP address'' can help you recognize your devices.
  - Check boxes to the left of ''IP address'' (If you are not able to check the box, that means the device is already declared to KeexyBox).
  - At the bottom of the page, in the selection menu ''(select profile)'', select the profile you want to set for devices.
  - Click on ''Add devices'' to confirm the action.

The devices will be automatically named using the brand name and part of the MAC address. You can change the name of the devices at anytime by modifying the device.

:!: **Declaring devices will not connect them to the Internet.**

===== Connect a device to the Internet =====

Follow the instructions described on this [[using_connect_devices|topic]] to connect one or more devices to the Internet.

===== Modify a device =====

  - On the ''Devices'' page, identify in the list the device you wish to modify.
  - Click on ''Edit'' {{:keexybox_ico:edit.png?nolink}} button. 
  - [[#Edit a device|Edit the device settings]].
  - Click ''Save''.

===== Edit a device =====

^Field^Description^
|**Name**|The device name.|
|**MAC address**|It is an unique identifier assigned to a network device. This address is used by KeexyBox to recognize the device on the network. Most of time it is written down directly on the device.|
|**Profile**|Select the connection [[profiles_manage|profile]].|
|**Language**|Select the language displayed on KeexyBox Web interface for the user who use the device.|
|**DHCP reservation IP address (optional)**|If [[system_settings_dhcp#dhcp_reservation|DHCP]] is enabled on your KeexyBox, you can reserve an IP address for it in one of the KeexyBox networks.|
|**Enable**|Check to allow connection of the device to the Internet.|

===== Delete a device =====

  - On the ''Devices'' page, identify in the list the device you wish to delete.
  - Click on ''delete'' {{:keexybox_ico:trash.png?nolink}} button.
  - You will get a message asking you to confirm the deletion. Answer ''yes''.

Connected device will be disconnected and next be deleted.

===== Export/Import devices =====

KeexyBox allows you to export or import devices from CSV files. Exporting or Importing devices can be useful in the following cases:
  * To backup the list of KeexyBox devices.
  * To massively declare devices.
  * To do massive modifications on devices.
  * To import devices to another KeexyBox.

=== Export devices to CSV file ===

  - Click on {{:keexybox_ico:export.png?nolink}} at the top of ''Devices'' page.
  - Save the file wherever you want on your computer.

=== Import devices from CSV file ===

You must first prepare a CSV file containing the list of devices. We recommend that you export the list of KeexyBox devices in order to have a template for creating the import file.

The field of the CSV file are described below.

^Field^Description^
|**devicename'**|The device name. If a device has the same name in KeexyBox, all settings will be overwritten with the values from the CSV file.|
|**mac**|It is a unique identifier assigned to a network device. This address is used by KeexyBox to recognize the device on the network. Most of time it is written down directly on the device.|
|**dhcp_reservation_ip**|The reserved IP address for DHCP.|
|**profilename**|The name of the profile. If the profile does not exist on KeexyBox, the user will be set to the default profile.|
|**lang**|The language displayed on KeexyBox Web interface for the user who use the device. If the language is unknown by KeexyBox the default KeexyBox langage will be set.|
|**enabled**|''1'' to enable the device, ''0'' or empty to disable it.|


:!: Do not change the position of the fields.

When your file is ready: 

  - Click on {{:keexybox_ico:import.png?nolink}} at the top of ''Devices'' page.
  - On ''Select csv file'' click on ''Browse''.
  - Select the CSV file to import.
  - Click on ''Save''.


===== Bulk actions =====

Bulk actions allows you to massively doing actions on devices. On the ''Devices'' page:

  - Check boxes to the left of listed devices.
  - At the bottom of the page, on the selection menu ''(select action)'', choose one of the available actions.
  - Click on ''Run'' to confirm the action.

The available actions are discribed below:
  * ''Connect'': This action allows you to connect multiples devices to the Internet as decribed on this [[using_connect_devices|topic]].
  * ''Disable'': This action allows to prevent connecting devices to the Internet.
  * ''Enable'': This action allows you to allow connecting devices to the Internet.
  * ''Change the profile'': This action allows you to change the profile of selected devices.
  * ''Delete'': This action allows you to delete selected devices.