Change, Copy, and Create Channel Listener on Multiplatforms

The Change Channel Listener command changes existing channel listener definitions. The Copy and Create Channel Listener commands create new channel listener definitions - the Copy command uses attribute values of an existing channel listener definition.

The Change Channel Listener (MQCMD_CHANGE_LISTENER) command changes the specified attributes of an existing IBM MQ listener definition. For any optional parameters that are omitted, the value does not change.

The Copy Channel Listener (MQCMD_ COPY_LISTENER) command creates an IBM MQ listener definition, using, for attributes not specified in the command, the attribute values of an existing listener definition.

The Create Channel Listener (MQCMD_CREATE_LISTENER) command creates an IBM MQ listener definition. Any attributes that are not defined explicitly are set to the default values on the destination queue manager.

Required parameters (Change and Create Channel Listener)

ListenerName (MQCFST)

The name of the listener definition to be changed or created (parameter identifier: MQCACH_LISTENER_NAME).

The maximum length of the string is MQ_LISTENER_NAME_LENGTH.

TransportType (MQCFIN)

Transmission protocol (parameter identifier: MQIACH_XMIT_PROTOCOL_TYPE). The value can be:

MQXPT_TCP

TCP.

MQXPT_LU62

LU 6.2. This value is valid only on Windows.

MQXPT_NETBIOS

NetBIOS. This value is valid only on Windows.

MQXPT_SPX

SPX. This value is valid only on Windows.

Required parameters (Copy Channel Listener)

FromListenerName (MQCFST)

The name of the listener definition to be copied from (parameter identifier: MQCACF_FROM_LISTENER_NAME).

This parameter specifies the name of the existing listener definition that contains values for the attributes not specified in this command.

The maximum length of the string is MQ_LISTENER_NAME_LENGTH.

ToListenerName (MQCFST)

To listener name (parameter identifier: MQCACF_TO_LISTENER_NAME).

This parameter specifies the name of the new listener definition. If a listener definition with this name exists, Replace must be specified as MQRP_YES.

The maximum length of the string is MQ_LISTENER_NAME_LENGTH.

Optional parameters (Change, Copy, and Create Channel Listener)

Adapter (MQCFIN)

Adapter number (parameter identifier: MQIACH_ADAPTER).

The adapter number on which NetBIOS listens. This parameter is valid only on Windows.

Backlog (MQCFIN)

Backlog (parameter identifier: MQIACH_BACKLOG).

The number of concurrent connection requests that the listener supports.

Commands (MQCFIN)

Adapter number (parameter identifier: MQIACH_COMMAND_COUNT).

The number of commands that the listener can use. This parameter is valid only on Windows.

IPAddress (MQCFST)

IP address (parameter identifier: MQCACH_IP_ADDRESS).

IP address for the listener specified in IPv4 dotted decimal, IPv6 hexadecimal notation, or alphanumeric host name form. If we do not specify a value for this parameter, the listener listens on all configured IPv4 and IPv6 stacks.

The maximum length of the string is MQ_LOCAL_ADDRESS_LENGTH

ListenerDesc (MQCFST)

Description of listener definition (parameter identifier: MQCACH_LISTENER_DESC).

This parameter is a plain-text comment that provides descriptive information about the listener definition. It must contain only displayable characters.

If characters are used that are not in the coded character set identifier (CCSID) for the queue manager on which the command is executing, they might be translated incorrectly.

The maximum length of the string is MQ_LISTENER_DESC_LENGTH.

LocalName (MQCFST)

NetBIOS local name (parameter identifier: MQCACH_LOCAL_NAME).

The NetBIOS local name that the listener uses. This parameter is valid only on Windows.

The maximum length of the string is MQ_CONN_NAME_LENGTH

NetbiosNames (MQCFIN)

NetBIOS names (parameter identifier: MQIACH_NAME_COUNT).

The number of names that the listener supports. This parameter is valid only on Windows.

Port (MQCFIN)

Port number (parameter identifier: MQIACH_PORT).

The port number for TCP/IP. This parameter is valid only if the value of TransportType is MQXPT_TCP.

Replace (MQCFIN)

Replace attributes (parameter identifier: MQIACF_REPLACE). If a namelist definition with the same name as ToListenerName exists, this definition specifies whether it is to be replaced. The value can be:

MQRP_YES

Replace existing definition.

MQRP_NO

Do not replace existing definition.

Sessions (MQCFIN)

NetBIOS sessions (parameter identifier: MQIACH_SESSION_COUNT).

The number of sessions that the listener can use. This parameter is valid only on Windows.

Socket (MQCFIN)

SPX socket number (parameter identifier: MQIACH_SOCKET).

The SPX socket on which to listen. This parameter is valid only if the value of TransportType is MQXPT_SPX.

StartMode (MQCFIN)

Service mode (parameter identifier: MQIACH_LISTENER_CONTROL). Specifies how the listener is to be started and stopped. The value can be any of the following values:

MQSVC_CONTROL_MANUAL

The listener is not to be started automatically or stopped automatically. It is to be controlled by user command. This value is the default value.

MQSVC_CONTROL_Q_MGR

The listener being defined is to be started and stopped at the same time as the queue manager is started and stopped.

MQSVC_CONTROL_Q_MGR_START

The listener is to be started at the same time as the queue manager is started, but is not requested to stop when the queue manager is stopped.

TPName (MQCFST)

Transaction program name (parameter identifier: MQCACH_TP_NAME).

The LU 6.2 transaction program name. This parameter is valid only on Windows.

The maximum length of the string is MQ_TP_NAME_LENGTH