Traffic Management Shell (tmsh) Reference Guidesupport.f5.com/content/kb/en-us/products/big-ip_ltm/manuals/... · Traffic Management Shell (tmsh) Reference Guide iii ... network-access

Traffic Management Shell (tmsh)Reference Guide

version 11.2.1

MAN-0306-04

Product VersionThis manual applies to version 11.2.1 of the BIG-IP product family.

Publication DateThis manual was published on August 29, 2012.

Legal Notices

CopyrightCopyright 2012, F5 Networks, Inc. All rights reserved.

F5 Networks, Inc. (F5) believes the information it furnishes to be accurate and reliable. However, F5assumes no responsibility for the use of this information, nor any infringement of patents or other rights ofthird parties which may result from its use. No license is granted by implication or otherwise under anypatent, copyright, or other intellectual property right of F5 except as specifically described by applicableuser licenses. F5 reserves the right to change specifications at any time without notice.

Trademarks3DNS, Access Policy Manager, Acopia, Acopia Networks, Advanced Client Authentication, AdvancedRouting, APM, Application Security Manager, ARX, AskF5, ASM, BIG-IP, Cloud Extender,CloudFucious, Clustered Multiprocessing, CMP, COHESION, Data Manager, DevCentral, DevCentral[DESIGN], DSI, DNS Express, DSC, Edge Client, Edge Gateway, Edge Portal, ELEVATE, EM,Enterprise Manager, ENGAGE, F5, F5 [DESIGN], F5 Management Pack, F5 Networks, F5 World, FastApplication Proxy, Fast Cache, FirePass, Global Traffic Manager, GTM, GUARDIAN, IBR, IntelligentBrowser Referencing, Intelligent Compression, IPv6 Gateway, iApps, iControl, iHealth, iQuery, iRules,iRules OnDemand, iSession, IT agility. Your way., L7 Rate Shaping, LC, Link Controller, Local TrafficManager, LTM, Message Security Module, MSM, Netcelera, OneConnect, OpenBloX, OpenBloX[DESIGN], Packet Velocity, Protocol Security Module, PSM, Real Traffic Policy Builder, RosettaDiameter Gateway, ScaleN, Signaling Delivery Controller, SDC, SSL Acceleration, StrongBox,SuperVIP, SYN Check, TCP Express, TDR, TMOS, Traffic Management Operating System,TrafficShield, Traffix Diameter Load Balancer, Traffix Systems, Traffix Systems (DESIGN), TransparentData Reduction, UNITY, VAULT, VIPRION, vCMP, virtual Clustered Multiprocessing, WA, WANOptimization Manager, WANJet, WebAccelerator, WOM, and ZoneRunner, are trademarks or servicemarks of F5 Networks, Inc., in the U.S. and other countries, and may not be used without F5's expresswritten consent.

All other product and company names herein may be trademarks of their respective owners.

Export Regulation NoticeThis product may include cryptographic software. Under the Export Administration Act, the United Statesgovernment may consider it a criminal offense to export this product from the United States.

RF Interference WarningThis is a Class A product. In a domestic environment this product may cause radio interference, in whichcase the user may be required to take adequate measures.

FCC ComplianceThis equipment has been tested and found to comply with the limits for a Class A digital device pursuantto Part 15 of FCC rules. These limits are designed to provide reasonable protection against harmfulinterference when the equipment is operated in a commercial environment. This unit generates, uses, andcan radiate radio frequency energy and, if not installed and used in accordance with the instruction manual,

Traffic Management Shell (tmsh) Reference Guide i

may cause harmful interference to radio communications. Operation of this equipment in a residential areais likely to cause harmful interference, in which case the user, at his own expense, will be required to takewhatever measures may be required to correct the interference.

Any modifications to this device, unless expressly approved by the manufacturer, can void the user'sauthority to operate this equipment under part 15 of the FCC rules.

Canadian Regulatory ComplianceThis class A digital apparatus complies with Canadian I CES-003.

Standards ComplianceThis product conforms to the IEC, European Union, ANSI/UL and Canadian CSA standards applicable toInformation Technology products at the time of manufacture.

AcknowledgmentsThis product includes software developed by the University of California, Berkeley and its contributors.

This product includes software developed by the Computer Systems Engineering Group at the LawrenceBerkeley Laboratory.

