==========
Setting Up
==========

Setting up an OSDx system is a 3-step process:

#. **Installing**: Install OSDx on the target system.
#. **Licensing**: Enable features using Teldat-provided licenses.
#. **Verifying**: Check OSDx and license are ready to go.

Installing
==========

Windbit devices come with OSDx pre-installed, but it is possible to run OSDx in other
environments which may require the user to perform the installation. The following
step-by-step guides show how to install OSDx in supported environments:

.. toctree::
   :maxdepth: 1
   :glob:

   installing/*/index

.. note::

   While OSDx may run in other environments, they are **not officially supported**.

Licensing
=========

OSDx products include a licensing mechanism. Depending on the active license, some
features and functionalities may or may not be available. Contact Teldat's support team
to obtain a license. Once you have one you can proceed to the
:doc:`/intro/licensing` chapter.

Verifying
=========

This section describes the items that need to be checked to ensure the installation and
licensing were performed correctly.

Version
-------

The :osdx:op:`show version` command shows attributes about the installed software as
well as the hardware it is running on.

*Example:*

.. code-block:: none

  admin@osdx$ show version

    OS vendor:                  Teldat
    OS name:                    OSDx
    OS version:                 v3.1.1.1
    OS Linux kernel:            4.19.181
    OS built by:                jenkins@daphne
    OS build date:              Mon Sep 20 11:56:22 UTC 2021
    OS installation:            physical
    OS boot mode:               user
    License:                    BASE N-Cores-1

    Hardware vendor:            innotek GmbH
    Hardware model:             SDE
    Hardware OEM model:         VirtualBox
    Hardware version:           1.2
    Hardware S/N:               0
    Hardware UUID:              d45cddc3-ecc6-5776-877e-87749826dc82
    Hardware architecture:      amd64
    Hardware fwid:              iso
    Hardware base MAC:          08:00:27:fc:9d:2c
    Hardware cpu:               1 x Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz (4 cores)

    Last reboot reason:         Performed by user

    Date:                       Tue 21 Sep 2021 11:16:00 AM UTC
    Uptime:                     3:12:01
    CPU load (1m, 5m, 15m):     0.00 0.00 0.00
    CPU usage % (1m):           0.62
    Storage usage (kB):         589868/20501072
    Memory usage (kB):          297480/2042816
    Temperature (ºC):           0
    Users logged in:            0
    Mode (current/next boot):   user/user

    Hostname:                   osdx

In particular, the ``OS Version`` field contains the OSDx version currently running on
the device.

Interfaces
----------

In order to ensure that the hardware's network interfaces are detected correctly, use
the :osdx:op:`interfaces show detailed` command.

.. code-block:: none

  admin@osdx$ interfaces show detail

    ----------------------------------------------------------------------------------------------------------------
    Name  Idx           IP Adress           Admin  Oper  Link   MTU   Vrf  Upper  Lower    Type        Phys addr
    ----------------------------------------------------------------------------------------------------------------
    eth0  2    10.0.0.1/24                  up     up    up     1500                     ethernet  08:00:27:fc:9d:2c
            fe80::a00:27ff:fefc:9d2c/64
    eth1  3                                 down   down  down   1500                     ethernet  08:00:27:ab:91:1f
    eth2  4                                 down   down  down   1500                     ethernet  08:00:27:ae:cb:70
    eth3  5    192.168.213.18/22            up     up    up     1500                     ethernet  08:00:27:10:c0:b0
            fe80::a00:27ff:fe10:c0b0/64
    lo  1    127.0.0.1/8                  up     up    up    65536                     loopback  00:00:00:00:00:00
            ::1/128

License
-------

To check the features enabled with the installed license run :osdx:op:`license show`.

*Example:*

.. code-block:: none

   admin@osdx$ license show
   License: RS420_BASE CELL DPI RD-ETSI WLAN

   +--------------+----------+----------+
   | License Item | Status   | Validity |
   +--------------+----------+----------+
   | CELL         | Enabled  | Forever  |
   | DPI          | Enabled  | Forever  |
   | RD-ETSI      | Enabled  | Forever  |
   | RD-FCC       | Disabled | -        |
   | RD-NOM       | Disabled | -        |
   | RD-ROW       | Disabled | -        |
   | WLAN         | Enabled  | Forever  |
   +--------------+----------+----------+