ADC CLI Commands

lsn-transportprofile

The following operations can be performed on “lsn-transportprofile”:

add show set rm unset

add lsn transportprofile

Add LSN Transport Profile.

Synopsis

add lsn transportprofile \[-sessiontimeout ] \[-finrsttimeout ] \[-stuntimeout <positive\_integer>] \[-synidletimeout <positive\_integer>] \[-portquota <positive\_integer>] \[-sessionquota <positive\_integer>] \[-groupSessionLimit <positive\_integer>] \[-portpreserveparity \( ENABLED | DISABLED )] \[-portpreserverange \( ENABLED | DISABLED )] \[-syncheck \( ENABLED | DISABLED )]

Arguments

transportprofilename Name for the LSN transport profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the LSN transport profile is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “lsn transport profile1” or ‘lsn transport profile1’).

transportprotocol Protocol for which to set the LSN transport profile parameters.

Possible values: TCP, UDP, ICMP

sessiontimeout Timeout, in seconds, for an idle LSN session. If an LSN session is idle for a time that exceeds this value, the Citrix ADC removes the session.

This timeout does not apply for a TCP LSN session when a FIN or RST message is received from either of the endpoints. Default value: 120 Minimum value: 60

finrsttimeout Timeout, in seconds, for a TCP LSN session after a FIN or RST message is received from one of the endpoints.

If a TCP LSN session is idle (after the Citrix ADC receives a FIN or RST message) for a time that exceeds this value, the Citrix ADC ADC removes the session.

Since the LSN feature of the Citrix ADC does not maintain state information of any TCP LSN sessions, this timeout accommodates the transmission of the FIN or RST, and ACK messages from the other endpoint so that both endpoints can properly close the connection. Default value: 30

stuntimeout STUN protocol timeout Default value: 600 Minimum value: 120 Maximum value: 1200

synidletimeout SYN Idle timeout Default value: 60 Minimum value: 30 Maximum value: 120

portquota Maximum number of LSN NAT ports to be used at a time by each subscriber for the specified protocol. For example, each subscriber can be limited to a maximum of 500 TCP NAT ports. When the LSN NAT mappings for a subscriber reach the limit, the Citrix ADC does not allocate additional NAT ports for that subscriber. Default value: 0 Minimum value: 0 Maximum value: 65535

sessionquota Maximum number of concurrent LSN sessions allowed for each subscriber for the specified protocol. When the number of LSN sessions reaches the limit for a subscriber, the Citrix ADC does not allow the subscriber to open additional sessions. Default value: 0 Minimum value: 0 Maximum value: 65535

groupSessionLimit Maximum number of concurrent LSN sessions(for the specified protocol) allowed for all subscriber of a group to which this profile has bound. This limit will get split across the Citrix ADCs packet engines and rounded down. When the number of LSN sessions reaches the limit for a group in packet engine, the Citrix ADC does not allow the subscriber of that group to open additional sessions through that packet engine. Default value: 0 Minimum value: 0

portpreserveparity Enable port parity between a subscriber port and its mapped LSN NAT port. For example, if a subscriber initiates a connection from an odd numbered port, the Citrix ADC allocates an odd numbered LSN NAT port for this connection. You must set this parameter for proper functioning of protocols that require the source port to be even or odd numbered, for example, in peer-to-peer applications that use RTP or RTCP protocol.

Possible values: ENABLED, DISABLED Default value: DISABLED

portpreserverange If a subscriber initiates a connection from a well-known port (0-1023), allocate a NAT port from the well-known port range (0-1023) for this connection. For example, if a subscriber initiates a connection from port 80, the Citrix ADC can allocate port 100 as the NAT port for this connection.

This parameter applies to dynamic NAT without port block allocation. It also applies to Deterministic NAT if the range of ports allocated includes well-known ports.

When all the well-known ports of all the available NAT IP addresses are used in different subscriber’s connections (LSN sessions), and a subscriber initiates a connection from a well-known port, the Citrix ADC drops this connection.

Possible values: ENABLED, DISABLED Default value: DISABLED

syncheck Silently drop any non-SYN packets for connections for which there is no LSN-NAT session present on the Citrix ADC.

If you disable this parameter, the Citrix ADC accepts any non-SYN packets and creates a new LSN session entry for this connection.

Following are some reasons for the Citrix ADC to receive such packets:

  • LSN session for a connection existed but the Citrix ADC removed this session because the LSN session was idle for a time that exceeded the configured session timeout.
  • Such packets can be a part of a DoS attack.

