For distributed platformsFor z/OS platforms

Dynamic routing command

The setup, genPluginCfg, and genKeystore dynamicRouting command actions are used to generate the plug-in configuration and keystore files. The genPluginCfg dynamicRouting command action is used any time after the initial setup to regenerate the plugin-cfg.xml file. For example, when the Dynamic Routing feature is enabled on a new controller or a new web server is added. The genKeystore dynamicRouting command action is used to generate the keystore file. Each of the dynamicRouting command actions supports online help.

The commands for the Dynamic Routing feature:

setup

The setup dynamicRouting command generates a keystore in PKCS12 or JKS format and one or more WebSphere® plug-in configuration files. The keystore contains a personal certificate and both the memberRoot and controllerRoot signer certificates that allow secure communication between the WebSphere plug-in and the Dynamic Routing service. The same keystore is also be used to send HTTPS requests to applications in the Liberty collective members. The plug-in configuration file contains the <IntelligentManagement> stanza, which enables Intelligent Management in a WebSphere plug-in. The <IntelligentManagement> stanza contains one <ConnectorCluster> stanza that represents the collective. The <ConnectorCluster> stanza contains one <Connector> stanza for each controller where the Dynamic Routing feature is enabled.

To get command help, issue <Controller root>/bin/dynamicRouting help setup, which displays:

Description

The setup dynamicRouting command generates a keystore that contains a personal certificate and signer certificates that are required to enable secure communication between the Dynamic Routing service and clients. It also generates WebSphere plug-in configuration file with <IntelligentManagement> stanza, which enables Intelligent Management in the WebSphere plug-in.

Usage

dynamicRouting setup [options]

Options

--host=name
Required. The host name of the target Collective Controller.
--password[=pwd]
Required. The password for the Administrator user for the target Collective Controller. If no value is defined, you are prompted.
--port=num
Required. The HTTPS port number of the target Collective Controller.
--user=name
Required. An Administrator user for the target Collective Controller.
--pluginInstallRoot=path
Required. Fully qualified path of the WebSphere plug-in root directory on the web server host.
--webServerNames=webServerName[,webServerName1]
Required. Comma separated names of the web servers for which WebSphere plug-in configuration files need to be generated.
--keystorePassword[=pwd]
Required. The password for the generated keystore. If specified and no value is defined, you are prompted.
--keystoreType=type
Optional. The type of the generated keystore. Default type is JKS. Valid values are JKS and PKCS12.
--certificateSubject=DN
The DN for the generated SSL certificate. The default value, if unspecified is CN=value of --user argument,OU-client,O=ibm,C=us.
Note: When you use an LDAP user registry, you must specify the fully qualified DN of the administrator by using --CertificateSubject as the default form is probably not valid for your LDAP.

SSL certificates can be automatically trusted by setting the JVM property com.ibm.websphere.collective.utility.autoAcceptCertificates to true.

Note: The keystore that is generated by the setup and genKeystore commands is in JKS or PKCS12 format. It needs to be copied to a directory on the web server machine and converted to a CMS formatted store by running gskcmd. The CMS formatted store file (.kdb) must be moved to the directory <value of the --pluginInstallRoot argument>/config/<web server name>. The .rdb and .sth files must also be moved to the same directory.

Following is the output of the command when run with all required arguments:

./dynamicRouting setup --port=9444 --host=controller1.acme.com --user=admin --password=password --keystorePassword=keypass --pluginInstallRoot=/opt/HTTPServer_Plugins --webServerNames=webServer1,webServer2

Generating WebSphere plug-in configuration files for web servers webServer1, webServer2

Auto-accepting the certificate chain for target server. 
Certificate subject DN: CN=admin, OU=controller1, O=ibm, C=us

Successfully completed MBean request to the controller. 
Successfully generated WebSphere plug-in configuration files plugin-cfg-webServer1.xml, plugin-cfg-webServer2.xml
Generating keystore for web servers webServer1, webServer2
Successfully completed MBean request to the controller.
Successfully generated keystore plugin-key.jks.

Generated WebSphere plug-in configuration files plugin-cfg-webServer1.xml, plugin-cfg-webServer2.xml for web servers webServer1, webServer2. 
Also generated keystore file plugin-key.p12 that enables secure communication between the Dynamic Routing service and clients. 

Copy the WebSphere plug-in configuration file to the directory specified
in the WebSpherePluginConfig directive in the IBM HTTP Server httpd.conffile. 
Copy keystore file plugin-key.jks to a directory on the 
web server host, and run "gskcmd" to convert the keystore to CMS format and
to set personal certificate as the default.
For example:

gskcmd -keydb -convert -pw  <<password>> -db /tmp/plugin-key.jks -old_format jks -target /tmp/plugin-key.kdb -new_format cms -stash
gskcmd -cert -setdefault -pw <<password>> -db /tmp/plugin-key.kdb -label default

Copy resulting /tmp/plugin-key.kdb, .sth, .rdb files to the directory /opt/HTTPServer_Plugins/config/webServer1/

genPluginCfg

