File: //usr/share/doc/ynl/rt-addr.rst
.. LINENO 2
.. SPDX-License-Identifier: GPL-2.0
.. NOTE: This document was auto-generated.
.. _netlink-rt-addr:
========================================
Family ``rt-addr`` netlink specification
========================================
.. contents:: :depth: 3
-------
Summary
-------
Address configuration over rtnetlink.
----------
Operations
----------
.. LINENO 132
.. _rt-addr-operation-newaddr:
newaddr
=======
Add new address
:attribute-set: :ref:`rt-addr-attribute-set-addr-attrs`
:do:
.. LINENO 136
**request**
:attributes: [``address``, ``label``, ``local``, ``cacheinfo``]
.. LINENO 144
.. _rt-addr-operation-deladdr:
deladdr
=======
Remove address
:attribute-set: :ref:`rt-addr-attribute-set-addr-attrs`
:do:
.. LINENO 148
**request**
:attributes: [``address``, ``local``]
.. LINENO 154
.. _rt-addr-operation-getaddr:
getaddr
=======
Dump address information.
:attribute-set: :ref:`rt-addr-attribute-set-addr-attrs`
:dump:
.. LINENO 158
**request**
:attributes: []
**reply**
:attributes: [``address``, ``label``, ``local``, ``cacheinfo``]
.. LINENO 165
.. _rt-addr-operation-getmulticast:
getmulticast
============
Get / dump IPv4/IPv6 multicast addresses.
:attribute-set: :ref:`rt-addr-attribute-set-addr-attrs`
:fixed-header: :ref:`rt-addr-definition-ifaddrmsg`
:do:
.. LINENO 170
**request**
:attributes: []
**reply**
:attributes: [``multicast``, ``cacheinfo``]
:dump:
.. LINENO 179
**request**
:attributes: []
**reply**
:attributes: [``multicast``, ``cacheinfo``]
----------------
Multicast groups
----------------
- rtnlgrp-ipv4-ifaddr
- rtnlgrp-ipv6-ifaddr
-----------
Definitions
-----------
.. LINENO 12
.. _rt-addr-definition-ifaddrmsg:
ifaddrmsg
=========
:type: struct
:members:
:ifa-family (``u8``):
:ifa-prefixlen (``u8``):
:ifa-flags (``u8``):
:ifa-scope (``u8``):
:ifa-index (``u32``):
.. LINENO 33
.. _rt-addr-definition-ifa-cacheinfo:
ifa-cacheinfo
=============
:type: struct
:members:
:ifa-prefered (``u32``):
:ifa-valid (``u32``):
:cstamp (``u32``):
:tstamp (``u32``):
.. LINENO 50
.. _rt-addr-definition-ifa-flags:
ifa-flags
=========
:type: flags
:name-prefix: ifa-f-
:enum-name: None
:entries:
:secondary:
:nodad:
:optimistic:
:dadfailed:
:homeaddress:
:deprecated:
:tentative:
:permanent:
:managetempaddr:
:noprefixroute:
:mcautojoin:
:stable-privacy:
--------------
Attribute sets
--------------
.. _rt-addr-attribute-set-addr-attrs:
addr-attrs
==========
.. LINENO 86
address (``binary``)
~~~~~~~~~~~~~~~~~~~~
:display-hint: ipv4
.. LINENO 90
local (``binary``)
~~~~~~~~~~~~~~~~~~
:display-hint: ipv4
.. LINENO 94
label (``string``)
~~~~~~~~~~~~~~~~~~
.. LINENO 97
broadcast (``binary``)
~~~~~~~~~~~~~~~~~~~~~~
:display-hint: ipv4
.. LINENO 101
anycast (``binary``)
~~~~~~~~~~~~~~~~~~~~
.. LINENO 104
cacheinfo (``binary``)
~~~~~~~~~~~~~~~~~~~~~~
:struct: :ref:`rt-addr-definition-ifa-cacheinfo`
.. LINENO 108
multicast (``binary``)
~~~~~~~~~~~~~~~~~~~~~~
.. LINENO 111
flags (``u32``)
~~~~~~~~~~~~~~~
:enum: :ref:`rt-addr-definition-ifa-flags`
:enum-as-flags: True
.. LINENO 116
rt-priority (``u32``)
~~~~~~~~~~~~~~~~~~~~~
.. LINENO 119
target-netnsid (``binary``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. LINENO 122
proto (``u8``)
~~~~~~~~~~~~~~