Table of Contents

How to use tmsh in F5 BIG-IP



Basic

login / quit

# tmsh
(tmos)#
(tmos)#quit
#

Tab : Commands List

# tmsh
(tmos)#
(tmos)#   <- Tab
Modules:
  /             auth          cli           gtm           ltm           net           sys           util          wom
Commands:
  create        exit          list          quit          restart       show          submit
  delete        help          load          reboot        run           start
  edit          install       modify        reset-stats   save          stop
(tmos)#

? : Help

# tmsh
(tmos)# ?
Modules:
  /            TMOS Command Line Interface
  auth         User accounts and authentication
  cli          Local user settings and configuration transactions
  gtm          Global Traffic Manager
  ltm          Local Traffic Manager
  net          Network configuration
  sys          General system configuration
  util         Utility programs that can be run from within tmsh
  wom          WAN Optimization
Commands:
  create       Create new configuration items
  delete       Remove configuration items
  edit         Update configuration using a text editor
  exit         Exit the current command mode
  help         View tmsh man pages
  install      Install an image or hotfix to a volume
  list         View configuration and settings
  load         Replace running configuration with configuration files
  modify       Update existing configuration items
  quit         Quit tmsh
  reboot       Reboot the system
  reset-stats  Reset runtime statistics
  restart      Restart BIG-IP services
  run          Run an external program
  save         Save the running configuration to configuration files
  show         View runtime information, statistics and status
  start        Start BIG-IP services
  stop         Stop BIG-IP services
  submit       Submit a batched transaction
(tmos)#

#
(tmos)# ltm
(tmos.ltm)# ?
Modules:
  /                     TMOS Command Line Interface
  /auth                 User accounts and authentication
  /cli                  Local user settings and configuration transactions
  /gtm                  Global Traffic Manager
  /ltm                  Local Traffic Manager
  /net                  Network configuration
  /sys                  General system configuration
  /util                 Utility programs that can be run from within tmsh
  /wom                  WAN Optimization
  auth                  Virtual server authentication configuration
  global-settings       Local Traffic Manager options
  monitor               LTM monitor templates
  persistence           Virtual server persistence configuration
  profile               Virtual server profile configuration
Components:
  data-group            Data group (aka. Class) Configuration
  default-node-monitor  Configure the default-monitor rule
  nat                   Network address translation configuration
  node                  Node specific pool member configuration
  pool                  Load balancing pool configuration
  rule                  iRules configuration
  snat                  Secure network address translation (SNAT) configuration
  snat-translation      SNAT translation address configuration
  snatpool              Collections of SNAT translation addresses
  traffic-class         Traffic Class Configuration
  virtual               Virtual server configuration
  virtual-address       Virtual server IP address configuration
Commands:
  create                Create new configuration items
  delete                Remove configuration items
  edit                  Update configuration using a text editor
  exit                  Exit the current command mode
  help                  View tmsh man pages
  install               Install an image or hotfix to a volume
  list                  View configuration and settings
  load                  Replace running configuration with configuration files
  modify                Update existing configuration items
  quit                  Quit tmsh
  reboot                Reboot the system
  reset-stats           Reset runtime statistics
  restart               Restart BIG-IP services
  run                   Run an external program
  save                  Save the running configuration to configuration files
  show                  View runtime information, statistics and status
  start                 Start BIG-IP services
  stop                  Stop BIG-IP services
  submit                Submit a batched transaction
(tmos.ltm)# list rule
ltm rule TEST {
(abbr)


How to use tmsh.

Method1
# tmsh show sys version


Method2
# tmsh
(tmos)# show net vlan VLAN_External


Method 3
(tmos)# net
(tmos.net)# self
(tmos.net.self)# list


tmsh tree

/ 
  +--- auth --- ldap
  |             user
  |
  +--- cli ---- history
  |
  |
  +--- gtm ---   pool
  |              link
  |
  |
  +--- ltm --- node
  |            pool
  |            virtual
  |
  +--- net --- vlan
  |            route
  |
  +--- sys --- log
  |            httpd
  |
  +-- util --- ping
  |            dig
  |
  +--- wom --- verify-config