run
run(1) BIG-IP TMSH Manual run(1)
NAME
run command - Runs the specified program.
MODULE
All tmsh modules.
SYNTAX
Use the run command within tmsh to run a specified utility.
run
options:
/cli script [arguments]
/cm add-to-trust
/cm config-sync
/cm remove-from-trust
/cm sniff-updates
/cm watch-devicegroup-device
/cm watch-sys-device
/cm watch-trafficgroup-device
/gtm big3d_install [arguments]
/gtm bigip_add [arguments]
/gtm gtm_add [arguments]
/ltm monitor [arguments]
/security anti-fraud engine-update
/security anti-fraud signatures-update [arguments]
/sys air-filter-reset
/util bash [arguments]
/util diadb [arguments]
/util dig [arguments]
/util dnat [arguments]
/util get-ccn-dossier
/util get-dossier [arguments]
/util ihealth [arguments]
/util qkcloud [arguments]
/util ipsecalgdb [arguments]
/util lsndb [arguments]
/util netstat [arguments]
/util ping [arguments]
/util ping6 [arguments]
/util qkview [arguments]
/util racoonctl [arguments]
/util sipdb [arguments]
/util ssh-keyswap [arguments]
/util sys-icheck [arguments]
/util tcpdump [arguments]
/util tracepath [arguments]
/util tracepath6 [arguments]
/util traceroute [arguments]
/util traceroute6 [arguments]
/wom diagnose-conn
/wom verify-config
DESCRIPTION
You can use the run command to run the specified program, utility or
process.
You can read about the arguments that are available for the utilities
in the cm module using the following command sequence:
help /cm [utility name]
You can read about the arguments that are available for the utilities
in the gtm module using the following command sequence:
help /gtm [big3d_install | bigip_add | gtm_add]
You can read about the arguments that are available for the utilities
in the ltm module using the following command sequence:
help /ltm monitor [type]
You can read about the arguments that are available for the utilities
in the util module using the following command sequence:
help /util [utility name]
Note: Some tmsh features, such as tab completion, context-sensitive
help, paging, and grep, are not available for utilities.
When you are building a batch mode transaction in tmsh, if you type the
run command, the system runs the specified program immediately. It does
not add the run command to the transaction that you are building.
EXAMPLES
help /util ping
Displays the help page for the ping utility.
OPTIONS
/cli script
Run the specified script, with provided arguments.
/cm add-to-trust
Add a device to a trust domain.
/cm config-sync
Synchronize the configuration between devices.
/cm remove-from-trust
Remove a device from a trust domain.
/cm sniff-updates
Display the commit ID updates that occur over the CMI
communications channel. When you troubleshoot a ConfigSync issue,
it is helpful to determine which device group member has the
latest commit ID update and contains the most recent
configuration. You can then decide whether to replicate the newer
configuration to the group, or perform a ConfigSync operation that
replicates an older configuration to the group, thus overwriting a
newer configuration.
/cm watch-devicegroup-device
Display information about the devices in the device group to which
the local device belongs.
/cm watch-sys-device
Display information about the local device.
/cm watch-trafficgroup-device
Display information about the traffic groups associated with
devices in a device group.
/gtm big3d_install
Specifies to install the big3d daemon.
/gtm bigip_add
Specifies the BIG-IP systems that you want to add to the Global
Traffic Manager configuration.
/gtm gtm_add
Specifies the Global Traffic Manager systems that you want to add
to the Global Traffic Manager configuration.
/ltm monitor
Performs a one-shot test of a custom LTM health monitor against a
specified target node.
/security anti-fraud engine-update
For the description and syntax see the help page for security
anti-fraud engine-update.
/security anti-fraud signatures-update
For the description and syntax see the help page for security
anti-fraud signatures-update.
/sys air-filter-reset
Runs the command to reset the timer and the retry counter for air
filter notifications.
/util bash
Accesses the system shell.
/util diadb
Displays Diameter persistence entries. The diadb utility displays
diameter persistence entries or delete a particular persistence
entry.
/util dig
Runs the specified dig command. The dig utility queries DNS name
servers.
/util dnat
Runs the specified dnat command for the purpose of doing
forward/reverse mapping of addresses for DNAT.
/util get-ccn-dossier
Runs the get_ccn_dossier utility for the purpose of displaying
system information for dossier creation.
/util get-dossier
Runs the get_dossier utility for the purpose of displaying system
license dossier information.
/util ihealth
Runs the ihealth utility for the purpose of uploading a new or
existent qkview file to ihealth.
/util qkcloud
Runs the qkcloud utility for the purpose of displaying cloud meta-
data.
/util ipsecalgdb
Runs the ipsecalgdb utility to view IPsecALG translation, and
pending IKE connection count entries.
/util lsndb
Runs the lsndb utility to view Large Scale NAT persistence
entries, inbound mappings, client connection counts, and PCP
mappings.
/util netstat
Displays network connections, routing tables, interface
statistics, masquerade connections, and multicast memberships.
/util ping
Runs the specified ping command. The ping utility sends ICMP echo
requests to network hosts.
/util ping6
Runs the specified ping6 command. The ping6 utility sends ICMPv6
echo requests to network hosts.
/util qkview
Runs the specified qkview command. The qkview utility gathers
diagnostic information from a BIG-IP system.
/util racoonctl
Runs the specified racoonctl command. The racoonctl utility is
used to control operation of the racoon daemon.
/util sipdb
Displays SIP persistence entries. The sipdb utility displays
specific persistence entries and deletes a particular persistence
record.
/util ssh-keyswap
Runs the keyswap.sh script for managing SSH keys on the BIG-IP.
/util sys-icheck
Runs the specified sys-icheck command. The sys-icheck utility
verifies all RPM packages and files.
/util tcpdump
Runs the specified tcpdump command. The tcpdump utility prints
headers and content of network traffic.
/util tracepath
Displays the route packets take to a network host.
/util tracepath6
Displays the route packets take to an IPv6 network host.
/util traceroute
Displays the route packets take to a network host.
/util traceroute6
Displays the route packets take to an IPv6 network host.
/wom diagnose-conn
Runs the specified diagnose-conn script, which detects the sources
of network connection and performance problems in a WAN
optimization configuration.
/wom verify-config
Runs the specified verify-config script, which detects errors in
the configuration of the WAN Optimization Manager.
SEE ALSO
cli script, cm add-to-trust, cm config-sync, cm remove-from-trust, cm
sniff-updates, cm watch-devicegroup-device, cm watch-sys-device, cm
watch-trafficgroup-device, gtm big3d_install, gtm bigip_add, gtm
gtm_add, ltm monitor, security anti-fraud engine-update, security anti-
fraud signatures-update, util bash, util diadb, util dig, util dnat,
util ihealth, util qkcloud, util ipsecalgdb, util lsndb, util netstat,
util ping, util ping6, util qkview, util racoonctl, util sipdb, util
ssh-keyswap, util sys-icheck, util tcpdump, util tracepath, util
tracepath6, util traceroute, util traceroute6, wom diagnose-conn, wom
verify-config
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2013, 2015, 2017. All rights
reserved.
BIG-IP 2018-04-16 run(1)