| 1 |
.TH TEAMDCTL 8 "2013-05-24" "libteam" "teamd control" |
| 2 |
.SH NAME |
| 3 |
teamdctl \(em team daemon control tool |
| 4 |
.SH SYNOPSIS |
| 5 |
.B teamdctl |
| 6 |
.RI [ options ] |
| 7 |
.IR "team_device command " [ command_args ...] |
| 8 |
.br |
| 9 |
.B teamdctl \-h |
| 10 |
.SH DESCRIPTION |
| 11 |
.PP |
| 12 |
teamdctl is a tool that allows a user to interact with a running teamd instance. |
| 13 |
It defaults to using Unix Domain Sockets, but will fall back to using the D-Bus API, |
| 14 |
to ensure reliable operation in all environments. |
| 15 |
.SH OPTIONS |
| 16 |
.TP |
| 17 |
.B "\-h, \-\-help" |
| 18 |
Print help text to console and exit. |
| 19 |
.TP |
| 20 |
.B "\-v, \-\-verbosity" |
| 21 |
Increase output verbosity. |
| 22 |
.TP |
| 23 |
.B "\-o, \-\-oneline" |
| 24 |
Force output to one line if possible. |
| 25 |
.TP |
| 26 |
.B "\-D, \-\-force-dbus" |
| 27 |
Force to use D-Bus interface. |
| 28 |
.TP |
| 29 |
.BI "\-Z " address ", \-\-force-zmq " address |
| 30 |
Force to use ZMQ interface. Possible address formats are "tcp://ip:port", "ipc://path" and others. Detailed description of ZMQ library is in page http://zguide.zeromq.org/page:all. |
| 31 |
.TP |
| 32 |
.B "\-U, \-\-force-usock" |
| 33 |
Force to use UNIX domain socket interface. This is the default behavior. |
| 34 |
.SH COMMAND |
| 35 |
.TP |
| 36 |
.B "config dump" |
| 37 |
Dumps teamd JSON config. |
| 38 |
.TP |
| 39 |
.B "config dump noports" |
| 40 |
Dumps teamd JSON configuration without "ports" section included. |
| 41 |
.TP |
| 42 |
.B "config dump actual" |
| 43 |
Dumps teamd actual JSON configuration. It includes ports which are currently present. |
| 44 |
.TP |
| 45 |
.B "state dump" | "state" |
| 46 |
Dumps teamd JSON state document. |
| 47 |
.TP |
| 48 |
.B "state view" |
| 49 |
Prints out state of teamd parsed from JSON state document. |
| 50 |
.TP |
| 51 |
.BI "state item get " state_item_path |
| 52 |
Finds state item in JSON state document and returns its value. |
| 53 |
|
| 54 |
If PORTIFNAME in state_item_path has any sensitive character, use double quotation marks to escape it, like: ports."eth1.1".link_watches.up. To process state_item_path of 'state item set' is the same as here. |
| 55 |
.TP |
| 56 |
.BI "state item set " "state_item_path value" |
| 57 |
Finds state item in JSON state document and sets its value by value parameter. This is available only for a limited number of paths: |
| 58 |
.RS 7 |
| 59 |
.PP |
| 60 |
.BR "setup.debug_level "\(em |
| 61 |
User can set debug level. Higher level is more verbose. |
| 62 |
.PP |
| 63 |
.BR "ports.PORTIFNAME.runner.aggregator.selected "\(em |
| 64 |
This is available for lacp runner. User can manually select the aggregator. |
| 65 |
.PP |
| 66 |
.BR "runner.active_port "\(em |
| 67 |
This is available for activebackup runner. User can manually select the active port. |
| 68 |
.RE |
| 69 |
.TP |
| 70 |
.BI "port add " portdev |
| 71 |
Takes port device name as argument. Adds port device into team. |
| 72 |
.TP |
| 73 |
.BI "port remove " portdev |
| 74 |
Takes port device name as argument. Removes port device from team. |
| 75 |
.TP |
| 76 |
.BI "port present " portdev |
| 77 |
Takes port device name as argument. Checks if the port device is present in team. |
| 78 |
.TP |
| 79 |
.BI "port config update " "portdev portconfig-string" |
| 80 |
Takes port device name as the first argument and JSON format configuration |
| 81 |
string as the second argument. Updates port device configuration. |
| 82 |
.TP |
| 83 |
.BI "port config dump " portdev |
| 84 |
Takes port device name as the first argument. Dumps port device JSON configuration to standard output. |
| 85 |
.SH SEE ALSO |
| 86 |
.BR teamd (8), |
| 87 |
.BR teamnl (8), |
| 88 |
.BR teamd.conf (5) |
| 89 |
.SH AUTHOR |
| 90 |
.PP |
| 91 |
Jiri Pirko is the original author and current maintainer of libteam. |