This chapter describes how to create, view, modify, and delete TCP proxies. It contains the following topics:
You can create TCP proxies by using either the administration console or the CLI.
Note:
When you create a TCP Proxy, you are, in effect, modifying a configuration. So for the new TCP Proxy settings to take effect in the Oracle Traffic Director instances, you should redeploy the configuration as described in Deploying a Configuration.
The CLI examples in this section are shown in shell mode (tadm>
). For information about invoking the CLI shell, see Accessing the Command-Line Interface.
Oracle Java Cloud Service does not create a TCP proxy for you. If you require a TCP proxy, you must create it yourself.
Before You Begin
Before you begin creating a TCP Proxy, decide the following:
A unique name for the proxy. Choose the name carefully; after creating a proxy, you cannot change its name.
A unique IP address (or host name) and port number combinations for the listener.
You can define multiple TCP listeners with the same IP address combined with different port numbers, or with a single port number combined with different IP addresses. So each of the following IP address and port number combinations would be considered a unique listener:
10.10.10.1:80 10.10.10.1:81 10.10.10.2:80 10.10.10.2:81
The name of the origin-server pool to which the TCP Proxy should forward requests. For information about creating origin-server pools, see Managing Origin-Server Pools.
Creating a TCP Proxy Using the Administration Console
To create a TCP Proxy by using the administration console, do the following:
To create a TCP Proxy, run the create-tcp-proxy
command.
For example, the following command creates a TCP Proxy named tcp_proxy1
for the configuration soa.example.com
with the port as 1910
and the origin-server-pool as soa-pool
.
tadm> create-tcp-proxy --config=soa.example.com --origin-server-pool=soa-pool --port=1910 tcp_proxy1
OTD-70201 Command 'create-tcp-proxy' ran successfully.
For the updated configuration to take effect, you should deploy it to the Oracle Traffic Director instances by using the deploy-config
command.
For more information about create-tcp-proxy
, see the Oracle Traffic Director Command-Line Reference or run the command with the --help
option.
You can view a list of TCP proxies by using either the administration console or the CLI.
Note:
The CLI examples in this section are shown in shell mode (tadm>
). For information about invoking the CLI shell, see Accessing the Command-Line Interface.
Viewing a List of TCP Proxies Using the Administration Console
To view a list of TCP proxies by using the administration console, do the following:
You can view the properties of a proxy in detail by clicking on its name.
To view a list of TCP proxies, run the list-tcp-proxies
command, as shown in the following example:
tadm> list-tcp-proxies --config=soa --verbose --all
name session-idle-timeout origin-server-pool-name
-------------------------------------------------------------------
tcp_proxy1 300 soa-pool1
tcp_proxy2 400 soa-pool2
You can view the properties of a TCP Proxy in detail by running the get-tcp-proxy-prop
command.
For more information about the list-tcp-proxies
and get-tcp-proxy-prop
commands, see the Oracle Traffic Director Command-Line Reference or run the commands with the --help
option.
You can modify TCP proxies by using either the administration console or the CLI.
Note:
When you modify a TCP Proxy, you are, in effect, modifying a configuration. So for the new settings of the TCP Proxy to take effect in the Oracle Traffic Director instances, you should redeploy the configuration as described in Deploying a Configuration.
The CLI examples in this section are shown in shell mode (tadm>
). For information about invoking the CLI shell, see Accessing the Command-Line Interface.
Modifying a TCP Proxy Using the Administration Console
To modify a TCP Proxy by using the administration console, do the following:
To change the properties of a TCP Proxy, run the set-tcp-proxy-prop
command. For example, the following command changes the session idle timeout of the proxy tcp_proxy1
in the configuration soa
to 500
.
tadm> set-tcp-proxy-prop --config=soa --tcp-proxy=tcp_proxy1 session-idle-timeout=500 OTD-70201 Command 'set-tcp-proxy-prop' ran successfully.
For the updated configuration to take effect, you should deploy it to the Oracle Traffic Director instances by using the deploy-config
command.
For a list of the properties that you can set or change by using the set-tcp-proxy-prop
commands, see the Oracle Traffic Director Command-Line Reference or run the commands with the --help
option.
You can delete TCP proxies by using either the administration console or the CLI.
Note:
When you delete a TCP Proxy, you are, in effect, modifying a configuration. So for the updated configuration to take effect in the Oracle Traffic Director instances, you should redeploy the configuration as described in Deploying a Configuration.
The CLI examples in this section are shown in shell mode (tadm>
). For information about invoking the CLI shell, see Accessing the Command-Line Interface.
Deleting a TCP Proxy Using the Administration Console
To delete a TCP Proxy by using the administration console, do the following:
To delete a TCP Proxy, run the delete-tcp-proxy
command, as shown in the following example:
tadm> delete-tcp-proxy --config=soa tcp_proxy1
OTD-70201 Command 'delete-tcp-proxy' ran successfully.
For the updated configuration to take effect, you should deploy it to the Oracle Traffic Director instances by using the deploy-config
command.
For more information about delete-tcp-proxy
, see the Oracle Traffic Director Command-Line Reference or run the command with the --help
option.