1IO::Socket::Netlink::RoUusteer(3C)ontributed Perl DocumeInOt:a:tSioocnket::Netlink::Route(3)
2
3
4

NAME

6       "IO::Socket::Netlink::Route" - Object interface to "NETLINK_ROUTE"
7       netlink protocol sockets
8

DESCRIPTION

10       This subclass of IO::Socket::Netlink implements the "NETLINK_ROUTE"
11       protocol. This protocol allows communication with the Linux kernel's
12       networking stack, allowing querying or modification of interfaces,
13       addresses, routes, and other networking properties.
14
15       This module is currently a work-in-progress, and this documentation is
16       fairly minimal. The reader is expected to be familiar with
17       "NETLINK_ROUTE", as it currently only gives a fairly minimal
18       description of the Perl-level wrapping of the kernel level concepts.
19       For more information see the documentation in rtnetlink(7).
20

MESSAGE CLASSES

22       Each message type falls into one of the following subclasses, chosen by
23       the value of the "nlmsg_type" field. Each subclass provides access to
24       the field headers of its message body, and netlink attributes.
25
26   IfinfoMsg
27       Relates to a network interface. Used by the following message types
28
29       •   RTM_NEWLINK
30
31       •   RTM_DELLINK
32
33       •   RTM_GETLINK
34
35       Provides the following header field accessors
36
37       •   ifi_family
38
39       •   ifi_type
40
41       •   ifi_index
42
43       •   ifi_flags
44
45       •   ifi_change
46
47       Provides the following netlink attributes
48
49       •   address => STRING
50
51       •   broadcast => STRING
52
53       •   ifname => STRING
54
55       •   mtu => INT
56
57       •   qdisc => STRING
58
59       •   stats => HASH
60
61       •   txqlen => INT
62
63       •   operstate => INT
64
65       •   linkmode => INT
66
67   IfaddrMsg
68       Relates to an address present on an interface. Used by the following
69       message types
70
71       •   RTM_NEWADDR
72
73       •   RTM_DELADDR
74
75       •   RTM_GETADDR
76
77       Provides the following header field accessors
78
79       •   ifa_family
80
81       •   ifa_prefixlen
82
83       •   ifa_flags
84
85       •   ifa_scope
86
87       •   ifa_index
88
89       Provides the following netlink attributes
90
91       •   address => STRING
92
93       •   local => STRING
94
95       •   label => STRING
96
97       •   broadcast => STRING
98
99       •   anycast => STRING
100
101       •   cacheinfo => HASH
102
103       $message->prefix
104
105       Sets or returns both the "address" netlink attribute, and the
106       "ifa_prefixlen" header value, in the form
107
108        address/ifa_prefixlen
109
110   RtMsg
111       Relates to a routing table entry. Used by the following message types
112
113       •   RTM_NEWROUTE
114
115       •   RTM_DELROUTE
116
117       •   RTM_GETROUTE
118
119       Provides the following header field accessors
120
121       •   rtm_family
122
123       •   rtm_dst_len
124
125       •   rtm_src_len
126
127       •   rtm_tos
128
129       •   rtm_table
130
131       •   rtm_protocol
132
133       •   rtm_scope
134
135       •   rtm_type
136
137       •   rtm_flags
138
139       Provides the following netlink attributes
140
141       •   dst => STRING
142
143       •   src => STRING
144
145       •   iif => INT
146
147       •   oif => INT
148
149       •   gateway => STRING
150
151       •   priority => INT
152
153       •   metrics => INT
154
155       $message->src
156
157       Sets or returns the "src" netlink attribute and the "rtm_src_len"
158       header value, in the form
159
160        address/prefixlen
161
162       if the address is defined, or "undef" if not.
163
164       $message->dst
165
166       Sets or returns the "dst" netlink attribute and the "rtm_dst_len"
167       header value, in the form given above.
168
169   NdMsg
170       Relates to a neighbour discovery table entry. Used by the following
171       message types
172
173       •   RTM_NEWNEIGH
174
175       •   RTM_DELNEIGH
176
177       •   RTM_GETNEIGH
178
179       Provides the following header field accessors
180
181       •   ndm_family
182
183       •   ndm_ifindex
184
185       •   ndm_state
186
187       •   ndm_flags
188
189       •   ndm_type
190
191       Provides the following netlink attributes
192
193       •   dst => STRING
194
195       •   lladdr => STRING
196
197       •   cacheinfo => HASH
198

SEE ALSO

200       •   Socket::Netlink::Route - interface to Linux's "NETLINK_ROUTE"
201           netlink socket protocol
202
203       •   IO::Socket::Netlink - Object interface to "AF_NETLINK" domain
204           sockets
205
206       •   rtnetlink(7) - rtnetlink, NETLINK_ROUTE - Linux IPv4 routing socket
207

AUTHOR

209       Paul Evans <leonerd@leonerd.org.uk>
210
211
212
213perl v5.32.1                      2021-01-27     IO::Socket::Netlink::Route(3)