1.. SPDX-License-Identifier: BSD-3-Clause
2
3======================================================
4Netlink specification support for raw Netlink families
5======================================================
6
7This document describes the additional properties required by raw Netlink
8families such as ``NETLINK_ROUTE`` which use the ``netlink-raw`` protocol
9specification.
10
11Specification
12=============
13
14The netlink-raw schema extends the :doc:`genetlink-legacy <genetlink-legacy>`
15schema with properties that are needed to specify the protocol numbers and
16multicast IDs used by raw netlink families. See :ref:`classic_netlink` for more
17information.
18
19Globals
20-------
21
22protonum
23~~~~~~~~
24
25The ``protonum`` property is used to specify the protocol number to use when
26opening a netlink socket.
27
28.. code-block:: yaml
29
30  # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
31
32  name: rt-addr
33  protocol: netlink-raw
34  protonum: 0             # part of the NETLINK_ROUTE protocol
35
36
37Multicast group properties
38--------------------------
39
40value
41~~~~~
42
43The ``value`` property is used to specify the group ID to use for multicast
44group registration.
45
46.. code-block:: yaml
47
48  mcast-groups:
49    list:
50      -
51        name: rtnlgrp-ipv4-ifaddr
52        value: 5
53      -
54        name: rtnlgrp-ipv6-ifaddr
55        value: 9
56      -
57        name: rtnlgrp-mctp-ifaddr
58        value: 34
59