mirror of
https://github.com/vyos/vyos-documentation.git
synced 2025-10-26 08:41:46 +01:00
6aa3cbb611
This will add proper new-lines into the rendered PDF. Before if it has been a long line, not all content was preserved in the PDF.
176 lines
3.5 KiB
ReStructuredText
176 lines
3.5 KiB
ReStructuredText
.. _host-information:
|
|
|
|
Host Information
|
|
----------------
|
|
|
|
This section describes the system's host information and how to configure them,
|
|
it covers the following topics:
|
|
|
|
* Host name
|
|
* Domain
|
|
* IP address
|
|
* Default gateway
|
|
* Aliases
|
|
|
|
Host Name
|
|
^^^^^^^^^
|
|
|
|
A hostname is the label (name) assigned to a network device (a host) on a
|
|
network and is used to distinguish one device from another on specific networks
|
|
or over the internet.
|
|
|
|
Set a system host name:
|
|
|
|
.. code-block:: console
|
|
|
|
set system host-name <hostname>
|
|
|
|
.. note:: Only letters, numbers and hyphens are allowed.
|
|
|
|
Show host name:
|
|
|
|
.. code-block:: console
|
|
|
|
show system host-name
|
|
|
|
Delete host name:
|
|
|
|
.. code-block:: console
|
|
|
|
delete system host-name <hostname>
|
|
|
|
Example: Set system hostname to 'RT01':
|
|
|
|
.. code-block:: console
|
|
|
|
set system host-name RT01
|
|
commit
|
|
show system host-name
|
|
host-name RT01
|
|
|
|
Domain Name
|
|
^^^^^^^^^^^
|
|
|
|
A domain name is the label (name) assigned to a computer network and is thus
|
|
unique.
|
|
|
|
Set the system's domain:
|
|
|
|
.. code-block:: console
|
|
|
|
set system domain-name <domain>
|
|
|
|
.. note:: Only letters, numbers, hyphens and periods are allowed.
|
|
|
|
Show domain:
|
|
|
|
.. code-block:: console
|
|
|
|
show system domain-name
|
|
|
|
Remove domain name:
|
|
|
|
.. code-block:: console
|
|
|
|
set system delete domain-name <domain>
|
|
|
|
Example: Set system domain to example.com:
|
|
|
|
.. code-block:: console
|
|
|
|
set system domain-name example.com
|
|
commit
|
|
show system domain-name
|
|
domain-name example.com
|
|
|
|
Static host mappings
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
How to assign IPs to interfaces is described in chapter
|
|
:ref:`interfaces-addresses`. This section shows how to statically map a system
|
|
IP to its host name for local (meaning on this VyOS instance) DNS resolution:
|
|
|
|
.. code-block:: console
|
|
|
|
set system static-host-mapping host-name <hostname> inet <IP address>
|
|
|
|
Show static mapping:
|
|
|
|
.. code-block:: console
|
|
|
|
show system static-host-mapping
|
|
|
|
Example: Create a static mapping between the system's hostname `RT01` and
|
|
IP address `10.20.30.41`:
|
|
|
|
.. code-block:: console
|
|
|
|
set system static-host-mapping host-name RT01 inet 10.20.30.41
|
|
commit
|
|
show system static-host-mapping
|
|
host-name RT01 {
|
|
inet 10.20.30.41
|
|
}
|
|
|
|
Aliases
|
|
*******
|
|
|
|
One or more system aliases (static mappings) can be defined:
|
|
|
|
.. code-block:: console
|
|
|
|
set system static-host-mapping host-name <hostname> alias <alias>
|
|
|
|
Show aliases:
|
|
|
|
.. code-block:: console
|
|
|
|
show system static-mapping
|
|
|
|
Delete alias:
|
|
|
|
.. code-block:: console
|
|
|
|
delete system static-host-mapping host-name <hostname> alias <alias>
|
|
|
|
Example: Set alias `router1` for system with hostname `RT01`:
|
|
|
|
.. code-block:: console
|
|
|
|
set system static-host-mapping host-name RT01 alias router1
|
|
commit
|
|
show system static-host-mapping
|
|
host-name RT01 {
|
|
alias router1
|
|
inet 10.20.30.41
|
|
}
|
|
|
|
Default Gateway/Route
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
In the past (VyOS 1.1.8) used a gateway-address configured in the system tree
|
|
(`set system gateway-address <IP address>`) this is no longer supported and
|
|
existing configurations are migrated to the new CLI commands.
|
|
|
|
It is replaced by inserting a static route into the routing table using:
|
|
|
|
.. code-block:: console
|
|
|
|
set protocols static route 0.0.0.0/0 next-hop <gateway ip>
|
|
|
|
Delete the default route from the system
|
|
|
|
.. code-block:: console
|
|
|
|
delete protocols static route 0.0.0.0/0
|
|
|
|
Show default route:
|
|
|
|
.. code-block:: console
|
|
|
|
vyos@vyos$ show ip route 0.0.0.0
|
|
Routing entry for 0.0.0.0/0
|
|
Known via "static", distance 1, metric 0, best
|
|
Last update 3d00h23m ago
|
|
* 172.16.34.6, via eth1
|