From: Dylan Whyte <d.whyte@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH docs 5/6] Network Config: Add screenshots and explanation
Date: Mon, 7 Sep 2020 17:21:11 +0200 [thread overview]
Message-ID: <20200907152112.14057-6-d.whyte@proxmox.com> (raw)
In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com>
Add screenshots for network configuration and explain
how to carry out related tasks using the web interface.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
docs/administration-guide.rst | 39 +++++++++++++++++++++++++++--------
1 file changed, 30 insertions(+), 9 deletions(-)
diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index 96803c65..560489fc 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -541,9 +541,19 @@ A single user can be assigned multiple permission sets for different data stores
Network Management
~~~~~~~~~~~~~~~~~~
-Proxmox Backup Server provides an interface for network configuration, through the
-``network`` subcommand. This allows you to carry out some basic network
-management tasks such as adding, configuring and removing network interfaces.
+
+Proxmox Backup Server provides both a web interface and a command line tool for
+network configuration. You can find the configuration options in the web
+interface under the **Network Interfaces** section of the **Configuration** menu
+tree item. The command line tool is accessed via the ``network`` subcommand.
+These interfaces allow you to carry out some basic network management tasks,
+such as adding, configuring, and removing network interfaces.
+
+.. note:: Any changes made to the network configuration are not
+ applied, until you click on **Apply Configuration** or enter the ``network
+ reload`` command. This allows you to make many changes at once. It also allows
+ you to ensure that your changes are correct before applying them, as making a
+ mistake here can render the server inaccessible over the network.
To get a list of available interfaces, use the following command:
@@ -562,9 +572,17 @@ To get a list of available interfaces, use the following command:
│ vmbr0 │ bridge │ 1 │ static │ │ x.x.x.x/x │ x.x.x.x │ bond0 │
└───────┴────────┴───────────┴────────┴─────────┴───────────────────┴──────────────┴──────────────┘
-To add a new network interface, use the ``create`` subcommand with the relevant
+.. image:: images/screenshots/pbs-gui-network-create-bond.png
+ :width: 230
+ :align: right
+ :alt: Add a network interface
+
+To add a new network interface, select an interface type from the **Create** menu
+in the web interface, or use the ``create`` subcommand with the relevant
parameters. The following command shows a template for creating a new bridge:
+|
+
.. code-block:: console
# proxmox-backup-manager network create vmbr1 --autostart true --cidr x.x.x.x/x --gateway x.x.x.x --bridge_ports iface_name --type bridge
@@ -582,27 +600,30 @@ You can also remove a network interface:
# proxmox-backup-manager network remove vmbr1
-To view the changes made to the network configuration file, before committing
-them, use the command:
+The pending changes for the network configuration file will appear at the bottom of the
+web interface. You can also view these changes, by using the command:
.. code-block:: console
# proxmox-backup-manager network changes
-If you would like to cancel all changes at this point, you can do this using:
+If you would like to cancel all changes at this point, you can either click on
+the **Revert** button or use the following command:
.. code-block:: console
# proxmox-backup-manager network revert
If you are happy with the changes and would like to write them into the
-configuration file, the command is:
+configuration file, select **Apply Configuration**. The corresponding command
+is:
.. code-block:: console
# proxmox-backup-manager network reload
-You can also configure DNS settings using the ``dns`` subcommand of
+You can also configure DNS settings, from the **DNS** section
+of **Configuration** or by using the ``dns`` subcommand of
``proxmox-backup-manager``.
:term:`Remote`
--
2.20.1
next prev parent reply other threads:[~2020-09-07 15:21 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-07 15:21 [pbs-devel] [PATCH docs 0/6] Add GUI screenshots and explain Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 1/6] Add screenshots of web interface Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 2/6] Disk Management: Add screenshots and explanation Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 3/6] Datastore Config: add " Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 4/6] User Management: Add " Dylan Whyte
2020-09-07 15:21 ` Dylan Whyte [this message]
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 6/6] Sync Jobs: add " Dylan Whyte
2020-09-08 4:20 ` [pbs-devel] applied: [PATCH docs 0/6] Add GUI screenshots and explain Dietmar Maurer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200907152112.14057-6-d.whyte@proxmox.com \
--to=d.whyte@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.