From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id B13FA61B05 for ; Mon, 7 Sep 2020 17:21:30 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id ABE16C944 for ; Mon, 7 Sep 2020 17:21:30 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 9FD4BC916 for ; Mon, 7 Sep 2020 17:21:27 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 6F96E44A94 for ; Mon, 7 Sep 2020 17:21:27 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 7 Sep 2020 17:21:11 +0200 Message-Id: <20200907152112.14057-6-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com> References: <20200907152112.14057-1-d.whyte@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.011 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH docs 5/6] Network Config: Add screenshots and explanation X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 07 Sep 2020 15:21:30 -0000 Add screenshots for network configuration and explain how to carry out related tasks using the web interface. Signed-off-by: Dylan Whyte --- 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