set-tcp-listener-prop

Syntax

tadm set-tcp-listener-prop common_options --config=config_name --tcp-listener=name (property_name=property_value)+

Description

Use this command to set the TCP listener properties.

Options

For information about common_options, run the help command.

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

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-listener properties:

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

name: Specifies the name of the TCP listener.
Values: Must be in a text string.

ip: Specify the Internet Protocol (IP) address for the TCP listener.
Values: A valid IP address or an asterisk (*) to listen on all IP addresses.

family: Specify the internet protocol family, for example: IPV4, and IPV6. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6.

Note:

The property family can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

acceptor-threads: Specifies the number of threads dedicated to accept connections received by this listener.
Values: 1 to 128. Default: 1 per CPU.

Note:

The property acceptor-threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

tcp-proxy-name: Specifies the name of the TCP proxy.
Values: Must be in a text string.

listen-queue-size: Specifies the size (in bytes) of the listen queue.
Values: 0 to 65536.

receive-buffer-size: Specifies the size (in bytes) of the operating system socket receive buffer.
Values: 1 to 1048576.

send-buffer-size: Specifies the size (in bytes) of the operating system socket send buffer.
Values: 1 to 1048576.

description: Specifies the description of the TCP listener.
Values: Must be in a text string.

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

Example

tadm set-tcp-listeners-prop --user=admin  
--password-file=./admin.passwd --port=8989 
--config=www.example.org --tcp-listener=TCP_Listener1 listen-queue-size=238 max-threads=789

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.