mirror of
https://github.com/kernelkit/infix.git
synced 2026-08-01 05:13:01 +02:00
Deployed 15d69472 to dev with MkDocs 1.6.1 and mike 2.1.4
This commit is contained in:
github-actions[bot]
@@ -2485,15 +2485,14 @@ followed by Enter. Available commands, press <code>?</code> at the prompt:</p>
|
||||
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>admin@host:/config/interface/eth0/> up
|
||||
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>admin@host:/config/>
|
||||
</code></pre></div>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> commands in configure context are automatically generated
|
||||
from the system's YANG models, hence different products likely have a
|
||||
different set of commands. However, both the <code>ietf-interfaces.yang</code>
|
||||
and <code>ietf-ip.yang</code> models, for instance, that provide the networking
|
||||
<p><strong>Note</strong></p>
|
||||
<p>Commands in configure context are automatically generated from the
|
||||
system's YANG models, hence different products likely have a different
|
||||
set of commands. However, both the <code>ietf-interfaces.yang</code> and
|
||||
<code>ietf-ip.yang</code> models, for instance, that provide the networking
|
||||
support are common to all systems.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="set-ip-address-on-an-interface">Set IP Address on an Interface<a class="headerlink" href="#set-ip-address-on-an-interface" title="Permanent link">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>admin@host:/config/> edit interface eth0
|
||||
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>admin@host:/config/interface/eth0/>
|
||||
@@ -2535,12 +2534,11 @@ reboots:</p>
|
||||
</code></pre></div>
|
||||
<p>The <code>startup-config</code> can also be inspected with the <code>show</code> command to
|
||||
verify the changes are saved.</p>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> all commands need to be spelled out, no short forms are
|
||||
allowed in the CLI. Use the <code>TAB</code> key to make your life easier.</p>
|
||||
<p><strong>Important</strong></p>
|
||||
<p>All commands need to be spelled out, no short forms are allowed in the
|
||||
CLI. Use the <code>TAB</code> key to make your life easier.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="changing-hostname">Changing Hostname<a class="headerlink" href="#changing-hostname" title="Permanent link">¶</a></h2>
|
||||
<p>Settings like hostname are located in the <code>ietf-system.yang</code> model.
|
||||
Here is how it can be set.</p>
|
||||
@@ -2551,35 +2549,33 @@ Here is how it can be set.</p>
|
||||
</code></pre></div>
|
||||
<p>Notice how the hostname in the prompt does not change until the change
|
||||
is committed.</p>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> critical services like syslog, mDNS, LLDP, and similar that
|
||||
advertise the hostname, are restarted when the hostname is changed.</p>
|
||||
<p><strong>Note</strong></p>
|
||||
<p>Critical services like syslog, mDNS, LLDP, and similar that advertise
|
||||
the hostname, are restarted when the hostname is changed.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="changing-password">Changing Password<a class="headerlink" href="#changing-password" title="Permanent link">¶</a></h2>
|
||||
<p>User management, including passwords, is also a part of <code>ietf-system</code>.</p>
|
||||
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>admin@host:/config/> edit system authentication user admin
|
||||
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>admin@host:/config/system/authentication/user/admin/> change password
|
||||
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>New password:
|
||||
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a>Retype password:
|
||||
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>New password:
|
||||
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a>Retype password:
|
||||
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a>admin@host:/config/system/authentication/user/admin/> leave
|
||||
</code></pre></div>
|
||||
<p>The <code>change password</code> command starts an interactive dialogue that asks
|
||||
for the new password, with a confirmation, and then salts and encrypts
|
||||
the password with sha512crypt. </p>
|
||||
the password with sha512crypt.</p>
|
||||
<p>It is also possible to use the <code>set password ...</code> command. This allows
|
||||
setting an already hashed password. To manually hash a password, use
|
||||
the <code>do password encrypt</code> command. This launches the admin-exec command
|
||||
to hash, and optionally salt, your password. This encrypted string can
|
||||
then be used with <code>set password ...</code>.</p>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Tip:</strong> if you are having trouble thinking of a password, there is
|
||||
also <code>do password generate</code>, which generates random but readable
|
||||
strings using the UNIX command <code>pwgen</code>.</p>
|
||||
<p><strong>Tip</strong></p>
|
||||
<p>If you are having trouble thinking of a password, there is also <code>do
|
||||
password generate</code>, which generates random but readable strings using
|
||||
the UNIX command <code>pwgen</code>.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="ssh-authorized-key">SSH Authorized Key<a class="headerlink" href="#ssh-authorized-key" title="Permanent link">¶</a></h2>
|
||||
<p>Logging in remotely with SSH is possible by adding a <em>public key</em> to a
|
||||
user. Here we add the authorized key to the admin user, multiple keys
|
||||
@@ -2595,11 +2591,11 @@ remember to verify SSH login and network connectivity before doing so.</p>
|
||||
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a>key-data AAAAB3NzaC1yc2EAAAADAQABAAABgQC8iBL42yeMBioFay7lty1C4ZDTHcHyo739gc91rTTH8SKvAE4g8Rr97KOz/8PFtOObBrE9G21K7d6UBuPqmd0RUF2CkXXN/eN2PBSHJ50YprRFt/z/304bsBYkDdflKlPDjuSmZ/+OMp4pTsq0R0eNFlX9wcwxEzooIb7VPEdvWE7AYoBRUdf41u3KBHuvjGd1M6QYJtbFLQMMTiVe5IUfyVSZ1RCxEyAB9fR9CBhtVheTVsY3iG0fZc9eCEo89ErDgtGUTJK4Hxt5yCNwI88YaVmkE85cNtw8YwubWQL3/tGZHfbbQ0fynfB4kWNloyRHFr7E1kDxuX5+pbv26EqRdcOVGucNn7hnGU6C1+ejLWdBD7vgsoilFrEaBWF41elJEPKDzpszEijQ9gTrrWeYOQ+x++lvmOdssDu4KvGmj2K/MQTL2jJYrMJ7GDzsUu3XikChRL7zNfS2jYYQLzovboUCgqfPUsVba9hqeX3U67GsJo+hy5MG9RSry4+ucHs=;
|
||||
<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a>admin@host:/config/system/authentication/user/admin/authorized-key/example@host/> leave
|
||||
</code></pre></div>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> the <code>ssh-keygen</code> program already base64 encodes the public
|
||||
key data, so there is no need to use the <code>text-editor</code> command, <code>set</code>
|
||||
does the job.</p>
|
||||
<p><strong>Note</strong></p>
|
||||
<p>The <code>ssh-keygen</code> program already base64 encodes the public key data,
|
||||
so there is no need to use the <code>text-editor</code> command, <code>set</code> does the
|
||||
job.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="creating-a-veth-pair">Creating a VETH Pair<a class="headerlink" href="#creating-a-veth-pair" title="Permanent link">¶</a></h2>
|
||||
@@ -2633,13 +2629,13 @@ world. Here we also add an IPv4 address to one end of the pair.</p>
|
||||
<a id="__codelineno-10-25" name="__codelineno-10-25" href="#__codelineno-10-25"></a>admin@host:/config/> leave
|
||||
</code></pre></div>
|
||||
<p>See the bridging example below for more.</p>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> in the CLI you do not have to create the <code>veth0b</code> interface.
|
||||
The system <em>infers</em> this for you. When setting up a VETH pair using
|
||||
NETCONF, however, you must include the <code>veth0b</code> interface.</p>
|
||||
<p><strong>Tip</strong></p>
|
||||
<p>In the CLI you do not have to create the <code>veth0b</code> interface. The
|
||||
system <em>infers</em> this for you. This does not apply when setting up a
|
||||
VETH pair using NETCONF or RESTCONF, then you must submit a complete
|
||||
configuration.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="creating-a-bridge">Creating a Bridge<a class="headerlink" href="#creating-a-bridge" title="Permanent link">¶</a></h2>
|
||||
<p>Building on the previous example, we now create a non-VLAN filtering
|
||||
bridge (<code>br0</code>) that forwards any, normally link-local, LLDP traffic
|
||||
@@ -2689,13 +2685,12 @@ between both its bridge ports: <code>eth0</code> and <code>vet0b</code>.</p>
|
||||
the VETH pair from the previous example) are now bridged. Any traffic
|
||||
ingressing one port will egress the other. Only reserved IEEE multicast
|
||||
is filtered, except LLDP frames as shown above.</p>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> the bridge can be named anything, provided the interface
|
||||
name is not already taken. However, for any name outside the pattern
|
||||
<code>br[0-9]+</code>, you have to set the interface type manually to <code>bridge</code>.</p>
|
||||
<p><strong>Important</strong></p>
|
||||
<p>The bridge can be named anything, provided the interface name is not
|
||||
already taken. However, for any name outside the pattern <code>br[0-9]+</code>,
|
||||
you have to set the interface type manually to <code>bridge</code>.</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2369,12 +2369,11 @@ available in any context are:</p>
|
||||
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>admin@host-12-34-56:/> show # Try: Tab or ?
|
||||
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>admin@host-12-34-56:/> # Try: Tab or ?
|
||||
</code></pre></div>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> even on an empty command line, you can tap the <code>Tab</code> or <code>?</code> keys.<br>
|
||||
<p><strong>Tip</strong></p>
|
||||
<p>Even on an empty command line, you can tap the <code>Tab</code> or <code>?</code> keys.<br>
|
||||
See <a href="../keybindings/"><code>help keybindings</code></a> for more tips!</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<h2 id="key-concepts">Key Concepts<a class="headerlink" href="#key-concepts" title="Permanent link">¶</a></h2>
|
||||
<p>The two modes in the CLI are the admin-exec and the configure context.</p>
|
||||
<p>The top-level context after logging in and starting the CLI is the
|
||||
@@ -2407,14 +2406,14 @@ and <em>running</em> that can be managed and inspected using the <code>copy</cod
|
||||
for these are listed below:</p>
|
||||
<ul>
|
||||
<li><code>factory-config</code> the default configuration from factory for the
|
||||
device, i.e., what the system returns to after a <code>factory-reset</code></li>
|
||||
device, i.e., what the system returns to after a <code>factory-reset</code></li>
|
||||
<li><code>startup-config</code> created from <code>factory-config</code> at first boot after
|
||||
factory reset. Loaded as the system configuration on each boot</li>
|
||||
factory reset. Loaded as the system configuration on each boot</li>
|
||||
<li><code>running-config</code> what is actively running on the system. If no
|
||||
changes have been made since boot, it is the same as <code>startup-config</code></li>
|
||||
changes have been made since boot, it is the same as <code>startup-config</code></li>
|
||||
<li><code>candidate-config</code> is created from <code>running-config</code> when entering the
|
||||
configure context. Any changes made here can be discarded (<code>abort</code>,
|
||||
<code>rollback</code>) or committed (<code>commit</code>, <code>leave</code>) to <code>running-config</code></li>
|
||||
configure context. Any changes made here can be discarded (<code>abort</code>,
|
||||
<code>rollback</code>) or committed (<code>commit</code>, <code>leave</code>) to <code>running-config</code></li>
|
||||
</ul>
|
||||
<p>Edit the <em>running</em> configuration using the <code>configure</code> command. This
|
||||
copies <em>running</em> to <em>candidate</em>, a temporary datastore, where changes
|
||||
@@ -2495,12 +2494,11 @@ store, so the system will use them for consecutive reboots, use the
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="example-session">Example Session<a class="headerlink" href="#example-session" title="Permanent link">¶</a></h2>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p><strong>Tip</strong></p>
|
||||
<p>Remember to use the <code>TAB</code> and <code>?</code> keys to speed up your navigation.<br>
|
||||
See <a href="../keybindings/"><code>help keybindings</code></a> for more tips!</p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
<p>In this example we enter configure context to add an IPv4 address to
|
||||
interface <code>eth0</code>, then we apply the changes using the <code>leave</code> command.</p>
|
||||
<p>We inspect the system status to ensure the change took effect. Then we
|
||||
@@ -2508,8 +2506,8 @@ save the changes for the next reboot.</p>
|
||||
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>admin@host-12-34-56:/> configure
|
||||
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>admin@host-12-34-56:/config/> edit interface eth0
|
||||
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>admin@host-12-34-56:/config/interface/eth0/> set ipv4 <TAB>
|
||||
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a> address autoconf bind-ni-name enabled
|
||||
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a> forwarding mtu neighbor
|
||||
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a> address autoconf bind-ni-name dhcp
|
||||
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a> enabled forwarding mtu neighbor
|
||||
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>admin@host-12-34-56:/config/interface/eth0/> set ipv4 address 192.168.2.200 prefix-length 24
|
||||
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a>admin@host-12-34-56:/config/interface/eth0/> show
|
||||
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a>type ethernetCsmacd;
|
||||
@@ -2546,11 +2544,12 @@ change that, e.g., breaks networking, it is trivial to revert back by:</p>
|
||||
</code></pre></div>
|
||||
<p>Or restart the device, for example if the change to the configuration
|
||||
caused you to lose contact with the system (it happens to the best of
|
||||
us). The system will start up from the last "save gave".</p>
|
||||
us). The system will start up from the last "save game".</p>
|
||||
<blockquote>
|
||||
<p><strong>Tip:</strong> when restoring a backup of a configuration, or having manually
|
||||
edited a config file, you can validate it using system's YANG models,
|
||||
it is <em>not</em> applied if validation is successful:</p>
|
||||
<p><strong>Tip:</strong> Restoring Backups</p>
|
||||
<p>When restoring a backup of a configuration, or having manually edited
|
||||
a config file, you can validate it using the system's YANG models, it
|
||||
is <em>not</em> applied if validation is successful:</p>
|
||||
<p><code>copy /media/backup/old.cfg running-config validate</code></p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
@@ -490,7 +490,7 @@
|
||||
<a href="#what-is-meta" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
What is Meta?
|
||||
What is Meta
|
||||
|
||||
</span>
|
||||
</a>
|
||||
@@ -2257,7 +2257,7 @@
|
||||
<a href="#what-is-meta" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
What is Meta?
|
||||
What is Meta
|
||||
|
||||
</span>
|
||||
</a>
|
||||
@@ -2492,7 +2492,7 @@ CLI has several keybindings, most significant first:</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="what-is-meta">What is Meta?<a class="headerlink" href="#what-is-meta" title="Permanent link">¶</a></h2>
|
||||
<h2 id="what-is-meta">What is Meta<a class="headerlink" href="#what-is-meta" title="Permanent link">¶</a></h2>
|
||||
<p>The Meta key is called Alt on most modern keyboards. If you have
|
||||
neither, first tap the Esc key instead of holding down Alt/Meta.</p>
|
||||
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
|
||||
|
||||
@@ -2320,13 +2320,12 @@ keybindings are really useful to learn!</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr>
|
||||
<blockquote>
|
||||
<p>In <code>configure</code> context the <code>help setting</code> command shows the YANG
|
||||
<p><strong>Tip:</strong> Online Help</p>
|
||||
<p>In <code>configure</code> context the <code>help <setting></code> command shows the YANG
|
||||
description text for each node and container. To reach the admin
|
||||
exec help from configure context, e.g., <code>do help text-editor</code></p>
|
||||
</blockquote>
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2262,7 +2262,7 @@ even both.</p>
|
||||
<p>To install a new software image to the currently <em>inactive</em> partition<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup>, we
|
||||
use the <code>upgrade</code> command and a URI to a ftp/tftp/sftp or http/https server
|
||||
that hosts the file:</p>
|
||||
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>admin@host:/> upgrade tftp://192.168.122.1/firmware-x86_64-v23.11.pkg
|
||||
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>admin@example:/> upgrade tftp://192.168.122.1/firmware-x86_64-v23.11.pkg
|
||||
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>installing
|
||||
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> 0% Installing
|
||||
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> 0% Determining slot states
|
||||
@@ -2283,7 +2283,7 @@ that hosts the file:</p>
|
||||
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> 99% Updating slots done.
|
||||
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>100% Installing done.
|
||||
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>Installing `tftp://192.168.122.1/firmware-x86_64-v23.11.pkg` succeeded
|
||||
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>admin@host:/>
|
||||
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>admin@example:/>
|
||||
</code></pre></div>
|
||||
<p>The secondary partition (<code>rootfs.1</code>) has now been upgraded and will be used as
|
||||
the <em>active</em> partition on the next boot. Leaving the primary partition, with
|
||||
|
||||
Reference in New Issue
Block a user