sys connection

sys connection(1)					BIG-IP TMSH Manual					 sys connection(1)

NAME
       connection - Sets idle timeout for, displays, and deletes active connections on the BIG-IP(r) system.

MODULE
       sys

SYNTAX
       Use the connection component within the sys module to manage connections using the following syntax.

   MODIFY
	modify connection
	  options:
	    idle-timeout [integer]
	    flow-accel-type software-only

   DISPLAY
	show connection
	  option:
	    (default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
	    all-properties
	    age [integer]
	    cs-client-addr [ [IP address] | [IP address/prefixlen] ]
	    cs-client-port [ [integer] | [service] ]
	    cs-server-addr [ [IP address] | [IP address/prefixlen] ]
	    cs-server-port [ [integer] | [service] ]
	    connection-id [ integer ]
	    protocol [name]
	    save-to-file [ filename ]
	    ss-client-addr [IP address]
	    ss-client-port [ [integer] | [service] ]
	    ss-server-addr [IP address]
	    ss-server-port [ [integer] | [service] ]
	    type [any | mirror | self | mptcp]
	    virtual-server [string]

   DELETE
	delete connection
	  option:
	    age [integer]
	    cs-client-addr [ [IP address] | [IP address/prefixlen] ]
	    cs-client-port [ [integer] | [service] ]
	    cs-server-addr [ [IP address] | [IP address/prefixlen] ]
	    cs-server-port [ [integer] | [service] ]
	    connection-id [ integer ]
	    protocol [name]
	    ss-client-addr [IP address]
	    ss-client-port [ [integer] | [service] ]
	    ss-server-addr [IP address]
	    ss-server-port [ [integer] | [service] ]
	    type [any | mirror | self | mptcp]
	    virtual-server [string]

DESCRIPTION
       You can use the connection component to set the idle timeout for or delete active connections to the BIG-IP system based on
       a specified filter. Additionally, you can display information about the active connections to the system.

       You can specify the  option using either a number or a service (80 or http).

       Important: If you do not specify a port or service, the system deletes all connections that match just the IP address. If
       you do not specify an IP address, the system deletes all connections including mirrored connections.

EXAMPLES
       show connection all-properties

       Displays information about all active connections to the system.

       modify connection idle-timeout 300

       Changes the amount of idle time before a connection is disconnected to five minutes (300 seconds).

       modify connection flow-accel-type software-only

       Flush all hardware accelerated connections from the hardware to be software only connections.

OPTIONS
       age  Specifies, in seconds, the minimum idle time of the active connections that you want to display or delete.

       cs-client-addr
	    Specifies the clientside remote IP address of the active connections that you want to display or delete. Subnets are
	    allowed by specifying an optional prefix length up to /24 and /56 for IPv4 and IPv6 respectively.

       cs-client-port
	    Specifies the clientside remote port of the active connections that you want to display or delete.

       cs-server-addr
	    Specifies the clientside local IP address of the active connections that you want to display or delete. Subnets are
	    allowed by specifying an optional prefix length up to /24 and /56 for IPv4 and IPv6 respectively.

       cs-server-port
	    Specifies the clientside local port of the active connections that you want to display or delete.

       connection-id
	    Specifies the MPTCP connection ID of the active connections that you want to display or delete.

       idle-timeout
	    Specifies the interval, in seconds, that a connection can remain idle before the system closes the connection.

       protocol
	    Specifies the protocol of the active connections that you want to display or delete.

       save-to-file
	    Specifies the file which connection information can be save to. With this option, it can write a file larger than 2GB.

       ss-client-addr
	    Specifies the serverside local IP address of the active connections that you want to display or delete.

       ss-client-port
	    Specifies the serverside local port of the active connections that you want to display or delete.

       ss-server-addr
	    Specifies the serverside remote IP address of the active connections that you want to display or delete.

       ss-server-port
	    Specifies the serverside remote port of the active connections that you want to display or delete.

       type Specifies the type of active connections that you want to display or delete. The possible values are:

	    any  Specifies all active connections.

	    mirror
		 Specifies only mirrored connections.

	    self Specifies the connection with which you are accessing the system.

	    mptcp
		 Specifies the MPTCP type of connections.

       virtual-server
	    Specifies the virtual server handling the active connections that you want to display or delete.

SEE ALSO
       delete, modify, show, tmsh

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
       photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
       use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2009-2010, 2012-2013, 2015. All rights reserved.

BIG-IP							    2022-01-12						 sys connection(1)