[pbs-devel] [PATCH docs] Edit section "Network Management"

Dylan Whyte d.whyte at proxmox.com
Wed Sep 2 10:22:18 CEST 2020


Following changes made:
    * Remove empty column "method6" from network list output,
      so table fits in console code-block
    * Walkthrough bond, rather than a bridge as it may be a more
      common setup case

Signed-off-by: Dylan Whyte <d.whyte at proxmox.com>
---
 docs/administration-guide.rst | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index e6357a3e..e9e1174e 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -483,37 +483,36 @@ 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        │
-  └───────┴────────┴───────────┴────────┴─────────┴───────────────────┴──────────────┴──────────────┘
+  ┌───────┬────────┬───────────┬────────┬─────────────┬──────────────┬──────────────┐
+  │ name  │ type   │ autostart │ method │ address     │ gateway      │ ports/slaves │
+  ╞═══════╪════════╪═══════════╪════════╪═════════════╪══════════════╪══════════════╡
+  │ bond0 │ bond   │         1 │ static │ x.x.x.x/x   │ x.x.x.x      │ ens18 ens19  │
+  ├───────┼────────┼───────────┼────────┼─────────────┼──────────────┼──────────────┤
+  │ ens18 │ eth    │         1 │ manual │             │              │              │
+  ├───────┼────────┼───────────┼────────┼─────────────┼──────────────┼──────────────┤
+  │ ens19 │ eth    │         1 │ manual │             │              │              │
+  └───────┴────────┴───────────┴────────┴─────────────┴──────────────┴──────────────┘
 
 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:
+parameters. The following command shows a template for creating the bond shown
+in the list above:
 
 .. 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
+  # proxmox-backup-manager network create bond0 --type bond --bond_mode active-backup --slaves ens18,ens19 --autostart true --cidr x.x.x.x/x --gateway x.x.x.x
 
 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
+  # proxmox-backup-manager network update bond0 --cidr y.y.y.y/y
 
 You can also remove a network interface:
 
 .. code-block:: console
 
-   # proxmox-backup-manager network remove vmbr1
+   # proxmox-backup-manager network remove bond0
 
 To view the changes made to the network configuration file, before committing
 them, use the command:
-- 
2.20.1






More information about the pbs-devel mailing list