wpListener -start -

Starts the JSON wire listener.

Syntax diagram

Read syntax diagramSkip visual syntax diagram wpListener -start dbName name -mongoPort port -useriduserid -passwordpasswordkerberosOptions-hosthost:port-registrationFilefilename-debug-logPathpath-noSQLPropertyPathpath
Read syntax diagramSkip visual syntax diagram-minTCPThreadsminthreads-maxTCPThreadsmaxthreads
Read syntax diagramSkip visual syntax diagram-nosqltrc-jcctrc
kerberosOptions
Read syntax diagramSkip visual syntax diagram -kerberosPrincipal kerbprincipal -useriduserid -passwordpassword

Command parameters

-dbName name
This parameter specifies the name of the Db2® database that is used as the NoSQL data store.
-mongoPort port
This parameter specifies a port that is listening for messages that are based on the MongoDB wire protocol.
-userid userid
This parameter specifies the user ID for the backend server. If the -kerberosPrincipal option is specified, it is optional.
-password password
This parameter specifies the password of the user ID for the backend server. If -userid is specified but -password is not specified, the Wire Listener prompts the user to enter a password, and the entered password is not displayed.
-host hostname:port
This parameter specifies the host name or IP Address and port of the system that hosts the database.
-registrationFile filename
This parameter specifies a registration file. Providing a registration file starts the wire listener in authenticated mode. The registration file contains the user IDs and associated passwords. The user ID and password combination is used for authentication by the wire listener. This user ID and password combination might be a token to register trusted applications, a token per wire listener, or a password for an application proxy user.
-debug
This optional parameter enables tracing for the wire listener under json/logs directory unless the path is specified by the -logPath parameter.
-logPath path
This parameter specifies the path for storing log files.
-noSQLPropertyPathpath
This parameter specifies the path for loading the property files of NoSQL, nosql.properties, and JCC Properties, DB2JccConfiguration.properties.
-minTCPThreads minthreads
This optional parameter specifies the maximum number of transaction control protocol threads.
-minTCPThreads maxthreads
This optional parameter specifies the minimum number of transaction control protocol threads.
-nosqltrc
This optional parameter enables the nosql tracing under json/logs directory unless the path is specified by the -logPath parameter.
-jcctrc
This optional parameter enables the jcc tracing under json/logs directory unless the path is specified by the -logPath parameter.
-kerberosPrincipal kerbprincipal
This parameter specifies the Kerberos principal used for database connection using Kerberos authentication.

Example

Example 1: Start the wire listener without wire listener authentication:
wpListener -start -dbName sample -mongoPort 27017 
-userid db2admin -password pwd123 -debug  
-logPath c:/temp/logs
Example 2: Start the wire listener with wire listener authentication:
wpListener -start -dbName sample -mongoPort 27017 
-userid db2admin -password pwd123 -debug  
-logPath c:/temp/logs -registrationFile c:/temp/credentials.bin

Example 3: Start the wire listener with Kerberos authentication:

wplistener -start -dbName sample -mongoPort 27017 
-kerberosPrincipal kerbuser@machinedomain -userid db2admin -password pwd123