Skip to main content

Useful CLI commands F5

CLI commands

tmsh on F5 is the CLI tool to get and set all config of the F5. You can get the same configuration options like in the F5 UI.

Use "tmsh" to start an interactive shell or use "tmsh show ..." directly to get an output of the command

The tmsh and tmctl utilities include commands for troubleshooting device trust and device group operations.

Useful CLI command line troubleshooting tools

CommandDescription
tmsh run cm sniff-updatesDisplays the commit ID updates that occur over the configuration management communications channel.
tmsh run cm watch-devicegroup-deviceDisplays information about the devices in the device group to which the local device belongs.
tmsh run cm watch-sys-deviceDisplays information about the local device.
tmsh run cm watch-trafficgroup-deviceDisplays information about the traffic groups associated with devices in a device group.
tmsh sys db configsync.timesyncthresholdDisplays the time threshold for the time difference between devices in the trust domain. If the time difference between devices exceeds the configured threshold value, the BIG-IP system logs an error.
tmsh show cm deviceDisplays the time difference, in seconds, between the local device and each of the other devices in the trust domain.
tmsh show cm traffic-groupDisplays status for all traffic groups on the local device, including the next-active device, the previously-active device, and the reason that an active traffic group is active on its current device. This information is also available with the tmsh cm traffic-group all-properties command.
tmsh show cm sync-statusDisplays the current network connection status, either connected or disconnected.
tmsh show sys ha-mirrorDisplays the current status of mirrored connections.
tmsh show cm failover-statusIn addition to other information, displays log messages when:
  • The local device first receives a SOD status message on its unicast addresses and a multicast address/interface (if any).
  • The local device stops receiving SOD status messages.
  • An interface on the local device begins receiving SOD status messages again.
tmctl sod_tg_conn_statDisplays SOD messaging statistics for each type of message sent and received.
tmctl sod_tg_msg_statDisplays the outgoing packets from the SOD daemon to the other devices in the device group.
tmsh modify cm trust-domain Root add-device { ca-devices true | false ip_address } device-name device_name username admin password admin In addition to adding a device to a trust domain, returns error messages for these conditions:
  • A device with the specified device name already exists in the trust domain.
  • The BIG-IP software version (including hotfix version) on the specified device does not match the version on the local device.
  • The time on the specified device is out of sync with the current device by some number of seconds.
  • A config sync address is not configured on the specified device.