File: //usr/share/doc/ynl/team.rst
.. LINENO 2
.. SPDX-License-Identifier: GPL-2.0
.. NOTE: This document was auto-generated.
.. _netlink-team:
=====================================
Family ``team`` netlink specification
=====================================
.. contents:: :depth: 3
-------
Summary
-------
Network team device driver.
----------
Operations
----------
.. LINENO 152
.. _team-operation-noop:
noop
====
No operation
:value: 0
:attribute-set: :ref:`team-attribute-set-team`
:dont-validate: ['strict']
:do:
.. LINENO 160
**reply**
:attributes: [``team-ifindex``]
.. LINENO 165
.. _team-operation-options-set:
options-set
===========
Set team options
:attribute-set: :ref:`team-attribute-set-team`
:dont-validate: ['strict']
:flags: [``admin-perm``]
:do:
.. LINENO 172
**request**
:attributes: [``team-ifindex``, ``list-option``]
**reply**
:attributes: [``team-ifindex``, ``list-option``]
.. LINENO 179
.. _team-operation-options-get:
options-get
===========
Get team options info
:attribute-set: :ref:`team-attribute-set-team`
:dont-validate: ['strict']
:flags: [``admin-perm``]
:do:
.. LINENO 186
**request**
:attributes: [``team-ifindex``]
**reply**
:attributes: [``team-ifindex``, ``list-option``]
.. LINENO 192
.. _team-operation-port-list-get:
port-list-get
=============
Get team ports info
:attribute-set: :ref:`team-attribute-set-team`
:dont-validate: ['strict']
:flags: [``admin-perm``]
:do:
.. LINENO 199
**request**
:attributes: [``team-ifindex``]
**reply**
:attributes: [``team-ifindex``, ``list-port``]
-----------
Definitions
-----------
.. LINENO 16
.. _team-definition-string-max-len:
string-max-len
==============
:type: const
:value: 32
.. LINENO 20
.. _team-definition-genl-change-event-mc-grp-name:
genl-change-event-mc-grp-name
=============================
:type: const
:value: change_event
--------------
Attribute sets
--------------
.. _team-attribute-set-team:
team
====
The team nested layout of get/set msg looks like::
[TEAM_ATTR_LIST_OPTION]
[TEAM_ATTR_ITEM_OPTION]
[TEAM_ATTR_OPTION_*], ...
[TEAM_ATTR_ITEM_OPTION]
[TEAM_ATTR_OPTION_*], ...
...
[TEAM_ATTR_LIST_PORT]
[TEAM_ATTR_ITEM_PORT]
[TEAM_ATTR_PORT_*], ...
[TEAM_ATTR_ITEM_PORT]
[TEAM_ATTR_PORT_*], ...
...
.. LINENO 46
unspec (``unused``)
~~~~~~~~~~~~~~~~~~~
:value: 0
.. LINENO 50
team-ifindex (``u32``)
~~~~~~~~~~~~~~~~~~~~~~
.. LINENO 53
list-option (``nest``)
~~~~~~~~~~~~~~~~~~~~~~
:nested-attributes: :ref:`team-attribute-set-item-option`
.. LINENO 57
list-port (``nest``)
~~~~~~~~~~~~~~~~~~~~
:nested-attributes: :ref:`team-attribute-set-item-port`
.. _team-attribute-set-item-option:
item-option
===========
.. LINENO 67
option-unspec (``unused``)
~~~~~~~~~~~~~~~~~~~~~~~~~~
:value: 0
.. LINENO 71
option (``nest``)
~~~~~~~~~~~~~~~~~
:nested-attributes: :ref:`team-attribute-set-attr-option`
.. _team-attribute-set-attr-option:
attr-option
===========
.. LINENO 79
unspec (``unused``)
~~~~~~~~~~~~~~~~~~~
:value: 0
.. LINENO 83
name (``string``)
~~~~~~~~~~~~~~~~~
.. LINENO 89
changed (``flag``)
~~~~~~~~~~~~~~~~~~
.. LINENO 92
type (``u8``)
~~~~~~~~~~~~~
.. LINENO 95
data (``binary``)
~~~~~~~~~~~~~~~~~
.. LINENO 98
removed (``flag``)
~~~~~~~~~~~~~~~~~~
.. LINENO 101
port-ifindex (``u32``)
~~~~~~~~~~~~~~~~~~~~~~
:doc: for per-port options
.. LINENO 105
array-index (``u32``)
~~~~~~~~~~~~~~~~~~~~~
:doc: for array options
.. _team-attribute-set-item-port:
item-port
=========
.. LINENO 115
port-unspec (``unused``)
~~~~~~~~~~~~~~~~~~~~~~~~
:value: 0
.. LINENO 119
port (``nest``)
~~~~~~~~~~~~~~~
:nested-attributes: :ref:`team-attribute-set-attr-port`
.. _team-attribute-set-attr-port:
attr-port
=========
.. LINENO 127
unspec (``unused``)
~~~~~~~~~~~~~~~~~~~
:value: 0
.. LINENO 131
ifindex (``u32``)
~~~~~~~~~~~~~~~~~
.. LINENO 134
changed (``flag``)
~~~~~~~~~~~~~~~~~~
.. LINENO 137
linkup (``flag``)
~~~~~~~~~~~~~~~~~
.. LINENO 140
speed (``u32``)
~~~~~~~~~~~~~~~
.. LINENO 143
duplex (``u8``)
~~~~~~~~~~~~~~~
.. LINENO 146
removed (``flag``)
~~~~~~~~~~~~~~~~~~