Devices Module

Device List

It is used to add devices to the database and group them according to the selected attribute. Further, when using other modules of mupsbox, we will work with groups of devices.

On the Device List tab, there are buttons (from left to right):

• - Add device
  
• - Remove device
  
• - Enable device
  
• - Disable device
  
• - Device settings
  
• - Start winbox
  
• - Start ssh
  
• - Refresh
  
• - Check the availability of a dedicated device
  
• - Check the availability of all devices
  
• - Kill threads
  
• - Export the list of devices (including their data, such as un, login, password, etc.)
  
• - Import the list of all devices (including their data, such as un, login, password, etc.)
  
• - Update the ROS version
  
• - Upgrade the BIOS
  
• - Send a command to the selected device
  
• - Export the visible list of devices in Excel
  
• - Geolocation by coordinates
  

Add device

To add a device, press , a window will appear where you need to enter device data.

• Hostname - Any convenient device name.
  
• Host IP - Device IP address.
  
• Use default port - Your api or api-ssl port that you opened on RouterOS.
  
• Username - Username to login to device.
  
• Password - Password to login to device.
  
• Winbox port - Your winbox port, which you registered in Ip -> Services
  
• SSH port - Your ssh port, which you registered in Ip -> Services
  
• FTP port - Your ftp port, which you registered in Ip -> Services
  
• Telnet port - Your telnet port, which you registered in Ip -> Services
  
• Version package channel - Your version package channel on royter
  
• Join in group - Select the groups to which the device will belong.
  
• Available groups - Existing groups created in the Groups tab.
  
• Add device - After entering all the data, click the add device button. All data will be applied and you will see your device in the device list.
  
• Copy - If you have many devices with the same data, and differ only in Hostname and IP address, use the copy button to speed up the process of making devices.
  
• Comment - Comment on the device.
  

Export and import devices

To export all devices with their data, click the button. A confirmation window will appear.

If you want to export all data including passwords, click yes. If you want to export all data without passwords, click no. (All passwords in the program are encrypted.)

To import all devices with their data, click the button. A confirmation window will appear.

If your file contains encrypted passwords, click yes; otherwise, click no.

Command line

To send a ROS command to a specific router, select the router using the navigation keys or click on it with the mouse and click the button. The following window will appear:

Enter the command in the field and click Enter. Don`t use SSL checkbox is used to ignore the API-SSL port and send commands on the API port.

If you entered several commands in a row, you can navigate between them using the up and down arrows

Also, you can load the RSC file with the settings. Select the file by clicking .. and press the GO button

Working with device lists and filtering

If you have a lot of devices and you need to filter the device (s) by a specific attribute (Hostname, IP address, board-name, etc.), start typing this character in the Search field.

Having sorted the devices by a certain attribute, you can export the sorted list to Excel by pressing the button.

To filter devices by groups, check the box to use group filtering. To select filtering conditions by group, click the Select groups button. The following window will appear:

Check the box next to the group (s) you want to display. If you check a NOT IN, it will show all devices that are not included in the marked group.

To navigate through the devices, you can use the up and down navigation keys. Clicking Enter on the selected device opens a window with its data. Clicking delete the program will prompt you to delete the selected device or selected devices. To select devices, use shift and ctrl keys. You can select devices with the left mouse button, deselect with the right.

Customize Device List

To turn off unnecessary columns, click the down arrow next to the hostname column. As shown in the picture below. Use the mouse to select the columns you want to disable or enable for viewing.

Customize Device List

Add device from Net

Search and add Mikrotik devices in automatic mode.

Add device from Net

• IP - subnet.
  
• Prefix - Mask.
  
• Username - Username to login to device.
  
• Password - Password to login to device.
  
• Port - Your api or api-ssl port that you opened on RouterOS.
  
• New Group - Create new group.
  
• Ignore check host ID - If you have several IP addresses on your device and you do not want to add them all, check the box and the program will check the software id and not add the same router.
  
• Filtre - You can scan devices into specific groups from the entire network using the filter by board name or model.
  
• Group name - Select the group to which devices will be added.
  

Groups

This tab is intended for creating groups, sending commands to a group of devices and for modifying the data of a group of devices in the device list.

Add group

To add a group, click the button and the following window will appear:

• Name - Any convenient group name.
  
• Description - Group description.
  

Remove group

To remove a group, click the button. A query will appear:

Click Yes to delete or No to cancel.

Command line

To send a ROS command to a group of devices, select the group using the navigation keys or click on it with the mouse and click the button. The following window will appear:

Enter the command in the field and click Enter. Don`t use SSL checkbox is used to ignore the API-SSL port and send commands on the API port.

If you entered several commands in a row, you can navigate between them using the up and down arrows

Command line (API samples)

Using api - you get feedback. This is very important because you will always know if the command was executed successfully. Also, you get the opportunity to build reports using API: request->response. Here are some examples.

add new user

/user/add
=name=username
=group=full
=password=userpassword
=comment=this is new user

remove user

/user/remove
=.id=username

on which router is the user 'admin'?

/user/print
?name=admin
mbcount==1

on which router firewall is not configured, for example, rules < 3 ?

/ip/firewall/filter/print
mbcount=<3

disable all rules in /ip/firewall/filter where chain=input and action=drop

/ip/firewall/filter/disable
?chain=input
?action=drop
?#&
mbgetid

Notice: mbcount - proproetary function mupsbox, gets counts data replies (!re).

Settings for groups

When you need to change data such as login, password, port, type of port for a group of devices, click on the button. The following window will appear:

Settings for groups

Enter the new data and tick the changes that you want to apply for the selected group of devices. Click OK and in the device settings for the selected group the data that you noted will change.

Pooling jobs

This tab is intended for to create tasks for testing the availability of devices by groups.

Pooling jobs

Add job

To add a group, click the button and the following window will appear:

• Job Name - Any convenient job name.
  
• Group Name - Select group.
  
• Period type - Select verification period.
  
• GPS - Take GPS coordinates.
  
• Description - Comment or description for the job.
  

Nix device List

It is used to add Nix devices to the database. Further, when using other modules of mupsbox.

On the Nix device List tab, there are buttons (from left to right):

• - Add device
  
• - Remove device
  
• - Enable device
  
• - Disable device
  
• - Start ssh
  
• - Refresh
  
• - Check the availability of a dedicated device
  
• - Check the availability of all devices
  

Add nix device

To add a device, press , a window will appear where you need to enter device data.

• Hostname - Any convenient device name.
  
• Host IP - Device IP address.
  
• Username - Username to login to device.
  
• Password - Password to login to device.
  
• SSH port - Your ssh port, which you registered in Ip -> Services
  
• FTP port - Your ftp port, which you registered in Ip -> Services
  
• Add device - After entering all the data, click the add device button. All data will be applied and you will see your device in the device list.
  
• Copy - If you have many devices with the same data, and differ only in Hostname and IP address, use the copy button to speed up the process of making devices.