Possible values: ENABLED, DISABLED Default value: ENABLED

Example

add lsn transportprofile profile1 TCP -portquota 128

show lsn transportprofile

Display LSN Transport Profile.

Synopsis

show lsn transportprofile []

Arguments

transportprofilename Name for the LSN transport profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the LSN transport profile is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “lsn transport profile1” or ‘lsn transport profile1’).

Output

transportprotocol Protocol for which to set the LSN transport profile parameters.

sessiontimeout Timeout, in seconds, for an idle LSN session. If an LSN session is idle for a time that exceeds this value, the Citrix ADC removes the session.

This timeout does not apply for a TCP LSN session when a FIN or RST message is received from either of the endpoints.

finrsttimeout Timeout, in seconds, for a TCP LSN session after a FIN or RST message is received from one of the endpoints.

If a TCP LSN session is idle (after the Citrix ADC receives a FIN or RST message) for a time that exceeds this value, the Citrix ADC ADC removes the session.

Since the LSN feature of the Citrix ADC does not maintain state information of any TCP LSN sessions, this timeout accommodates the transmission of the FIN or RST, and ACK messages from the other endpoint so that both endpoints can properly close the connection.

stuntimeout STUN protocol timeout

synidletimeout SYN Idle timeout

portquota Maximum number of LSN NAT ports to be used at a time by each subscriber for the specified protocol. For example, each subscriber can be limited to a maximum of 500 TCP NAT ports. When the LSN NAT mappings for a subscriber reach the limit, the Citrix ADC does not allocate additional NAT ports for that subscriber.

sessionquota Maximum number of concurrent LSN sessions allowed for each subscriber for the specified protocol. When the number of LSN sessions reaches the limit for a subscriber, the Citrix ADC does not allow the subscriber to open additional sessions.

groupSessionLimit Maximum number of concurrent LSN sessions(for the specified protocol) allowed for all subscriber of a group to which this profile has bound. This limit will get split across the Citrix ADCs packet engines and rounded down. When the number of LSN sessions reaches the limit for a group in packet engine, the Citrix ADC does not allow the subscriber of that group to open additional sessions through that packet engine.

portpreserveparity Enable port parity between a subscriber port and its mapped LSN NAT port. For example, if a subscriber initiates a connection from an odd numbered port, the Citrix ADC allocates an odd numbered LSN NAT port for this connection. You must set this parameter for proper functioning of protocols that require the source port to be even or odd numbered, for example, in peer-to-peer applications that use RTP or RTCP protocol.

portpreserverange If a subscriber initiates a connection from a well-known port (0-1023), allocate a NAT port from the well-known port range (0-1023) for this connection. For example, if a subscriber initiates a connection from port 80, the Citrix ADC can allocate port 100 as the NAT port for this connection.

This parameter applies to dynamic NAT without port block allocation. It also applies to Deterministic NAT if the range of ports allocated includes well-known ports.

When all the well-known ports of all the available NAT IP addresses are used in different subscriber’s connections (LSN sessions), and a subscriber initiates a connection from a well-known port, the Citrix ADC drops this connection.

syncheck Silently drop any non-SYN packets for connections for which there is no LSN-NAT session present on the Citrix ADC.

If you disable this parameter, the Citrix ADC accepts any non-SYN packets and creates a new LSN session entry for this connection.

Following are some reasons for the Citrix ADC to receive such packets:

  • LSN session for a connection existed but the Citrix ADC removed this session because the LSN session was idle for a time that exceeded the configured session timeout.
  • Such packets can be a part of a DoS attack.

devno count stateflag

Example

show lsn transportprofile profile1

set lsn transportprofile

Set LSN Transport Profile.

Synopsis

set lsn transportprofile \[-sessiontimeout ] \[-finrsttimeout ] \[-stuntimeout <positive\_integer>] \[-synidletimeout <positive\_integer>] \[-portquota <positive\_integer>] \[-sessionquota <positive\_integer>] \[-groupSessionLimit <positive\_integer>] \[-portpreserveparity \( ENABLED | DISABLED )] \[-portpreserverange \( ENABLED | DISABLED )] \[-syncheck \( ENABLED | DISABLED )]

Arguments

transportprofilename Name for the LSN transport profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the LSN transport profile is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “lsn transport profile1” or ‘lsn transport profile1’).

