docs/network-management.rst

   1 Network Management
   2 ==================
   3
   4 Proxmox Backup Server provides both a web interface and a command line tool for
   5 network configuration. You can find the configuration options in the web
   6 interface under the **Network Interfaces** section of the **Configuration** menu
   7 tree item. The command line tool is accessed via the ``network`` subcommand.
   8 These interfaces allow you to carry out some basic network management tasks,
   9 such as adding, configuring, and removing network interfaces.
  10
  11 .. note:: Any changes made to the network configuration are not
  12   applied, until you click on **Apply Configuration** or enter the ``network
  13   reload`` command. This allows you to make many changes at once. It also allows
  14   you to ensure that your changes are correct before applying them, as making a
  15   mistake here can render the server inaccessible over the network.
  16
  17 To get a list of available interfaces, use the following command:
  18
  19 .. code-block:: console
  20
  21   # proxmox-backup-manager network list
  22   ┌───────┬────────┬───────────┬────────┬─────────────┬──────────────┬──────────────┐
  23   │ name  │ type   │ autostart │ method │ address     │ gateway      │ ports/slaves │
  24   ╞═══════╪════════╪═══════════╪════════╪═════════════╪══════════════╪══════════════╡
  25   │ bond0 │ bond   │         1 │ static │ x.x.x.x/x   │ x.x.x.x      │ ens18 ens19  │
  26   ├───────┼────────┼───────────┼────────┼─────────────┼──────────────┼──────────────┤
  27   │ ens18 │ eth    │         1 │ manual │             │              │              │
  28   ├───────┼────────┼───────────┼────────┼─────────────┼──────────────┼──────────────┤
  29   │ ens19 │ eth    │         1 │ manual │             │              │              │
  30   └───────┴────────┴───────────┴────────┴─────────────┴──────────────┴──────────────┘
  31
  32 .. image:: images/screenshots/pbs-gui-network-create-bond.png
  33   :align: right
  34   :alt: Add a network interface
  35
  36 To add a new network interface, use the ``create`` subcommand with the relevant
  37 parameters. For example, you may want to set up a bond, for the purpose of
  38 network redundancy. The following command shows a template for creating the bond shown
  39 in the list above:
  40
  41 .. code-block:: console
  42
  43   # 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
  44
  45 You can make changes to the configuration of a network interface with the
  46 ``update`` subcommand:
  47
  48 .. code-block:: console
  49
  50   # proxmox-backup-manager network update bond0 --cidr y.y.y.y/y
  51
  52 You can also remove a network interface:
  53
  54 .. code-block:: console
  55
  56    # proxmox-backup-manager network remove bond0
  57
  58 The pending changes for the network configuration file will appear at the bottom of the
  59 web interface. You can also view these changes, by using the command:
  60
  61 .. code-block:: console
  62
  63   # proxmox-backup-manager network changes
  64
  65 If you would like to cancel all changes at this point, you can either click on
  66 the **Revert** button or use the following command:
  67
  68 .. code-block:: console
  69
  70   # proxmox-backup-manager network revert
  71
  72 If you are happy with the changes and would like to write them into the
  73 configuration file, select **Apply Configuration**. The corresponding command
  74 is:
  75
  76 .. code-block:: console
  77
  78   # proxmox-backup-manager network reload
  79
  80 .. note:: This command and corresponding GUI button rely on the ``ifreload``
  81   command, from the package ``ifupdown2``. This package is included within the
  82   Proxmox Backup Server installation, however, you may have to install it yourself,
  83   if you have installed Proxmox Backup Server on top of Debian or Proxmox VE.
  84
  85 You can also configure DNS settings, from the **DNS** section
  86 of **Configuration** or by using the ``dns`` subcommand of
  87 ``proxmox-backup-manager``.
  88