docs/network-management.rst

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