docs/network-management.rst

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