.. LINENO 2

.. SPDX-License-Identifier: GPL-2.0
.. NOTE: This document was auto-generated.


.. _netlink-rt-route:


=========================================
Family ``rt-route`` netlink specification
=========================================


.. contents:: :depth: 3


-------
Summary
-------


Route configuration over rtnetlink.

----------
Operations
----------


.. LINENO 248

.. _rt-route-operation-getroute:

getroute
========
Dump route information.

:attribute-set: :ref:`rt-route-attribute-set-route-attrs`
:do:
.. LINENO 252

    **request**
        :attributes: [``src``, ``dst``, ``iif``, ``oif``, ``ip-proto``, ``sport``, ``dport``, ``mark``, ``uid``]

    **reply**
        :attributes: [``dst``, ``src``, ``iif``, ``oif``, ``gateway``, ``priority``, ``prefsrc``, ``metrics``, ``multipath``, ``flow``, ``cacheinfo``, ``table``, ``mark``, ``mfc-stats``, ``via``, ``newdst``, ``pref``, ``encap-type``, ``encap``, ``expires``, ``pad``, ``uid``, ``ttl-propagate``, ``ip-proto``, ``sport``, ``dport``, ``nh-id``]

:dump:
.. LINENO 295

    **request**
        :attributes: []

    **reply**
        :attributes: [``dst``, ``src``, ``iif``, ``oif``, ``gateway``, ``priority``, ``prefsrc``, ``metrics``, ``multipath``, ``flow``, ``cacheinfo``, ``table``, ``mark``, ``mfc-stats``, ``via``, ``newdst``, ``pref``, ``encap-type``, ``encap``, ``expires``, ``pad``, ``uid``, ``ttl-propagate``, ``ip-proto``, ``sport``, ``dport``, ``nh-id``]



.. LINENO 302

.. _rt-route-operation-newroute:

newroute
========
Create a new route

:attribute-set: :ref:`rt-route-attribute-set-route-attrs`
:do:
.. LINENO 306

    **request**
        :attributes: [``dst``, ``src``, ``iif``, ``oif``, ``gateway``, ``priority``, ``prefsrc``, ``metrics``, ``multipath``, ``flow``, ``cacheinfo``, ``table``, ``mark``, ``mfc-stats``, ``via``, ``newdst``, ``pref``, ``encap-type``, ``encap``, ``expires``, ``pad``, ``uid``, ``ttl-propagate``, ``ip-proto``, ``sport``, ``dport``, ``nh-id``]



.. LINENO 310

.. _rt-route-operation-delroute:

delroute
========
Delete an existing route

:attribute-set: :ref:`rt-route-attribute-set-route-attrs`
:do:
.. LINENO 314

    **request**
        :attributes: [``dst``, ``src``, ``iif``, ``oif``, ``gateway``, ``priority``, ``prefsrc``, ``metrics``, ``multipath``, ``flow``, ``cacheinfo``, ``table``, ``mark``, ``mfc-stats``, ``via``, ``newdst``, ``pref``, ``encap-type``, ``encap``, ``expires``, ``pad``, ``uid``, ``ttl-propagate``, ``ip-proto``, ``sport``, ``dport``, ``nh-id``]




-----------
Definitions
-----------


.. LINENO 12

.. _rt-route-definition-rtm-type:

rtm-type
========
:name-prefix: rtn-
:enum-name: None
:type: enum


:entries:
    - ``unspec``
    - ``unicast``
    - ``local``
    - ``broadcast``
    - ``anycast``
    - ``multicast``
    - ``blackhole``
    - ``unreachable``
    - ``prohibit``
    - ``throw``
    - ``nat``
    - ``xresolve``


.. LINENO 30

.. _rt-route-definition-rtmsg:

rtmsg
=====
:type: struct


:members:
    :rtm-family (``u8``): 
    :rtm-dst-len (``u8``): 
    :rtm-src-len (``u8``): 
    :rtm-tos (``u8``): 
    :rtm-table (``u8``): 
    :rtm-protocol (``u8``): 
    :rtm-scope (``u8``): 
    :rtm-type (``u8``): 
    :rtm-flags (``u32``): 


.. LINENO 62

.. _rt-route-definition-rta-cacheinfo:

rta-cacheinfo
=============
:type: struct


:members:
    :rta-clntref (``u32``): 
    :rta-lastuse (``u32``): 
    :rta-expires (``u32``): 
    :rta-error (``u32``): 
    :rta-used (``u32``): 



