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 B0D026314B for ; Mon, 24 Aug 2020 12:14:33 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 9A5D71C083 for ; Mon, 24 Aug 2020 12:14:03 +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) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id D2C701C078 for ; Mon, 24 Aug 2020 12:14:02 +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 9AF964348E for ; Mon, 24 Aug 2020 12:14:02 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 24 Aug 2020 12:13:50 +0200 Message-Id: <20200824101350.9494-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 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 pbs-docs 1/2] Add section "Network Management" 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, 24 Aug 2020 10:14:33 -0000 Add the section "Network Management", which explains the "network" subcommand of "proxmox-backup-manager" Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 66 +++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index 61206fe7..cd7577bd 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -482,6 +482,72 @@ A single user can be assigned multiple permission sets for different data stores remote (see `Remote` below) and ``{storename}`` is the name of the data store on the remote. +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. + +To get a list of available interfaces, use the following command: + +.. code-block:: console + + # proxmox-backup-manager network list + ┌───────┬────────┬───────────┬────────┬─────────┬───────────────────┬──────────────┬──────────────┐ + │ name │ type │ autostart │ method │ method6 │ address │ gateway │ ports/slaves │ + ╞═══════╪════════╪═══════════╪════════╪═════════╪═══════════════════╪══════════════╪══════════════╡ + │ bond0 │ bond │ 1 │ manual │ │ │ │ ens18 ens19 │ + ├───────┼────────┼───────────┼────────┼─────────┼───────────────────┼──────────────┼──────────────┤ + │ ens18 │ eth │ 1 │ manual │ │ │ │ │ + ├───────┼────────┼───────────┼────────┼─────────┼───────────────────┼──────────────┼──────────────┤ + │ ens19 │ eth │ 1 │ manual │ │ │ │ │ + ├───────┼────────┼───────────┼────────┼─────────┼───────────────────┼──────────────┼──────────────┤ + │ 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 +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 + +You can make changes to the configuration of a network interface with the +``update`` subcommand: + +.. code-block:: console + + # proxmox-backup-manager network update vmbr1 --cidr y.y.y.y/y + +You can also remove a network interface: + +.. code-block:: console + + # proxmox-backup-manager network remove vmbr1 + +To view the changes made to the network configuration file, before committing +them, use 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: + +.. 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: + +.. code-block:: console + + # proxmox-backup-manager network reload + +You can also configure DNS settings using the ``dns`` subcommand of +``proxmox-backup-manager``. + :term:`Remote` ~~~~~~~~~~~~~~ -- 2.20.1