sessiontimeout Timeout, in seconds, for an idle LSN session. If an LSN session is idle for a time that exceeds this value, the Citrix ADC removes the session.

This timeout does not apply for a TCP LSN session when a FIN or RST message is received from either of the endpoints. Default value: 120 Minimum value: 60

finrsttimeout Timeout, in seconds, for a TCP LSN session after a FIN or RST message is received from one of the endpoints.

If a TCP LSN session is idle (after the Citrix ADC receives a FIN or RST message) for a time that exceeds this value, the Citrix ADC ADC removes the session.

Since the LSN feature of the Citrix ADC does not maintain state information of any TCP LSN sessions, this timeout accommodates the transmission of the FIN or RST, and ACK messages from the other endpoint so that both endpoints can properly close the connection. Default value: 30

stuntimeout STUN protocol timeout Default value: 600 Minimum value: 120 Maximum value: 1200

synidletimeout SYN Idle timeout Default value: 60 Minimum value: 30 Maximum value: 120

portquota Maximum number of LSN NAT ports to be used at a time by each subscriber for the specified protocol. For example, each subscriber can be limited to a maximum of 500 TCP NAT ports. When the LSN NAT mappings for a subscriber reach the limit, the Citrix ADC does not allocate additional NAT ports for that subscriber. Default value: 0 Minimum value: 0 Maximum value: 65535

sessionquota Maximum number of concurrent LSN sessions allowed for each subscriber for the specified protocol. When the number of LSN sessions reaches the limit for a subscriber, the Citrix ADC does not allow the subscriber to open additional sessions. Default value: 0 Minimum value: 0 Maximum value: 65535

groupSessionLimit Maximum number of concurrent LSN sessions(for the specified protocol) allowed for all subscriber of a group to which this profile has bound. This limit will get split across the Citrix ADCs packet engines and rounded down. When the number of LSN sessions reaches the limit for a group in packet engine, the Citrix ADC does not allow the subscriber of that group to open additional sessions through that packet engine. Default value: 0 Minimum value: 0

portpreserveparity Enable port parity between a subscriber port and its mapped LSN NAT port. For example, if a subscriber initiates a connection from an odd numbered port, the Citrix ADC allocates an odd numbered LSN NAT port for this connection. You must set this parameter for proper functioning of protocols that require the source port to be even or odd numbered, for example, in peer-to-peer applications that use RTP or RTCP protocol.

Possible values: ENABLED, DISABLED Default value: DISABLED

portpreserverange If a subscriber initiates a connection from a well-known port (0-1023), allocate a NAT port from the well-known port range (0-1023) for this connection. For example, if a subscriber initiates a connection from port 80, the Citrix ADC can allocate port 100 as the NAT port for this connection.

This parameter applies to dynamic NAT without port block allocation. It also applies to Deterministic NAT if the range of ports allocated includes well-known ports.

When all the well-known ports of all the available NAT IP addresses are used in different subscriber’s connections (LSN sessions), and a subscriber initiates a connection from a well-known port, the Citrix ADC drops this connection.

Possible values: ENABLED, DISABLED Default value: DISABLED

syncheck Silently drop any non-SYN packets for connections for which there is no LSN-NAT session present on the Citrix ADC.

If you disable this parameter, the Citrix ADC accepts any non-SYN packets and creates a new LSN session entry for this connection.

Following are some reasons for the Citrix ADC to receive such packets:

  • LSN session for a connection existed but the Citrix ADC removed this session because the LSN session was idle for a time that exceeded the configured session timeout.
  • Such packets can be a part of a DoS attack.

Possible values: ENABLED, DISABLED Default value: ENABLED

Example

set lsn transportprofile profile1 -portquota 128

rm lsn transportprofile

Remove LSN Transport Profile.

Synopsis

rm lsn transportprofile

Arguments

transportprofilename Name for the LSN transport profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the LSN transport profile is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “lsn transport profile1” or ‘lsn transport profile1’).

Example

rm lsn transportprofile profile1

unset lsn transportprofile

Use this command to remove lsn transportprofile settings.Refer to the set lsn transportprofile command for meanings of the arguments.

Synopsis

unset lsn transportprofile [-sessiontimeout] [-finrsttimeout] [-stuntimeout] [-synidletimeout] [-portquota] [-sessionquota] [-groupSessionLimit] [-portpreserveparity] [-portpreserverange] [-syncheck]

lsn-transportprofile