--------------
Attribute sets
--------------


.. _rt-route-attribute-set-route-attrs:

route-attrs
===========
.. LINENO 87

dst (``binary``)
~~~~~~~~~~~~~~~~
:display-hint: ipv4


.. LINENO 91

src (``binary``)
~~~~~~~~~~~~~~~~
:display-hint: ipv4


.. LINENO 95

iif (``u32``)
~~~~~~~~~~~~~


.. LINENO 98

oif (``u32``)
~~~~~~~~~~~~~


.. LINENO 101

gateway (``binary``)
~~~~~~~~~~~~~~~~~~~~
:display-hint: ipv4


.. LINENO 105

priority (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 108

prefsrc (``binary``)
~~~~~~~~~~~~~~~~~~~~
:display-hint: ipv4


.. LINENO 112

metrics (``nest``)
~~~~~~~~~~~~~~~~~~
:nested-attributes: :ref:`rt-route-attribute-set-metrics`


.. LINENO 116

multipath (``binary``)
~~~~~~~~~~~~~~~~~~~~~~


.. LINENO 119

protoinfo (``binary``)
~~~~~~~~~~~~~~~~~~~~~~


.. LINENO 122

flow (``u32``)
~~~~~~~~~~~~~~


.. LINENO 125

cacheinfo (``binary``)
~~~~~~~~~~~~~~~~~~~~~~
:struct: :ref:`rt-route-definition-rta-cacheinfo`


.. LINENO 129

session (``binary``)
~~~~~~~~~~~~~~~~~~~~


.. LINENO 132

mp-algo (``binary``)
~~~~~~~~~~~~~~~~~~~~


.. LINENO 135

table (``u32``)
~~~~~~~~~~~~~~~


.. LINENO 138

mark (``u32``)
~~~~~~~~~~~~~~


.. LINENO 141

mfc-stats (``binary``)
~~~~~~~~~~~~~~~~~~~~~~


.. LINENO 144

via (``binary``)
~~~~~~~~~~~~~~~~


.. LINENO 147

newdst (``binary``)
~~~~~~~~~~~~~~~~~~~


.. LINENO 150

pref (``u8``)
~~~~~~~~~~~~~


.. LINENO 153

encap-type (``u16``)
~~~~~~~~~~~~~~~~~~~~


.. LINENO 156

encap (``binary``)
~~~~~~~~~~~~~~~~~~


.. LINENO 159

expires (``u32``)
~~~~~~~~~~~~~~~~~


.. LINENO 162

pad (``binary``)
~~~~~~~~~~~~~~~~


.. LINENO 165

uid (``u32``)
~~~~~~~~~~~~~


.. LINENO 168

ttl-propagate (``u8``)
~~~~~~~~~~~~~~~~~~~~~~


.. LINENO 171

ip-proto (``u8``)
~~~~~~~~~~~~~~~~~


.. LINENO 174

sport (``u16``)
~~~~~~~~~~~~~~~


.. LINENO 177

dport (``u16``)
~~~~~~~~~~~~~~~


.. LINENO 180

nh-id (``u32``)
~~~~~~~~~~~~~~~


.. _rt-route-attribute-set-metrics:

metrics
=======
.. LINENO 187

unspec (``unused``)
~~~~~~~~~~~~~~~~~~~
:value: 0


.. LINENO 191

lock (``u32``)
~~~~~~~~~~~~~~


.. LINENO 194

mtu (``u32``)
~~~~~~~~~~~~~


.. LINENO 197

window (``u32``)
~~~~~~~~~~~~~~~~


.. LINENO 200

rtt (``u32``)
~~~~~~~~~~~~~


.. LINENO 203

rttvar (``u32``)
~~~~~~~~~~~~~~~~


.. LINENO 206

ssthresh (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 209

cwnd (``u32``)
~~~~~~~~~~~~~~


.. LINENO 212

advmss (``u32``)
~~~~~~~~~~~~~~~~


.. LINENO 215

reordering (``u32``)
~~~~~~~~~~~~~~~~~~~~


.. LINENO 218

hoplimit (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 221

initcwnd (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 224

features (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 227

rto-min (``u32``)
~~~~~~~~~~~~~~~~~


.. LINENO 230

initrwnd (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 233

quickack (``u32``)
~~~~~~~~~~~~~~~~~~


.. LINENO 236

cc-algo (``string``)
~~~~~~~~~~~~~~~~~~~~


.. LINENO 239

fastopen-no-cookie (``u32``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~