1TEAMDCTL(8)                      teamd control                     TEAMDCTL(8)
2
3
4

NAME

6       teamdctl — team daemon control tool
7

SYNOPSIS

9       teamdctl [options] team_device command [command_args...]
10       teamdctl -h
11

DESCRIPTION

13       teamdctl  is a tool that allows a user to interact with a running teamd
14       instance.  It defaults to using Unix Domain Sockets, but will fall back
15       to  using  the  D-Bus API, to ensure reliable operation in all environ‐
16       ments.
17

OPTIONS

19       -h, --help
20              Print help text to console and exit.
21
22       -v, --verbosity
23              Increase output verbosity.
24
25       -o, --oneline
26              Force output to one line if possible.
27
28       -D, --force-dbus
29              Force to use D-Bus interface.
30
31       -Z address, --force-zmq address
32              Force  to  use  ZMQ  interface.  Possible  address  formats  are
33              "tcp://ip:port",  "ipc://path"  and others. Detailed description
34              of ZMQ library is in page http://zguide.zeromq.org/page:all.
35
36       -U, --force-usock
37              Force to use UNIX domain socket interface. This is  the  default
38              behavior.
39

COMMAND

41       config dump
42              Dumps teamd JSON config.
43
44       config dump noports
45              Dumps teamd JSON configuration without "ports" section included.
46
47       config dump actual
48              Dumps  teamd  actual JSON configuration. It includes ports which
49              are currently present.
50
51       state dump | state
52              Dumps teamd JSON state document.
53
54       state view
55              Prints out state of teamd parsed from JSON state document.
56
57       state item get state_item_path
58              Finds state item in JSON state document and returns its value.
59
60              If PORTIFNAME in state_item_path has  any  sensitive  character,
61              use    double    quotation    marks    to   escape   it,   like:
62              ports."eth1.1".link_watches.up. To  process  state_item_path  of
63              'state item set' is the same as here.
64
65       state item set state_item_path value
66              Finds  state  item  in JSON state document and sets its value by
67              value parameter. This is available only for a limited number  of
68              paths:
69
70              setup.debug_level  —  User  can set debug level. Higher level is
71              more verbose.
72
73              ports.PORTIFNAME.runner.aggregator.selected — This is  available
74              for lacp runner. User can manually select the aggregator.
75
76              runner.active_port  — This is available for activebackup runner.
77              User can manually select the active port.
78
79       port add portdev
80              Takes port device name as argument. Adds port device into team.
81
82       port remove portdev
83              Takes port device name as argument.  Removes  port  device  from
84              team.
85
86       port present portdev
87              Takes port device name as argument. Checks if the port device is
88              present in team.
89
90       port config update portdev portconfig-string
91              Takes port device name as the first  argument  and  JSON  format
92              configuration string as the second argument. Updates port device
93              configuration.
94
95       port config dump portdev
96              Takes port device name as the first argument. Dumps port  device
97              JSON configuration to standard output.
98

SEE ALSO

100       teamd(8), teamnl(8), teamd.conf(5)
101

AUTHOR

103       Jiri Pirko is the original author and current maintainer of libteam.
104
105
106
107libteam                           2013-05-24                       TEAMDCTL(8)