diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-12-20 18:00:31 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-12-20 18:00:31 +0100 |
| commit | c046551a8bf549a232c5fd61ad99294f802d5675 (patch) | |
| tree | b5ea3ae550ede9b5eed7c732689a8a7130e65467 | |
| parent | 4872481ebca1a455339a6c1251c36b2f4938901d (diff) | |
| download | vyos-documentation-c046551a8bf549a232c5fd61ad99294f802d5675.tar.gz vyos-documentation-c046551a8bf549a232c5fd61ad99294f802d5675.zip | |
host-information: use documented section style guide
| -rw-r--r-- | docs/system/host-information.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/system/host-information.rst b/docs/system/host-information.rst index 71209412..b60faa86 100644 --- a/docs/system/host-information.rst +++ b/docs/system/host-information.rst @@ -1,7 +1,8 @@ .. _host-information: +################ Host Information ----------------- +################ This section describes the system's host information and how to configure them, it covers the following topics: @@ -12,8 +13,8 @@ it covers the following topics: * Default gateway * Aliases -Host Name -^^^^^^^^^ +Hostname +======== 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 @@ -49,7 +50,7 @@ Example: Set system hostname to 'RT01': host-name RT01 Domain Name -^^^^^^^^^^^ +=========== A domain name is the label (name) assigned to a computer network and is thus unique. @@ -84,7 +85,7 @@ Example: Set system domain to example.com: 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 @@ -113,7 +114,7 @@ IP address `10.20.30.41`: } Aliases -******* +------- One or more system aliases (static mappings) can be defined: @@ -146,7 +147,7 @@ Example: Set alias `router1` for system with hostname `RT01`: } 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 |