create-tcp-listener

Syntax

tadm create-tcp-listener common_options [--no_enabled] [--ip=address] [--acceptor-threads=count] [--family=name] [--listen-queue-size=size] [--receive-buffer-size=size] [--send-buffer-size=size] [--description=text] --listener-port=number --config=config_name --tcp-proxy=tcp_proxy_name listener_name

Description

Use this command to create a new TCP listener socket. When a new request comes in, Oracle Traffic Director determines which TCP proxy to send it to, based on the configured TCP listener.

Options

For information about common_options, run the help command.

--no-enabled|-n: Specify this option to disable the TCP listener at runtime.
--ip|-I: Indicates the IP address of the host computer. Specify an asterisk (*) for the TCP listener to listen to all the available IP addresses on the host computer.
--acceptor-threads|-a: Specify the number of threads dedicated to accept the connections received by this listener. The range of values is 1 to 128.
--family|-f: Specify the internet protocol family, for example: IPV4, and IPV6. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6. For Sockets Direct Protocol (SDP), specify family=inet-sdp.
--listen-queue-size|-l: Specify the size (in bytes) of the operating system listen queue back log. The range of values is 1 to 65536.
--receive-buffer-size|-r: Specify the size (in bytes) of the operating system socket receive buffer. The range of values is 1 to 1048576.
--send-buffer-size|-B: Specify the size (in bytes) of the operating system socket send buffer. The range of values is 1 to 1048576.
--description|-D: Enter a description for the TCP listener.
--listener-port|-P: Specify the port number where the configuration binds to and listens for requests. The range of values is 1 to 65535.
--config|-c: Specify the name of the configuration for which you want to create the new TCP listener socket.
--tcp-proxy|-r: Specify the name of the TCP proxy.

Operands

listener-name

Specify the name for the TCP listener that you want to create.

Example

tadm create-tcp-listener --user=admin --host=admin.example.com 
--password-file=./admin.passwd --port=8989 
--no-prompt --listener-port=8082 --tcp-proxy=TCP_Proxy1 --config=www.example.org TCP_Listener1

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.