summaryrefslogtreecommitdiff
path: root/docs/interfaces/dummy.rst
blob: 7fee2700829b703affa121aef62f1a1cec92373c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
.. _dummy-interface:

#####
Dummy
#####

The dummy interface is really a little exotic, but rather useful nevertheless.
Dummy interfaces are much like the :ref:`loopback-interface` interface, except
you can have as many as you want. Dummy interfaces can be used as interfaces
that always stay up (in the same fashion to loopbacks in Cisco IOS), or for
testing purposes.

Configuration
#############

Address
-------

.. cfgcmd:: set interfaces dummy <interface> address <address | dhcp | dhcpv6>

   Configure dummy interface `<interface>` with one or more interface
   addresses. Address can be specified multiple times as IPv4 and/or IPv6
   address, e.g. 192.0.2.1/24 and/or 2001:db8::1/64

   Example:

   .. code-block:: none

     set interfaces dummy dum10 address 192.0.2.1/24
     set interfaces dummy dum10 address 192.0.2.2/24
     set interfaces dummy dum10 address 2001:db8::ffff/64
     set interfaces dummy dum10 address 2001:db8:100::ffff/64

Link Administration
-------------------

.. cfgcmd:: set interfaces dummy <interface> description <description>

   Assign given `<description>` to interface. Description will also be passed
   to SNMP monitoring systems.

.. cfgcmd:: set interfaces dummy <interface> disable

   Disable given `<interface>`. It will be placed in administratively down
   state.

Operation
=========

.. opcmd:: show interfaces dummy

   Show brief interface information.information

   .. code-block:: none

     vyos@vyos:~$ show interfaces dummy
     Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
     Interface        IP Address                        S/L  Description
     ---------        ----------                        ---  -----------
     dum0             172.18.254.201/32                 u/u

.. opcmd:: show interfaces dummy <interface>

   Show detailed information on given `<interface>`

   .. code-block:: none

     vyos@vyos:~$ show interfaces ethernet eth0
     dum0: <BROADCAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc noqueue state UNKNOWN group default qlen 1000
         link/ether 26:7c:8e:bc:fc:f5 brd ff:ff:ff:ff:ff:ff
         inet 172.18.254.201/32 scope global dum0
            valid_lft forever preferred_lft forever
         inet6 fe80::247c:8eff:febc:fcf5/64 scope link
            valid_lft forever preferred_lft forever

         RX:  bytes    packets     errors    dropped    overrun      mcast
                  0          0          0          0          0          0
         TX:  bytes    packets     errors    dropped    carrier collisions
            1369707       4267          0          0          0          0