This product includes software developed by the NetBSD Foundation, Inc. and its contributors.

This product includes software developed by Christopher G. Demetriou for the NetBSD Project.

This product includes software developed by Adam Glass.

This product includes software developed by Christian E. Hopps.

This product includes software developed by Dean Huxley.

This product includes software developed by John Kohl.

This product includes software developed by Paul Kranenburg.

This product includes software developed by Terrence R. Lambert.

This product includes software developed by Philip A. Nelson.

This product includes software developed by Herb Peyerl.

This product includes software developed by Jochen Pohl for the NetBSD Project.

This product includes software developed by Chris Provenzano.

This product includes software developed by Theo de Raadt.

This product includes software developed by David Muir Sharnoff.

This product includes software developed by SigmaSoft, Th. Lockert.

This product includes software developed for the NetBSD Project by Jason R. Thorpe.

This product includes software developed by Jason R. Thorpe for And Communications,http://www.and.com.

This product includes software developed for the NetBSD Project by Frank Van der Linden.

This product includes software developed for the NetBSD Project by John M. Vinopal.

This product includes software developed by Christos Zoulas.

This product includes software developed by Charles Hannum.

This product includes software developed by Charles Hannum, by the University of Vermont and StateAgricultural College and Garrett A. Wollman, by William F. Jolitz, and by the University of California,Berkeley, Lawrence Berkeley Laboratory, and its contributors.

This product includes software developed by the University of Vermont and State Agricultural College andGarrett A. Wollman.

In the following statement, This software refers to the Mitsumi CD-ROM driver: This software wasdeveloped by Holger Veit and Brian Moore for use with 386BSD and similar operating systems.Similar operating systems includes mainly non-profit oriented systems for research and education,including but not restricted to NetBSD, FreeBSD, Mach (by CMU).

In the following statement, This software refers to the parallel port driver: This software is a componentof 386BSD developed by William F. Jolitz, TeleMuse.

