Setting up and Managing NetworkManager

DC-SLES-networkmanager-nmcli

@@ -0,0 +1,17 @@
+## ---------------------------- 
+## Doc Config File for the DB Assembly 
+## ----------------------------
+##
+## Basics
+MAIN="SLES-networkmanager-nmcli.asm.xml"
+SRC_DIR="articles"
+IMG_SRC_DIR="images"
+
+## Profiling
+PROFOS="sles"
+#PROFARCH="x86_64;zseries;power;aarch64"
+
+## stylesheet location
+STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2021-ns"
+DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"

articles/SLES-networkmanager-nmcli.asm.xml

@@ -0,0 +1,229 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- file: templates/articles/assembly.xml -->
+<?xml-model href="https://cdn.docbook.org/schema/5.2/rng/assemblyxi.rnc"
+            type="application/relax-ng-compact-syntax"?>
+<!DOCTYPE assembly
+[
+    <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<assembly version="5.2" xml:lang="en"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:trans="http://docbook.org/ns/transclusion"
+          xmlns:its="http://www.w3.org/2005/11/its"
+          xmlns="http://docbook.org/ns/docbook">
+  <!-- resources section references all topic chunks used in the final article
+    -->
+  <!-- R E S O U R C E S -->
+  <!-- Glue files -->
+  <!--<resources>
+    <resource xml:id="_glue-example" href="../glues/glue.xml">
+      <description>Glue example</description>
+    </resource>
+    <resource xml:id="_glue-more-info" href="../glues/glue-more-info.xml">
+      <description>Glue for more information</description>
+    </resource>
+    <resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
+      <description>Glue what's next</description>
+    </resource>
+  </resources>-->
+  <!-- Concept files -->
+  <resources>
+    <resource xml:id="_networkmanager-nmcli-concept" href="../concepts/networkmanager-nmcli-concept.xml">
+      <description>The &nm; tool is used to manage network connections and devices.</description>
+    </resource> 
+  </resources>
+  <!-- Tasks -->
+  <resources>
+    <resource xml:id="_networkmanager-nmcli-configure" href="../tasks/networkmanager-nmcli-configure.xml">
+      <description>You can use nmcli command to configure network connections.</description>
+    </resource> 
+    <resource xml:id="networkmanager-nmcli-conf-nwbehavior" href="../tasks/networkmanager-nmcli-conf-nwbehavior.xml">
+      <description>You can use nmcli command to configure the behavior of &nm;.</description>
+    </resource> 
+    <resource xml:id="_install-networkmanager-nmcli" href="../tasks/networkmanager-nmcli-install.xml">
+      <description>You can install &nm; to manage network connections and devices.</description>
+    </resource>
+    <resource xml:id="_networkmanager-nmcli-start" href="../tasks/networkmanager-nmcli-start.xml">
+      <description>You can start &nm; to manage network connections and devices.</description>
+    </resource>
+    <resource xml:id="_networkmanager-nmcli-logging" href="../tasks/networkmanager-nmcli-logging.xml">
+      <description>You can configure &nm; logging and view the &nm; logs.</description>
+    </resource>
+     <resource xml:id="_networkmanager-nmcli-troubleshoot" href="../tasks/networkmanager-nmcli-troubleshoot.xml">
+      <description>Troubleshoot common &nm; configuration issues.</description>
+    </resource>
+  </resources>
+  <!-- References -->
+  <resources>
+   <resource xml:id="_networkmanager-nm-modify" href="../references/networkmanager-nm-modify.xml">
+      <description>You can use the nmcli command to modify network connections.</description>
+    </resource>
+    <resource xml:id="_networkmanager-nm-monitor" href="../references/networkmanager-nm-monitor.xml">
+      <description>You can monitor network details using <command>nmcli</command> command.</description>
+    </resource>
+     <resource xml:id="_networkmanager-nm-enabledisable" href="../references/networkmanager-nm-enabledisable.xml">
+      <description>You can enable and disable &nm; using <command>nmcli</command> command.</description>
+    </resource>
+    <resource xml:id="_networking-nmcli" href="../references/networking-nmcli.xml">
+      <description>The nmcli command description.</description>
+    </resource>
+  </resources>
+  <!-- Legal -->
+  <resources>
+    <resource href="../common/legal.xml" xml:id="_legal">
+      <description>Legal Notice</description>
+    </resource>
+    <resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
+      <description>GNU Free Documentation License</description>
+    </resource>
+  </resources>
+  <!-- S T R U C T U R E -->
+  <structure renderas="article" xml:id="networkmanager-nmcli" xml:lang="en">
+    <merge>
+      <title>Setting Up and Managing Network Connections Using &nm;</title>
+     <!-- <subtitle>Subtitle if necessary</subtitle>-->
+      <!-- Create changelog to enable versioning; add most recent entries at the top. -->
+      <revhistory xml:id="rh-networkmanager-nmcli">
+        <revision><date>2024-12-12</date>
+          <revdescription>
+            <para>
+              Initial version
+            </para>
+          </revdescription>
+        </revision>
+      </revhistory>
+      <!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
+      <!-- add author's e-mail -->
+      <meta name="maintainer" content="[email protected]" its:translate="no"/>
+      <!-- ISO date of last update as YYYY-MM-DD -->
+      <meta name="updated" content="2024-12-12" its:translate="no"/>
+      <!-- this does not work yet. Use the dm tags listed below for now
+        <meta name="bugtracker" its:translate="no">
+          <phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
+          <phrase role="component">Non-product-specific documentation</phrase>
+          <phrase role="product">Smart Docs</phrase>
+          <phrase role="assignee">[email protected]</phrase>
+        </meta>
+        -->
+      <!-- not supported, yet. Use dm: tag for now
+        <meta name="translation" its:translate="no">
+        <phrase role="trans">yes</phrase>
+        <phrase role="language">de-de,cs-cz</phrase>
+        </meta>
+        -->
+      <!-- enter the platform identifier or a list of
+        identifiers, separated by ; -->
+      <meta name="architecture" its:translate="no">
+        <phrase>&x86-64;</phrase>
+        <phrase>&power;</phrase>
+      </meta>
+      <meta name="productname" its:translate="no">
+        <productname version="16.0" os="sles">&productname;</productname>
+      </meta>
+      <meta name="title" its:translate="yes">Setting Up and Managing &nm;</meta>
+      <meta name="description" its:translate="yes">Configure, manage and monitor network connections with &nm;</meta>
+      <meta name="social-descr" its:translate="yes">Setting Up and Managing &nm;</meta>
+      <!-- suitable categories -->
+      <meta name="category" its:translate="no">
+        <phrase>Network</phrase>
+      </meta>
+      <meta name="task" its:translate="no">
+        <phrase>Administration</phrase>
+        <phrase>Configuration</phrase>
+      </meta>
+      <meta name="series" its:translate="no">Products &amp; Solutions</meta>
+
+      <dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
+        <dm:bugtracker>
+          <dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
+          <dm:component>Documentation</dm:component>
+          <dm:product>SUSE Linux Enterprise Server 16.0</dm:product>
+          <dm:assignee>[email protected]</dm:assignee>
+        </dm:bugtracker>
+        <dm:translation>yes</dm:translation>
+      </dm:docmanager>
+      <abstract>
+      <variablelist>
+        <varlistentry>
+          <term>WHAT?</term>
+          <listitem>
+            <para>
+              &nm; is a dynamic network control and configuration tool that enables you to keep network devices up and running.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>WHY?</term>
+          <listitem>
+            <para>
+              This article provides a complete overview of &nm; and how to configure, manage, monitor and edit network connections using &nm;.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>EFFORT</term>
+            <listitem>
+              <para>
+                 It takes 15 minutes to install and configure &nm;. You need up to an hour to fully understand the &nm; concept and functionalities.
+              </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>GOAL</term>
+            <listitem>
+              <para>
+                Basic understanding of managing network connections.
+              </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>REQUIREMENTS</term>
+           <listitem><para>Root access to install and manage &nm;. A Package manager to install &nm;.</para></listitem>
+        </varlistentry>
+      </variablelist>
+      </abstract>
+    </merge>
+    <!-- pull in all the topic files you need -->
+    <!-- pick the appropriate type of include to match your needs -->
+    <!-- pull in a topic as is -->
+   <!-- <module resourceref="_glue-example" renderas="section"/>
+     pull in a topic and switch the title -->
+    <!--<module resourceref="_concept-example" renderas="section">
+      <merge>
+        <title>You are a very special concept now!</title>
+      </merge>
+    </module>-->
+
+   <!-- <module resourceref="_reference-example" renderas="section"/>
+    <module resourceref="_glue-more-info" renderas="section"/>
+    <module resourceref="_glue-whats-next" renderas="section"/>-->
+    <module resourceref="_networkmanager-nmcli-concept" renderas="section"/>
+    <module renderas="section">
+    <merge>
+    <title>Installing and Configuring &nm;</title>
+    <abstract>
+    <para>
+    On &productname;, &nm; is installed and enabled by default and thus runs out of the box.
+    Usually, you do not have to reinstall it or change the configuration, but if such an action is
+    needed, these sections provide guidance.
+        </para>
+    </abstract>
+    </merge>
+    <module resourceref="_install-networkmanager-nmcli" renderas="section"/>
+    <module resourceref="networkmanager-nmcli-conf-nwbehavior" renderas="section"/>
+    </module>
+    <module resourceref="_networkmanager-nmcli-start" renderas="section"/>
+
+    <module resourceref="_networkmanager-nmcli-configure" renderas="section"/>
+    <module resourceref="_networkmanager-nm-modify" renderas="section"/>
+    <module resourceref="_networkmanager-nm-enabledisable" renderas="section"/>
+    <module resourceref="_networkmanager-nm-monitor" renderas="section"/>
+    <module resourceref="_networkmanager-nmcli-logging" renderas="section"/>
+    <module resourceref="_networking-nmcli" renderas="section"/>
+     <module resourceref="_networkmanager-nmcli-troubleshoot" renderas="section"/>
+    <module resourceref="_legal" renderas="section"/>
+    <module resourceref="_gfdl" renderas="appendix"/>
+    </structure>
+</assembly>

concepts/networkmanager-nmcli-concept.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic
+[
+<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+%entities;
+]>
+<!-- refers to https://github.com/SUSE/doc-sle/blob/main/xml/systemd.xml [sec-boot-systemd-timer-units] -->
+<topic xml:id="networkmanager-nmcli-concept"
+       role="concept" xml:lang="en"
+       xmlns="http://docbook.org/ns/docbook" version="5.2"
+       xmlns:its="http://www.w3.org/2005/11/its"
+       xmlns:xi="http://www.w3.org/2001/XInclude"
+       xmlns:xlink="http://www.w3.org/1999/xlink"
+       xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>The &nm; concept</title>
+    <meta name="maintainer" content="[email protected]" its:translate="no"/>
+    <abstract>
+      <para>
+        &nm; is a tool that enables managing network connections and devices. &nm; allows you to create, configure and manage network connections and devices.</para>
+    </abstract>
+  </info>
+  <para>On
+  &productnameshort;, &nm; has been designed to be fully automatic by default. It is enabled by
+  default and is shipped with all necessary service unit files that enables you to manage primary network connection and other network interfaces. &nm; supports state-of-the-art
+  encryption types and standards for network connections,
+  including connections to 802.1X protected networks. 802.1X is the IEEE Standard for Local and
+  Metropolitan Area Networks—Port-Based Network Access Control.</para>
+<para>
+  You can switch between  wired or wireless networks seamlessly, as &nm; automatically connects to known wireless networks and manages several network connections in parallel. You can also manually switch between available networks. 
+</para>
+<para>&nm; is typically comprised of the following parts:</para>
+<itemizedlist>
+  <listitem><para>&nm; daemon&mdash;you can interact with the daemon using standard
+  &systemd; commands</para></listitem>
+  <listitem><para>the <command>nmcli</command> command-line interface</para></listitem>
+  <listitem>
+  <para>
+  the ncurses interface <literal>nmtui</literal>
+  </para></listitem>
+  <listitem>
+  <para>
+  &nm; libraries
+  </para>
+  </listitem>
+  <listitem>
+  <para>
+configuration files.
+  </para>
+  </listitem>
+</itemizedlist>
+</topic>