This action generates the plug-in configuration files. Each plug-in configuration file contains the <IntelligentManagement> stanza, which enables the Intelligent Management features of the plug-in. The <IntelligentManagement> stanza contains one <ConnectorCluster> stanza that represents the collective. The <ConnectCluster> stanza contains one <Connector> stanza for each controller where Dynamic Routing feature is enabled. Comma-separated web server names are specified to the --webServerNames argument. For example, if --webServerNames=webServer1,webServer2 is specified, plugin-cfg-webServer1.xml and plugin-cfg-webServer2.xml files are generated.

To get online help, issue <Controller root>/bin/dynamicRouting help genPluginCfg, this displays:

Description

Generates a WebSphere plug-in configuration file with a <IntelligentManagement> stanza that enables Intelligent Management in the WebSphere plug-in.

Usage

dynamicRouting genPluginCfg [options]

Options

--host=name
Required. The host name of the target Collective Controller.
--password[=pwd]
Required. The password for the Administrator user for the target Collective Controller. If no value is defined, you are prompted.
--port=num
Required. The HTTPS port number of the target Collective Controller.
--user=name
Required. An Administrator user for the target Collective Controller.
--pluginInstallRoot=path
Required. Fully qualified path of the WebSphere plug-in root directory on the web server host.
--webServerNames=webServerName[,webServerName1]
Required. Comma separated names of the web servers for which WebSphere plug-in configuration files need to be generated.

SSL certificates are automatically trusted by setting the JVM property com.ibm.websphere.collective.utility.autoAcceptCertificates to true.

Following is the output of the command when run with all required arguments:

./dynamicRouting setup --port=9444 --host=controller1.acme.com --user=admin --password=password --keystorePassword=keypass --pluginInstallRoot=/opt/HTTPServer_Plugins --webServerNames=webServer1,webServer2

This action generates the plug-in configuration files.
 
Generating WebSphere plug-in configuration file for web server webServer1

Auto-accepting the certificate chain for target server. 
Certificate subject DN: CN=admin, OU=controller1, O=ibm, C=us

Successfully completed MBean request to the controller. 
File /home/user1/Liberty/wlp/bin/plugin-cfg.xml exists. 
Saving to /home/user1/Liberty/wlp/bin/plugin-cfg.xml.old. 
Successfully generated WebSphere plug-in configuration file plugin-cfg.xml

Generated WebSphere plug-in configuration file plugin-cfg.xml for web server webServer1. 
Copy the WebSphere plug-in configuration file to the directory specified in the WebSpherePluginConfig directive in the IBM HTTP Server httpd.conf file.

genKeystore

This action generates a keystore in PKCS12 or JKS format. Use the --keystoreType action to specify the keystore format. Generation of the PKCS12 keystore is only supported when you use IBM Java. The keystore contains a personal certificate and both the memberRoot and controllerRoot signer certificates that allow secure communication between the WebSphere plug-in and the Dynamic Routing service. The same keystore is also be used to send HTTPS requests to applications in the Liberty collective members.

To get online help, issue <Controller root>/bin/dynamicRouting help genKeystore, this displays:

Description

Generates a keystore that contains a personal certificate and signer certificates that are required to enable secure communication between the Dynamic Routing service and clients.

Usage

dynamicRouting genKeystore [options]

Options

--host=name
Required. The host name of the target Collective Controller.
--password[=pwd]
Required. The password for the Administrator user for the target Collective Controller. If no value is defined, you are prompted.
--port=num
Required. The HTTPS port number of the target Collective Controller.
--user=name
Required. Specifies an Administrator user for the target Collective Controller.
--keystorePassword[=pwd]
Required. The password for the generated keystore. If specified and no value is defined, you are prompted.
--keystoreType=type
Optional. The type of the generated keystore. Default type is JKS. Valid values are JKS and PKCS12.
--certificateSubject=DN
The DN for the generated SSL certificate. The default value, if unspecified is CN=value of --user argument,OU-client,O=ibm,C=us.
Note: When you use an LDAP user registry, you must specify the fully qualified DN of the administrator by using --CertificateSubject as the default form is probably not valid for your LDAP.

SSL certificates are automatically trusted by setting the JVM property com.ibm.websphere.collective.utility.autoAcceptCertificates to true.

Following is the output of the command when run with all required arguments:

./dynamicRouting genKeystore --port=9444 --host=contoller1.acme.com --user=admin --password=password --keystorePassword

Enter password --keystorePassword: 
Re-enter password --keystorePassword: 

Auto-accepting the certificate chain for target server.
Certificate subject DN: CN=admin, OU=mycontroller, O=ibm, C=us

Generating keystore...
Successfully completed MBean request to the controller.
Successfully generated keystore plugin-key.jks.

Generated keystore file plugin-key.jks that enables secure communication between the Dynamic Routing service and clients.If you are using Intelligent Management in the WebSphere plug-in,
copy keystore file plugin-key.jks to a directory on the web server host,and run "gskcmd" to convert the keystore to CMS format and to set personal certificate as the default.
For example:

gskcmd  -keydb -convert -pw <<password>> -db /tmp/plugin-key.jks -old_format jks -target /tmp/plugin-key.kdb -new_format cms -stash
gskcmd -cert -setdefault -pw <<password>> -db /tmp/plugin-key.kdb -label default

Copy resulting /tmp/plugin-key.kdb, .sth, .rdb files to the keyring directory specified in the WebSphere plug-in configuration file.

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: Friday, 16 September 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=rwlp_wve_dynroutcollect
File name: rwlp_wve_dynroutcollect.html