This product includes software developed by the Apache Group for use in the Apache HTTP server project(http://www.apache.org/).

This product includes software developed by Darren Reed. ( 1993-1998 by Darren Reed).

ii

This product includes software licensed from Richard H. Porter under the GNU Library General PublicLicense ( 1998, Red Hat Software), www.gnu.org/copyleft/lgpl.html.

This product includes the standard version of Perl software licensed under the Perl Artistic License (1997, 1998 Tom Christiansen and Nathan Torkington). All rights reserved. You may find the most currentstandard version of Perl at http://www.perl.com.

Traffic Management Shell (tmsh) Reference Guide iii

Table of Contents

Table of Contents

1Introducing the Traffic Management Shell

About the Traffic Management Shell ......................................................................................... 1-1Additional command line utilities and tools ............................................................................. 1-2Basic syntax conventions .............................................................................................................. 1-3

2Understanding and Using the Traffic Management Shell

Understanding the structure of tmsh ........................................................................................ 2-1Using tmsh ....................................................................................................................................... 2-2

Loading and saving the system configuration .................................................................. 2-2Working within the tmsh hierarchy ................................................................................. 2-3Using the scripting feature .................................................................................................. 2-6Using the command completion feature ......................................................................... 2-7Using the help feature .......................................................................................................... 2-8Using the context-sensitive help feature ......................................................................... 2-9Interrupting a command ...................................................................................................... 2-9Entering multiple commands ............................................................................................ 2-10Using the command glob feature .................................................................................... 2-10Using the command audit feature ................................................................................... 2-14Using the command aliases feature ................................................................................. 2-16Using the wildcard search feature ................................................................................... 2-18Using the statistics feature ................................................................................................ 2-18Using grep functionality in tmsh to filter output ......................................................... 2-21Creating batch mode transactions .................................................................................. 2-22Controlling tmsh ................................................................................................................. 2-23

Introduction to command syntax ............................................................................................. 2-26

3Global Commands

Introducing global commands ...................................................................................................... 3-1Alphabetical list of global commands ......................................................................................... 3-1cd ....................................................................................................................................................... 3-2cp ....................................................................................................................................................... 3-4create ................................................................................................................................................ 3-6delete ................................................................................................................................................ 3-8edit ................................................................................................................................................... 3-10exit ................................................................................................................................................... 3-13generate .......................................................................................................................................... 3-14help .................................................................................................................................................. 3-15install ............................................................................................................................................... 3-17list .................................................................................................................................................... 3-18load .................................................................................................................................................. 3-21modify ............................................................................................................................................. 3-22mv .................................................................................................................................................... 3-24publish ............................................................................................................................................. 3-26pwd .................................................................................................................................................. 3-27quit ................................................................................................................................................... 3-28reboot ............................................................................................................................................. 3-29reset-stats ...................................................................................................................................... 3-31restart ............................................................................................................................................. 3-33run ................................................................................................................................................... 3-34save .................................................................................................................................................. 3-37send-mail ........................................................................................................................................ 3-38

Traffic Management Shell (tmsh) Reference Guide iii

Table of Contents

show ................................................................................................................................................ 3-39start ................................................................................................................................................. 3-43stop .................................................................................................................................................. 3-44submit ............................................................................................................................................. 3-45Global component ....................................................................................................................... 3-46

4analytics Module Components

Introducing the analytics module ................................................................................................ 4-1Alphabetical list of components .................................................................................................. 4-1report ................................................................................................................................................ 4-2

5apm Module Components

Introducing the apm module ....................................................................................................... 5-1Alphabetical list of components .................................................................................................. 5-1acl ....................................................................................................................................................... 5-2

6apm aaa Module Components

Introducing the apm aaa module ................................................................................................ 6-1Alphabetical list of components .................................................................................................. 6-1active-directory .............................................................................................................................. 6-2crldp .................................................................................................................................................. 6-5http .................................................................................................................................................... 6-8kerberos ......................................................................................................................................... 6-11kerberos-keytab-file ..................................................................................................................... 6-13ldap .................................................................................................................................................. 6-15oam .................................................................................................................................................. 6-18ocsp ................................................................................................................................................. 6-22radius ............................................................................................................................................... 6-27securid ............................................................................................................................................ 6-31tacacs ............................................................................................................................................... 6-33

7apm epsec Module Components

Introducing the apm epsec module ............................................................................................ 7-1Alphabetical list of components .................................................................................................. 7-1epsec-package ................................................................................................................................. 7-2software-status ............................................................................................................................... 7-4

8apm policy Module Components

Introducing the apm policy module ........................................................................................... 8-1Alphabetical list of components .................................................................................................. 8-1access-policy .................................................................................................................................... 8-2customization-group ...................................................................................................................... 8-3image-file .......................................................................................................................................... 8-4policy-item ....................................................................................................................................... 8-5windows-group-policy-file ............................................................................................................ 8-6

iv

Table of Contents

9apm policy agent Module Components

Introducing the apm policy agent module ................................................................................ 9-1Alphabetical list of components .................................................................................................. 9-1aaa-active-directory ....................................................................................................................... 9-2aaa-client-cert ................................................................................................................................. 9-6aaa-crldp ........................................................................................................................................... 9-8aaa-http ........................................................................................................................................... 9-10aaa-ldap ........................................................................................................................................... 9-12aaa-ocsp .......................................................................................................................................... 9-15aaa-radius ....................................................................................................................................... 9-17aaa-securid ..................................................................................................................................... 9-19acct-radius ...................................................................................................................................... 9-21acct-tacacsplus .............................................................................................................................. 9-23decision-box .................................................................................................................................. 9-25dynamic-acl .................................................................................................................................... 9-27ending-allow ................................................................................................................................... 9-29ending-deny ................................................................................................................................... 9-31ending-redirect ............................................................................................................................. 9-33endpoint-check-av ........................................................................................................................ 9-35endpoint-check-fw ....................................................................................................................... 9-38endpoint-linux-check-file ............................................................................................................ 9-41endpoint-linux-check-process ................................................................................................... 9-44endpoint-mac-check-file ............................................................................................................. 9-46endpoint-mac-check-process .................................................................................................... 9-49endpoint-windows-browser-cache-cleaner ............................................................................ 9-51endpoint-windows-check-file .................................................................................................... 9-54endpoint-windows-check-machine-cert .................................................................................. 9-58endpoint-windows-check-process ............................................................................................ 9-61endpoint-windows-check-registry ............................................................................................ 9-63endpoint-windows-group-policy ............................................................................................... 9-66endpoint-windows-info-os ......................................................................................................... 9-68endpoint-windows-machine-info .............................................................................................. 9-70endpoint-windows-protected-workspace .............................................................................. 9-72external-logon-page ..................................................................................................................... 9-74irule-event ...................................................................................................................................... 9-76kerberos ......................................................................................................................................... 9-79logging ............................................................................................................................................. 9-81logon-page ...................................................................................................................................... 9-83message-box .................................................................................................................................. 9-87oam .................................................................................................................................................. 9-89resource-assign ............................................................................................................................. 9-92route-domain-selection .............................................................................................................. 9-95tacacsplus ....................................................................................................................................... 9-97variable-assign ............................................................................................................................... 9-99

10apm profile Module Components

Introducing the apm profile module ........................................................................................ 10-1Alphabetical list of components ................................................................................................ 10-1access .............................................................................................................................................. 10-2connectivity ................................................................................................................................... 10-8remote-desktop ..........................................................................................................................10-13rewrite ..........................................................................................................................................10-14

Traffic Management Shell (tmsh) Reference Guide v

Table of Contents

11apm resource Module Components

Introducing the apm resource module ................................................................................... 11-1Alphabetical list of components ................................................................................................ 11-1app-tunnel ...................................................................................................................................... 11-2client-rate-class ............................................................................................................................. 11-5client-traffic-classifier ................................................................................................................... 11-9ipv6-leasepool .............................................................................................................................11-12leasepool ......................................................................................................................................11-14network-access ...........................................................................................................................11-16portal-access ................................................................................................................................11-24webtop ..........................................................................................................................................11-28webtop-link ..................................................................................................................................11-31

12apm resource remote-desktop Module Components

Introducing the apm resource remote-desktop module .................................................... 12-1Alphabetical list of components ................................................................................................ 12-1citrix ................................................................................................................................................ 12-2citrix-client-bundle ....................................................................................................................... 12-6citrix-client-package-file .............................................................................................................. 12-8rdp .................................................................................................................................................12-10

13apm sso Module Components

Introducing the apm sso module .............................................................................................. 13-1Alphabetical list of components ................................................................................................ 13-1basic ................................................................................................................................................. 13-2form-based ..................................................................................................................................... 13-5form-basedv2 ................................................................................................................................. 13-9kerberos .......................................................................................................................................13-18ntlmv1 ...........................................................................................................................................13-22ntlmv2 ...........................................................................................................................................13-25

14asm Module Components

Introducing the asm module ...................................................................................................... 14-1Alphabetical list of components ................................................................................................ 14-1device-sync ..................................................................................................................................... 14-2httpclass-asm ................................................................................................................................. 14-3predefined-policy .......................................................................................................................... 14-5webapp-language .......................................................................................................................... 14-7

15auth Module Components

Introducing the auth module ..................................................................................................... 15-1Alphabetical list of components ................................................................................................ 15-1cert-ldap ......................................................................................................................................... 15-2ldap .................................................................................................................................................. 15-8login-failures ................................................................................................................................15-13partition ........................................................................................................................................15-15password ......................................................................................................................................15-17

vi

Table of Contents

password-policy ..........................................................................................................................15-18radius .............................................................................................................................................15-21radius-server ...............................................................................................................................15-24remote-role .................................................................................................................................15-27remote-user .................................................................................................................................15-32source ...........................................................................................................................................15-34tacacs .............................................................................................................................................15-36user ................................................................................................................................................15-40

16cli Module Components

Introducing the cli module ......................................................................................................... 16-1Alphabetical list of components ................................................................................................ 16-1admin-partitions ............................................................................................................................ 16-2global-settings ................................................................................................................................ 16-3history ............................................................................................................................................. 16-6preference ...................................................................................................................................... 16-8script .............................................................................................................................................16-14transaction ...................................................................................................................................16-31

17cli alias Module Components

Introducing the cli alias module ................................................................................................ 17-1Alphabetical list of components ................................................................................................ 17-1private ............................................................................................................................................. 17-2shared ............................................................................................................................................. 17-5

18cm Module Components

Introducing the cm module ....................................................................................................... 18-1Alphabetical list of components ................................................................................................ 18-1cert .................................................................................................................................................. 18-2config-sync ..................................................................................................................................... 18-6device .............................................................................................................................................. 18-8device-group ................................................................................................................................18-12failover-status ..............................................................................................................................18-15key .................................................................................................................................................18-16sniff-updates .................................................................................................................................18-19sync-status ...................................................................................................................................18-21traffic-group .................................................................................................................................18-22trust-domain ................................................................................................................................18-25watch-devicegroup-device ........................................................................................................18-29watch-sys-device .........................................................................................................................18-31watch-trafficgroup-device .........................................................................................................18-33

19gtm Module Components

Introducing the gtm module ...................................................................................................... 19-1Alphabetical list of components ................................................................................................ 19-1datacenter ...................................................................................................................................... 19-2distributed-app .............................................................................................................................. 19-5iquery .............................................................................................................................................. 19-9ldns ................................................................................................................................................19-10

Traffic Management Shell (tmsh) Reference Guide vii

Table of Contents

link .................................................................................................................................................19-11listener ..........................................................................................................................................19-16path ................................................................................................................................................19-20persist ...........................................................................................................................................19-21pool ...............................................................................................................................................19-23prober-pool .................................................................................................................................19-35region ............................................................................................................................................19-38rule ................................................................................................................................................19-41server ............................................................................................................................................19-44topology .......................................................................................................................................19-52traffic .............................................................................................................................................19-55wideip ............................................................................................................................................19-56

20gtm global-settings Module Components

Introducing the gtm global-settings module ........................................................................... 20-1Alphabetical list of components ................................................................................................ 20-1general ............................................................................................................................................ 20-2load-balancing ................................................................................................................................ 20-6metrics ............................................................................................................................................ 20-8metrics-exclusions .....................................................................................................................20-11

21gtm monitor Module Components

Introducing the gtm monitor module ...................................................................................... 21-1Alphabetical list of components ................................................................................................ 21-1bigip ................................................................................................................................................. 21-2bigip-link ......................................................................................................................................... 21-6external ........................................................................................................................................... 21-9firepass ..........................................................................................................................................21-13ftp ...................................................................................................................................................21-17gateway-icmp ...............................................................................................................................21-21http ................................................................................................................................................21-25https ..............................................................................................................................................21-29imap ...............................................................................................................................................21-34ldap ................................................................................................................................................21-38mssql .............................................................................................................................................21-43mysql .............................................................................................................................................21-48nntp ...............................................................................................................................................21-53oracle ............................................................................................................................................21-57pop3 ..............................................................................................................................................21-62postgresql .....................................................................................................................................21-66radius .............................................................................................................................................21-71radius-accounting .......................................................................................................................21-75real-server ....................................................................................................................................21-79scripted .........................................................................................................................................21-82sip ...................................................................................................................................................21-86smtp ...............................................................................................................................................21-91snmp ..............................................................................................................................................21-95snmp-link ......................................................................................................................................21-99soap ............................................................................................................................................ 21-103tcp ............................................................................................................................................... 21-108tcp-half-open ............................................................................................................................ 21-112udp .............................................................................................................................................. 21-116

viii

Table of Contents

wap ............................................................................................................................................. 21-120wmi ............................................................................................................................................. 21-125

22ltm Module Components

Introducing the ltm module ....................................................................................................... 22-1Alphabetical list of components ................................................................................................ 22-1default-node-monitor .................................................................................................................. 22-2ifile ................................................................................................................................................... 22-4nat .................................................................................................................................................... 22-6node ................................................................................................................................................ 22-9pool ...............................................................................................................................................22-13rule ................................................................................................................................................22-24snat ................................................................................................................................................22-28snatpool ........................................................................................................................................22-32snat-translation ...........................................................................................................................22-35tce-policy ......................................................................................................................................22-38traffic-class ...................................................................................................................................22-41virtual ............................................................................................................................................22-44virtual-address .............................................................................................................................22-52

23ltm auth Module Components

Introducing the ltm auth module .............................................................................................. 23-1Alphabetical list of components ................................................................................................ 23-1crldp-server ................................................................................................................................... 23-2kerberos-delegation ..................................................................................................................... 23-5ldap .................................................................................................................................................. 23-8ocsp-responder ...........................................................................................................................23-13profile ............................................................................................................................................23-18radius .............................................................................................................................................23-22radius-server ...............................................................................................................................23-25ssl-cc-ldap .....................................................................................................................................23-28ssl-crldp ........................................................................................................................................23-33ssl-ocsp .........................................................................................................................................23-36tacacs .............................................................................................................................................23-39

24ltm classification Module Components

Introducing the ltm classification module ............................................................................... 24-1Alphabetical list of components ................................................................................................ 24-1category .......................................................................................................................................... 24-2http-signature ................................................................................................................................ 24-4key ................................................................................................................................................... 24-7signature-update-schedule .......................................................................................................... 24-9update-signatures .......................................................................................................................24-11

25ltm data-group Module Components

Introducing the ltm data-group module .................................................................................. 25-1Alphabetical list of components ................................................................................................ 25-1external ........................................................................................................................................... 25-2internal ............................................................................................................................................ 25-6

Traffic Management Shell (tmsh) Reference Guide ix

Table of Contents

26ltm dns cache Module Components

Introducing the ltm dns cache module .................................................................................... 26-1Alphabetical list of components ................................................................................................ 26-1global-settings ................................................................................................................................ 26-2resolver ........................................................................................................................................... 26-4transparent .................................................................................................................................... 26-8validating-resolver ......................................................................................................................26-11

27ltm dns cache records Module Components

Introducing the ltm dns cache records module .................................................................... 27-1Alphabetical list of components ................................................................................................ 27-1key ................................................................................................................................................... 27-2msg ................................................................................................................................................... 27-4nameserver .................................................................................................................................... 27-6rrset ................................................................................................................................................. 27-9

28ltm dns dns-express Module Components

Introducing the ltm dns dns-express module ........................................................................ 28-1Alphabetical list of components ................................................................................................ 28-1db ..................................................................................................................................................... 28-2tsig-key ............................................................................................................................................ 28-3zone ................................................................................................................................................. 28-5

29ltm dns dnssec Module Components

Introducing the ltm dns dnssec module .................................................................................. 29-1Alphabetical list of components ................................................................................................ 29-1generation ...................................................................................................................................... 29-2key ................................................................................................................................................... 29-4zone ................................................................................................................................................. 29-8

30ltm global-settings Module Components

Introducing the ltm global-settings module ............................................................................ 30-1Alphabetical list of components ................................................................................................ 30-1connection ..................................................................................................................................... 30-2general ............................................................................................................................................ 30-4traffic-control ................................................................................................................................ 30-6

31ltm monitor Module Components

Introducing the ltm monitor module ....................................................................................... 31-1Alphabetical list of components ................................................................................................ 31-1diameter ......................................................................................................................................... 31-2dns ................................................................................................................................................... 31-7external .........................................................................................................................................31-12firepass ..........................................................................................................................................31-16ftp ...................................................................................................................................................31-20

x

Table of Contents

gateway-icmp ...............................................................................................................................31-24http ................................................................................................................................................31-28https ..............................................................................................................................................31-33icmp ...............................................................................................................................................31-38imap ...............................................................................................................................................31-42inband ............................................................................................................................................31-46ldap ................................................................................................................................................31-49module-score ..............................................................................................................................31-54mssql .............................................................................................................................................31-58mysql .............................................................................................................................................31-63nntp ...............................................................................................................................................31-68oracle ............................................................................................................................................31-72pop3 ..............................................................................................................................................31-77postgresql .....................................................................................................................................31-81radius .............................................................................................................................................31-86radius-accounting .......................................................................................................................31-90real-server ....................................................................................................................................31-94rpc ..................................................................................................................................................31-97sasp ............................................................................................................................................. 31-101scripted ...................................................................................................................................... 31-104sip ................................................................................................................................................ 31-108smb ............................................................................................................................................. 31-114smtp ............................................................................................................................................ 31-118snmp-dca ................................................................................................................................... 31-122snmp-dca-base .......................................................................................................................... 31-126soap ............................................................................................................................................ 31-129tcp ............................................................................................................................................... 31-134tcp-echo ..................................................................................................................................... 31-139tcp-half-open ............................................................................................................................ 31-143udp .............................................................................................................................................. 31-147virtual-location ......................................................................................................................... 31-152wap ............................................................................................................................................. 31-156wmi ............................................................................................................................................. 31-161

32ltm persistence Module Components

Introducing the ltm persistence module ................................................................................. 32-1Alphabetical list of components ................................................................................................ 32-1cookie ............................................................................................................................................. 32-2dest-addr ........................................................................................................................................ 32-6global-settings ................................................................................................................................ 32-9hash ...............................................................................................................................................32-11msrdp ............................................................................................................................................32-15persist-records ............................................................................................................................32-18sip ...................................................................................................................................................32-21source-addr .................................................................................................................................32-24ssl ...................................................................................................................................................32-28universal ........................................................................................................................................32-31

33ltm profile Module Components

Introducing the ltm profile module .......................................................................................... 33-1Alphabetical list of components ................................................................................................ 33-1analytics .......................................................................................................................................... 33-2

Traffic Management Shell (tmsh) Reference Guide xi

Table of Contents

certificate-authority ...................................................................................................................33-11classification .................................................................................................................................33-14client-ssl ........................................................................................................................................33-16diameter .......................................................................................................................................33-24dns .................................................................................................................................................33-28fasthttp ..........................................................................................................................................33-31fastl4 ..............................................................................................................................................33-36ftp ...................................................................................................................................................33-41http ................................................................................................................................................33-44httpclass ........................................................................................................................................33-50http-compression .......................................................................................................................33-54iiop .................................................................................................................................................33-59mblb ...............................................................................................................................................33-62ntlm ...............................................................................................................................................33-65one-connect .................................................................................................................................33-68radius .............................................................................................................................................33-71ramcache ......................................................................................................................................33-74request-log ...................................................................................................................................33-76rtsp ................................................................................................................................................33-80sctp ................................................................................................................................................33-84server-ssl ......................................................................................................................................33-88sip ...................................................................................................................................................33-96smtp ...............................................................................................................................................33-99spdy ............................................................................................................................................ 33-101statistics ..................................................................................................................................... 33-104stream ........................................................................................................................................ 33-108tce ............................................................................................................................................... 33-111tcp ............................................................................................................................................... 33-113udp .............................................................................................................................................. 33-120wa-cache .................................................................................................................................... 33-123xml .............................................................................................................................................. 33-125

34ltm tce Module Components

Introducing the ltm tce module ................................................................................................ 34-1Alphabetical list of components ................................................................................................ 34-1policy ............................................................................................................................................... 34-2steering-endpoint ......................................................................................................................... 34-5

35net Module Components

Introducing the net module ....................................................................................................... 35-1Alphabetical list of components ................................................................................................ 35-1arp .................................................................................................................................................... 35-2cmetrics .......................................................................................................................................... 35-5fdb .................................................................................................................................................... 35-7interface ........................................................................................................................................35-10ndp .................................................................................................................................................35-15packet-filter ..................................................................................................................................35-17packet-filter-trusted ...................................................................................................................35-22port-mirror ..................................................................................................................................35-25route .............................................................................................................................................35-27route-domain ..............................................................................................................................35-30router-advertisement ................................................................................................................35-33

xii

Table of Contents

rst-cause .......................................................................................................................................35-37self ..................................................................................................................................................35-38self-allow ......................................................................................................................................35-41stp ..................................................................................................................................................35-43stp-globals ....................................................................................................................................35-47trunk ..............................................................................................................................................35-51vlan .................................................................................................................................................35-56vlan-allowed .................................................................................................................................35-60vlan-group ....................................................................................................................................35-61wccp ..............................................................................................................................................35-65

36net ipsec Module Components

Introducing the net ipsec module ............................................................................................. 36-1Alphabetical list of components ................................................................................................ 36-1ike-daemon .................................................................................................................................... 36-2ike-peer .......................................................................................................................................... 36-4ipsec-policy .................................................................................................................................... 36-9manual-security-association .....................................................................................................36-12traffic-selector .............................................................................................................................36-15

37net rate-shaping Module Components

Introducing the net rate-shaping module ............................................................................... 37-1Alphabetical list of components ................................................................................................ 37-1class ................................................................................................................................................. 37-2drop-policy ..................................................................................................................................... 37-7queue .............................................................................................................................................37-11shaping-policy ..............................................................................................................................37-14

38net tunnels Module Components

Introducing the net tunnels module ........................................................................................ 38-1Alphabetical list of components ................................................................................................ 38-1etherip ............................................................................................................................................. 38-2gre .................................................................................................................................................... 38-5ipip ................................................................................................................................................... 38-8ppp .................................................................................................................................................38-11tunnel ............................................................................................................................................38-14wccp ..............................................................................................................................................38-17

39sys Module Components

Introducing the sys module ....................................................................................................... 39-1Alphabetical list of components ................................................................................................ 39-1clock ................................................................................................................................................ 39-2cluster ............................................................................................................................................. 39-3config ............................................................................................................................................... 39-6config-diff ......................................................................................................................................39-12connection ...................................................................................................................................39-13console ..........................................................................................................................................39-16cpu .................................................................................................................................................39-18daemon-ha ...................................................................................................................................39-19

Traffic Management Shell (tmsh) Reference Guide xiii

Table of Contents

datastor ........................................................................................................................................39-22db ...................................................................................................................................................39-24default-config ...............................................................................................................................39-27dns .................................................................................................................................................39-28failover ..........................................................................................................................................39-30folder .............................................................................................................................................39-33geoip ..............................................................................................................................................39-36global-settings ..............................................................................................................................39-37ha-group .......................................................................................................................................39-42hardware ......................................................................................................................................39-45ha-status .......................................................................................................................................39-46host-info .......................................................................................................................................39-47httpd ..............................................................................................................................................39-48hypervisor-info ............................................................................................................................39-52icmp-stat .......................................................................................................................................39-53ip-address .....................................................................................................................................39-54iprep-status ..................................................................................................................................39-56ip-stat ............................................................................................................................................39-58license ...........................................................................................................................................39-59log ..................................................................................................................................................39-60log-rotate .....................................................................................................................................39-62mac-address .................................................................................................................................39-65management-ip ............................................................................................................................39-67management-route .....................................................................................................................39-69mcp-state ......................................................................................................................................39-72memory ........................................................................................................................................39-73ntp ..................................................................................................................................................39-74proc-info .......................................................................................................................................39-78provision .......................................................................................................................................39-79pva-traffic ......................................................................................................................................39-83scriptd ...........................................................................................................................................39-85service ...........................................................................................................................................39-87smtp-server .................................................................................................................................39-89snmp ..............................................................................................................................................39-91sshd ............................................................................................................................................. 39-105state-mirroring ......................................................................................................................... 39-109sync-sys-files ............................................................................................................................. 39-111syslog .......................................................................................................................................... 39-113tmm-info .................................................................................................................................... 39-117tmm-traffic ................................................................................................................................ 39-118traffic .......................................................................................................................................... 39-119ucs ............................................................................................................................................... 39-120version ....................................................................................................................................... 39-122

40sys application Module Components

Introducing the sys application module .................................................................................. 40-1Alphabetical list of components ................................................................................................ 40-1apl-script ......................................................................................................................................... 40-2custom-stat .................................................................................................................................... 40-4service ............................................................................................................................................. 40-6template .......................................................................................................................................... 40-9

xiv

Table of Contents

41sys crypto Module Components

Introducing the sys crypto module .......................................................................................... 41-1Alphabetical list of components ................................................................................................ 41-1cert .................................................................................................................................................. 41-2check-cert ...................................................................................................................................... 41-5crl ..................................................................................................................................................... 41-7key ................................................................................................................................................... 41-9master-key ...................................................................................................................................41-13pkcs12 ...........................................................................................................................................41-15

42sys crypto fips Module Components

Introducing the sys crypto fips module ................................................................................... 42-1Alphabetical list of components ................................................................................................ 42-1by-handle ........................................................................................................................................ 42-2private-key ..................................................................................................................................... 42-3public-key ....................................................................................................................................... 42-5

43sys daemon-log-settings Module Components

Introducing the sys daemon-log-settings module ................................................................. 43-1Alphabetical list of components ................................................................................................ 43-1clusterd ........................................................................................................................................... 43-2csyncd ............................................................................................................................................. 43-4lind ................................................................................................................................................... 43-6mcpd ................................................................................................................................................ 43-8tmm ...............................................................................................................................................43-10

44sys disk Module Components

Introducing the sys disk module ............................................................................................... 44-1Alphabetical list of components ................................................................................................ 44-1application-volume ....................................................................................................................... 44-2logical-disk ...................................................................................................................................... 44-4

45sys file Module Components

Introducing the sys file module ................................................................................................. 45-1Alphabetical list of components ...........................

Documents

Traffic Management Shell (tmsh) Reference Guidesupport.f5.com/content/kb/en-us/products/big-ip_ltm/manuals/... · Traffic Management Shell (tmsh) Reference Guide iii ... network-access