sp_listener

Description

Dynamically starts and stops Adaptive Server listeners on any given port on a per-server basis.

Considerations for process mode

When executed in process mode, sp_listener dynamically starts and stops Adaptive Server listeners on any given port on a per-engine basis.

Syntax

For threaded mode, the syntax is:

sp_listener “command”, “server_name | network”

Or:

sp_listener “command”, ‘[protocol:]machine:port:”CN=common_name”’

For process mode, the syntax is:

sp_listener “command”, “server_name | network”, engine | remaining

Or:

sp_listener “command”, ‘[protocol:]machine:port:”CN=common_name”’, engine

Parameters

Examples

Example 1

Start listeners for each master entry in the interfaces file corresponding to server orion:

sp_listener "start", "orion"

Example 2

Create TCP listeners for port number 4226:

sp_listener "start", "goldie:4226"

Example 3

Create listeners for all master entries in the interfaces file for server orion:

sp_listener "start", "orion", "remaining"

Example 4

Start TCP listeners on port 4226 on machine goldie for all engines not already listening to this port:

sp_listener "start", "goldie:4226", "remaining"

Example 5

Stop the listener on port number 4226:

sp_listener "stop", "tcp:goldie:4226"

Example 6

Stop all listeners on port number 4226. Because this command includes the remaining parameter, it will not fail if some engines are not listening to the port:

sp_listener "stop", "tcp:goldie:4226", "remaining"

Example 7

Suspend NT Winsock listener on port 4226:

sp_listener "suspend", "winsock:clouds:4226"

Example 8

Resume all active listeners on port number 4226:

sp_listener "resume", "tcp:goldie:4226", "remaining"

Example 9

Specify the common name ase1.big server 1.com:

sp_listener 'start','ssltcp:blade1:17251:
"CN=ase1.big server 1.com"','0'

Usage

• sp_listener uses either of two syntaxes, described in the syntax section, above. The first syntax affects all Adaptive Server master ports listed in the interfaces file. The second allows you to manage listeners not listed in the interfaces file.

• The attribute name “CN” is case-insensitive (it can be “CN”, “cn” or “Cn”), but the attribute value for the common name is case-sensitive.

• sp_listener ignores the engine parameter if you include it while running in threaded mode.

• The semantics for sp_listener is atomic: if a command cannot be completed successfully, it is aborted.

• When the host component of a sp_listener command is an IPv6 address, it should be encloded in brackets. For example, tcp:[2001:ec8:4008:1::123]:80

• You can issue the status parameter by itself. The status parameter displays the state of all the listeners in the interfaces file.

• A listener can be in one of the following states: stopped, suspended, or active. sp_listener allows you to move listeners between these states. A request to move to a nonpermissible state results in failure (For example, requesting to stop a non existent listener). Use sp_listener “status” to determine the state of a listener.

• The remaining parameter specifies that, for the command you are running (start, stop, resume, and so on), the command runs successfully for all listeners that are in a state that allow the change (for example, moving states from start to stop). For example, if you attempt to start listeners on engines one through six, but engines one, four, and five are unavailable, sp_listener... “remaining” starts listeners on engines two, three, and six, disregarding the offline engines. You cannot specify an engine number if you include the remaining parameter.

• The maximum number of listeners is 32. If you create an Adaptive Server with two master ports in the interfaces file, you can start at most 30 more listeners on other ports. Apart from the first listener, each supplementary listener consumes resources similar to a user connection, so in a setup where 25 user connections are configured, starting three listeners at start-up (corresponding to three master entries) leaves room for 30 user connections.

Permissions

The permission checks for sp_listener differ based on your granular permissions settings.

Auditing

Values in event and extrainfo columns from the sysaudits table are:

See also

For limitations related to IPV6 in sp_listener, see “Specifying a common name” in “Confidentiality of Data,” in the Security Administration Guide.