Symbols ![]()
loading...
Files ![]()
loading...
ot::Cli::Br::Process()
@cli br counters
br counters
Inbound Unicast: Packets 4 Bytes 320
Inbound Multicast: Packets 0 Bytes 0
Outbound Unicast: Packets 2 Bytes 160
Outbound Multicast: Packets 0 Bytes 0
RA Rx: 4
RA TxSuccess: 2
RA TxFailed: 0
RS Rx: 0
RS TxSuccess: 2
RS TxFailed: 0
Done
@par api_copy #otIp6GetBorderRoutingCountersSyntax
Implemented in ![]()
cli_br.cpp:56
Related Functions
Found 49 other functions taking a ![]()
Arg
argument:
Function
Description
@cli joinerport
joinerport
1000
Done
@par api_copy #otThreadGetJoinerUdpPort @cli srp server seqnum (get,set)
srp server seqnum 20
Done
srp server seqnum
20
Done
@cparam srp server seqnum [@ca{seqnum}] @par Gets or sets the sequence number used with the anycast address mode. The sequence number is included in the "DNS/SRP Service Anycast Address" entry that is published in the Network Data. @sa otSrpServerGetAnycastModeSequenceNumber @sa otSrpServerSetAnycastModeSequenceNumber @cli srp client ttl (get,set)
srp client ttl 3600
Done
srp client ttl
3600
Done
@cparam srp client ttl [@ca{value}] @par Gets or sets the `ttl`(time to live) value in seconds. @sa otSrpClientGetTtl @sa otSrpClientSetTtl @cli coap delete
coap delete fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done
@cparam coap delete @ca{address} @ca{uri-path} [@ca{type}] [@ca{payload}] * `address`: IPv6 address of the CoAP server. * `uri-path`: URI path of the resource. * `type`: * `con`: Confirmable * `non-con`: Non-confirmable (default) * `payload`: The CoAP payload string. For example, `hellothere`. @par Deletes the specified CoAP resource. @cli dataset tlvs
dataset tlvs
0e080000000000010000000300001635060004001fffe0020...f7f8
Done
@par api_copy #otDatasetConvertToTlvs @cli bbr config
bbr config
seqno: 10
delay: 120 secs
timeout: 300 secs
Done
@par api_copy #otBackboneRouterGetConfig @cli dns servicehost @cparam dns servicehost @ca{service-instance-label} @ca{service-name} <!-- --> [@ca{DNS-server-IP}] [@ca{DNS-server-port}] <!-- --> [@ca{response-timeout-ms}] [@ca{max-tx-attempts}] <!-- --> [@ca{recursion-desired-boolean}] @par api_copy #otDnsClientResolveServiceAndHostAddress @par Send a service instance resolution DNS query for a given service instance with potential follow-up host name resolution. Service instance label is provided first, followed by the service name (note that service instance label can contain dot '.' character). @par The parameters after `service-name` are optional. Any unspecified (or zero) value for these optional parameters is replaced by the value from the current default config (`dns config`). @par Note: The DNS server IP can be an IPv4 address, which will be synthesized to an IPv6 address using the preferred NAT64 prefix from the network data. The command will return `InvalidState` when the DNS server IP is an IPv4 address but the preferred NAT64 prefix is unavailable. `OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE` is required.
@cli netdata show
netdata show
Prefixes:
fd00:dead:beef:cafe::/64 paros med dc00
Routes:
fd49:7770:7fc5:0::/64 s med 4000
Services:
44970 5d c000 s 4000 0
44970 01 9a04b000000e10 s 4000 1
Contexts:
fd00:dead:beef:cafe::/64 1 c
Commissioning:
1248 dc00 9988 00000000000120000000000000000000 e
Done
netdata show -x
08040b02174703140040fd00deadbeefcafe0504dc00330007021140
Done
netdata show 0xdc00
Prefixes:
fd00:dead:beef:cafe::/64 paros med dc00
Routes:
Services:
Done
@cparam netdata show [@ca{-x}|@ca{rloc16}]
* The optional `-x` argument gets Network Data as hex-encoded TLVs.
* The optional `rloc16` argument gets all prefix/route/service entries associated with a given RLOC16.
@par
`netdata show` from OT CLI gets full Network Data received from the Leader. This command uses several
API functions to combine prefixes, routes, and services, including #otNetDataGetNextOnMeshPrefix,
#otNetDataGetNextRoute, #otNetDataGetNextService and #otNetDataGetNextLowpanContextInfo.
@par
On-mesh prefixes are listed under `Prefixes` header:
* The on-mesh prefix
* Flags
* p: Preferred flag
* a: Stateless IPv6 Address Autoconfiguration flag
* d: DHCPv6 IPv6 Address Configuration flag
* c: DHCPv6 Other Configuration flag
* r: Default Route flag
* o: On Mesh flag
* s: Stable flag
* n: Nd Dns flag
* D: Domain Prefix flag (only available for Thread 1.2).
* Preference `high`, `med`, or `low`
* RLOC16 of device which added the on-mesh prefix
@par
External Routes are listed under `Routes` header:
* The route prefix
* Flags
* s: Stable flag
* n: NAT64 flag
* Preference `high`, `med`, or `low`
* RLOC16 of device which added the route prefix
@par
Service entries are listed under `Services` header:
* Enterprise number
* Service data (as hex bytes)
* Server data (as hex bytes)
* Flags
* s: Stable flag
* RLOC16 of devices which added the service entry
* Service ID
@par
6LoWPAN Context IDs are listed under `Contexts` header:
* The prefix
* Context ID
* Compress flag (`c` if marked or `-` otherwise).
@par
Commissioning Dataset information is printed under `Commissioning` header:
* Session ID if present in Dataset or `-` otherwise
* Border Agent RLOC16 (in hex) if present in Dataset or `-` otherwise
* Joiner UDP port number if present in Dataset or `-` otherwise
* Steering Data (as hex bytes) if present in Dataset or `-` otherwise
* Flags:
* e: If Dataset contains any extra unknown TLV
@par
@moreinfo{@netdata}.
@csa{br omrprefix}
@csa{br onlinkprefix}
@sa otBorderRouterGetNetData
@cli udp send
udp send hello
Done
udp send -t hello
Done
udp send -x 68656c6c6f
Done
udp send -s 800
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 hello
Done
udp send 172.17.0.1 1234 hello
Sending to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -t hello
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -x 68656c6c6f
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -s 800
Done
@cparam udp send [@ca{ip} @ca{port}] [@ca{type}] @ca{value} The `ip` and `port` are optional as a pair, but if you specify one you must specify the other. If `ip` and `port` are not specified, the socket peer address is used from `udp connect`. - `ip`: Destination address. This address can be either an IPv4 or IPv6 address, An IPv4 address gets synthesized to an IPv6 address with the preferred NAT64 prefix from the network data. (If the preferred NAT64 prefix is unavailable, the command returns `InvalidState`). - `port`: UDP destination port. - `type`/`value` combinations: - `-t`: The payload in the `value` parameter is treated as text. If no `type` value is entered, the payload in the `value` parameter is also treated as text. - `-s`: Auto-generated payload with the specified length given in the `value` parameter. - `-x`: Binary data in hexadecimal representation given in the `value` parameter. @par Sends a UDP message using the socket. @moreinfo{@udp}. @csa{udp open} @csa{udp bind} @csa{udp connect} @sa otUdpSend Checks a given argument string against "enable" or "disable" commands.
Copies the argument string pointers from an `Arg` array to a C string array.
Returns the length of argument array, i.e. number of consecutive non-empty arguments.
Parses a given argument string as a route preference comparing it against "high", "med", or "low".
Parses the argument as an IP address. If the argument string is an IPv4 address, this method will try to synthesize an IPv6 address using preferred NAT64 prefix in the network data.
Parses a given command line string and breaks it into an argument list. May change the input @p aCommandString, it will put a '\0' by the end of each argument, and @p aArgs will point to the arguments in the input @p aCommandString. Backslash ('\') can be used to escape separators (' ', '\t', '\r', '\n') and the backslash itself. As the arguments are parsed, the @p aArgs array entries are populated. Any remaining @p aArgs entries in the array will be cleared and marked as empty. So the number of arguments can be determined by going through @p aArgs array entries till we get to an empty `Arg` (i.e., `Arg::IsEmpty()` returns `true). Ensures that the last entry in @p aArgs array is always used to indicate the end (always marked as empty), so the @p aArgs array should have one more entry than the desired max number of arguments.
Parses the argument as a External Route configuration.
Processes a CLI sub-command.
Parses the argument as a Border Router configuration.
Processes a CLI sub-command.
Parses the argument as a Joiner Discerner.