===========
Quick Start
===========

This chapter will guide you on how to start using your new OSDx system.
It will also demonstrate how to configure two Ethernet interfaces and
some useful services and protocols, such as DNS, DHCP or SSH.

CLI Access
----------

OSDx CLI can be accessed through different interfaces. Commands are available
regardless of the interface used.

Local access via physical interfaces, if present:

  * Keyboard and monitor.
  * Serial port.

Remote access via IP connectivity.

  * Telnet.
  * SSH.

Basic IP connectivity must be in place to remotely connect through Telnet or SSH.
For this option to work, the product must have default IP configuration as a
factory setting or a local CLI access.


Login and default user
----------------------

After connecting to the CLI through an interface, the first step is to login with a
user and password. If a product does not have a specific factory default user and
password, the default user and password to be used in OSDx are ``admin``.

After a successful login, a welcome banner appears and the operational menu prompt is
shown (``<user>@<hostname>$``). The operating menu has commands that perform operational
tasks and show the system status.


CLI usage
---------

It is advisable to review both :ref:`intro/cli:Operational Mode` and
:ref:`intro/cli:Configuration Mode` before reading the following sections of this
chapter.


Basic configuration
-------------------

The following sub-section will demonstrate how to configure a very basic configuration
example with two Ethernet interfaces and some useful services and protocols, such as DNS,
DHCP or SSH.


Interface configuration
~~~~~~~~~~~~~~~~~~~~~~~

* Your outside/WAN interface will be ``eth0``. It will receive its interface
  address via DHCP.
* Your internal/LAN interface will be ``eth1``. It will use a static IP address:
  ``192.168.0.1/24``.

After switching to configuration mode, issue the following
commands:

.. code-block:: none

  set interfaces ethernet eth0 address dhcp
  set interfaces ethernet eth0 description WANSIDE
  set interfaces ethernet eth1 address 192.168.0.1/24
  set interfaces ethernet eth1 description LANSIDE
  commit


SSH configuration
~~~~~~~~~~~~~~~~~

After switching to configuration mode, issue the following
commands and your system will listen on every interface for incoming SSH
connections:

.. code-block:: none

  set service ssh
  commit

DHCP configuration
~~~~~~~~~~~~~~~~~~

The following settings will configure the DHCP service on your internal/LAN
network:

  * The default gateway address will be ``192.168.0.1/24``.
  * The address range ``192.168.0.2/24 - 192.168.0.8/24`` will be reserved
    for static assignments. DHCP clients will be assigned IP addresses within
    the range of ``192.168.0.9 - 192.168.0.254``.
  * Hosts are allowed to use assigned IP addresses for 24 hours (*lease-time*).

.. code-block:: none

  set service dhcp-server shared-network LAN subnet 192.168.0.0/24 start 192.168.0.9 stop 192.168.0.254
  set service dhcp-server shared-network LAN subnet 192.168.0.0/24 options default-router 192.168.0.1
  set service dhcp-server shared-network LAN subnet 192.168.0.0/24 options domain-name osdx.net
  set service dhcp-server shared-network LAN subnet 192.168.0.0/24 options lease 86400
  commit


DNS configuration
~~~~~~~~~~~~~~~~~

The following settings will enable DNS servers received from DHCP:

.. code-block:: none

  set service dns resolver dhcp
  commit


NAT configuration
~~~~~~~~~~~~~~~~~

The following settings will configure SNAT (Source Network Address Translation)
rules for our internal/LAN network, allowing hosts to communicate through the
outside/WAN network via IP masquerade.

.. code-block:: none

  set interfaces ethernet eth0 traffic nat source rule 1 address masquerade
  commit

Login configuration
~~~~~~~~~~~~~~~~~~~

There is an additional configuration step that should be taken, especially if you are allowing SSH remote access from the outside/WAN
interface:

.. code-block:: none

  set system login user admin authentication plaintext-password mysecurepassword
  commit

This will change the default admin password to ``mysecurepassword``.