set-tcp-proxy-prop

Syntax

tadm set-tcp-proxy-prop common_options --config=config_name --tcp-proxy=tcp_proxy_name (property_name=property_value)+

Description

Use this command to set the properties of the TCP proxy for a configuration.

Options

For information about common_options, run the help command.

--config|-c: Specify the name of the configuration for which you want to set the properties of the TCP proxy.

--tcp-proxy|-r: Specify the name of the TCP proxy.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following tcp-proxy properties:

enabled: Specifies whether the TCP listener instance is enabled.
Values: true, false. Default: true.

name: Specifies the name of the TCP listener.
Values:

session-idle-timeout: Specifies the maximum timeout (in seconds) for load balancer to wait for receiving/sending data for a session.
Values: Number. Default: 300 seconds.

origin-server-pool-name: Specifies the name of the origin-server pool.
Values: Text.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-tcp-proxy-prop --user=admin --host=admin.example.com 
--password-file=./admin.passwd --port=8989 
--no-prompt --tcp-proxy=proxy1 --config=www.example.org access-log-file=../logs/www_example_com_access.log

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.