summaryrefslogtreecommitdiff
path: root/docs/interfaces/addresses.rst
blob: 6879b785c230df9d54e45ef2078b362f3d51019e (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
.. _interfaces-addresses:

Interface Addresses
-------------------

Each interface can be configured with a description and address. Interface
addresses might be:

* Static IPv4 `address 172.16.51.129/24`
* Static IPv6 `address 2001:db8:1::ffff/64`
* DHCP IPv4 `address dhcp`
* DHCP IPv6 `address dhcpv6`

An interface description is assigned using the following command:

.. code-block:: sh

  set interfaces ethernet eth0 description 'OUTSIDE'

IPv4
^^^^

Static Address
**************

This method is supported on all interfaces, apart from OpenVPN that uses
different syntax and wireless modems that are always autoconfigured through
PPP.

The command is `set interfaces $type $name address $address`. Examples:

.. code-block:: sh

  set interfaces ethernet eth0 address 192.0.2.1/24
  set interfaces tunnel tun0 address 10.0.0.1/30
  set interfaces bridge br0 address 203.0.113.45/26
  set interfaces ethernet eth0 vif 30 address 192.0.30.254/24

DHCP
****

This method is supported on all physical interfaces, and those that are
directly connected to a physical interface (ethernet, VLAN, bridge, bond,
pseudo-ethernet, wireless).

The command is `set interfaces $type $name address dhcp`. Examples:

.. code-block:: sh

  set interfaces ethernet eth0 vif 90 address dhcp
  set interfaces bridge br0 address dhcp

IPv6
^^^^

Static Address
**************

This method is supported on all interfaces, apart from OpenVPN that uses
different syntax and wireless modems that are always autoconfigured through
PPP. Static IPv6 addresses are supported on all interfaces
except :ref:`interfaces-tunnel`.

The command is `set interfaces $type $name address $address`. Examples:

.. code-block:: sh

  set interfaces ethernet eth0 address 2001:db8:100::ffff/64
  set interfaces tunnel tun0 address 2001:db8::1/64
  set interfaces bridge br0 address  2001:db8:200::1/64
  set interfaces ethernet eth0 vif 30 address 2001:db8:3::ffff/64

DHCP
****

This method is supported on all physical interfaces, and those that are
directly connected to a physical interface (ethernet, VLAN, bridge, bond,
pseudo-ethernet, wireless).

The command is `set interfaces $type $name address dhcpv6`. Examples:

.. code-block:: sh

  set interfaces bonding bond1 address dhcpv6
  set interfaces bridge br0 vif 56 address dhcpv6

Autoconfiguration (SLAAC)
*************************

SLAAC is specified in RFC4862_. This method is supported on all physical
interfaces, and those that are directly connected to a physical interface
(ethernet, VLAN, bridge, bond, pseudo-ethernet, wireless).

The command is `set interfaces $type $name ipv6 address autoconf`. Examples:

.. code-block:: sh

  set interfaces ethernet eth0 vif 90 ipv6 address autoconf
  set interfaces bridge br0 ipv6 address autoconf

.. note:: This method automatically disables IPv6 traffic forwarding on the
   interface in question.

EUI-64
******

EUI-64 (64-Bit Extended Unique Identifier) as specified in RFC4291_. IPv6
addresses in /64 networks can be automatically generated from the prefix and
MAC address, if you specify the prefix.

The command is `set interfaces $type $name ipv6 address eui64 $prefix`.
Examples:

.. code-block:: sh

  set interfaces bridge br0 ipv6 address eui64 2001:db8:beef::/64
  set interfaces pseudo-ethernet peth0 ipv6 address eui64 2001:db8:aa::/64


Router Advertisements
*********************

Router advertisements are described in `RFC4861 section 4.2`_. They are part of what is known as SLAAC (Stateless Address Autoconfiguration). 

To enable or disable, use:

.. code-block:: sh

  set interfaces <interface> ipv6 router-advert send-advert <true or false>


To set the options described in "Router Advertisement Message Format":

.. code-block:: sh

  vyos@vyos#  set interfaces <interface> ipv6 router-advert
  Possible completions:
    cur-hop-limit         Value to be placed in the "Current Hop Limit" field in RAs
    default-lifetime      Value to be placed in "Router Lifetime" field in RAs
    default-preference    Default router preference
    link-mtu              Value of link MTU to place in RAs
    managed-flag          Value for "managed address configuration" flag in RAs
    max-interval          Maximum interval between unsolicited multicast RAs
    min-interval          Minimum interval between unsolicited multicast RAs
  +  name-server          IPv6 address of a Recursive DNS Server
    other-config-flag     Value to be placed in the "other configuration" flag in RAs
  +> prefix               IPv6 prefix to be advertised in Router Advertisements (RAs)
    reachable-time        Value to be placed in "Reachable Time" field in RAs
    retrans-timer         Value to place in "Retrans Timer" field in RAs.
    send-advert           Enable/disable sending RAs


**Prefix Information**

Prefix information is described in `RFC4861 section 4.6.2`_

.. code-block:: sh

  vyos@vyos# set interfaces <interface> ipv6 router-advert prefix <h:h:h:h:h:h:h:h/x>
  Possible completions:
    autonomous-flag       Whether prefix can be used for address auto-configuration
    on-link-flag          Flag that prefix can be used for on-link determination
    preferred-lifetime    Time in seconds that the prefix will remain preferred
    valid-lifetime        Time in seconds that the prefix will remain valid

**Receiving Router Advertisements**

To receive and accept RAs on an interface, you need to enable it via sysctl with the following command (as root):

``sysctl -w net.ipv6.conf.<interface>.accept_ra=2``

The change is not reboot-persistent, so it either needs to be redone every time or added via ``set system sysctl ...`` to configuration




.. _`RFC4861 section 4.6.2`: https://tools.ietf.org/html/rfc4861#section-4.6.2
.. _`RFC4861 section 4.2`: https://tools.ietf.org/html/rfc4861#section-4.2
.. _RFC4862: https://tools.ietf.org/html/rfc4862
.. _RFC4291: http://tools.ietf.org/html/rfc4291#section-2.5.1