Dynamically starts and stops SAP ASE 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 SAP ASE listeners on any given port on a per-engine basis.


For threaded mode, the syntax is:

sp_listener “command”, “server_name | network


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

For process mode, the syntax is:

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


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




There are additional considerations when using sp_listener:
  • sp_listener uses either of two syntaxes, described in the syntax section, above. The first syntax affects all SAP ASE 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 SAP ASE server with two master ports in the interfaces file, you can start at most 30 more listeners on other ports.

For limitations related to IPV6 in sp_listener, see Specifying a Common Name in the Security Administration Guide.


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


With granular permissions enabled, you must be a user with manage server privilege.


With granular permissions disabled, you must be a user with sa_role.


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



Audit option


Command or access audited

Execution of a procedure

Information in extrainfo
  • Roles – Current active roles

  • Keywords or options – NULL

  • Previous value – NULL

  • Current value – NULL

  • Other information – All input parameters

  • Proxy information – Original login name, if set proxy in effect