GenPluginCfg command

This topic describes the command-line syntax for the GenPluginCfg command. This command is used to regenerate the WebSphere Web server plug-in configuration file, plugin-cfg.xml. For more information about where to run this command, see the Using command line tools article.

CAUTION:

Regenerating the plug-in configuration can overwrite manual configuration changes that you might want to preserve. Before performing this task, understand its implications as described in Communicating with Web servers. To regenerate the plug-in configuration, you can either click on Servers > Web Servers in the administrative console, select a Web server and then click Generate Plug-in, or you can issue the following command:

GenPluginCfg

Both methods for regenerating the plug-in configuration create a plugin-cfg.xml file in ASCII format, which is the proper format for execution in a distributed environment.

You can use the -profileName option to define the profile of the Application Server process in a multi-profile installation. The -profileName option is not required for running in a single profile environment. The default for this option is the default profile.

Syntax

The command syntax is as follows:

GenPluginCfg [[-option.name optionValue]...]

When the GenPluginCfg command is issued with the option -webserver.name webservrName, wsadmin generates a plug-in configuration file for the Web server. The settings in this generated configuration file are based on the list of applications that are deployed on the Web server. When this command is issued without the option -webserver.name webservrName, the plug-in configuration file is generated based on topology.

Parameters

The following options are available for the GenPluginCfg command:

-config.root configroot_dir: Defaults to environment variable CONFIG_ROOT.
-profileName: Defines the profile of the Application Server process in a multi-profile installation. The -profileName option is not required for running in a single profile environment. The default for this option is the default profile.
-cell.name cell: Defaults to environment variable WAS_CELL.
-node.name node: Defaults to environment variable WAS_NODE.
-webserver.name webserver1: Required for creating plug-in configuration file for a given Web server.
-propagate yes/no: Applicable only when the option webserver.name is specified. Defaults to no.
-cluster.name cluster1,cluster2 | ALL: Optional list of clusters. Ignored when the option webserver.name is specified.
-server.name server1,server2: Optional list of servers. Required for single server plug-in generation. Ignored when the option webserver.name is specified.
-output.file.name file_name: Defaults to the configroot_dir/plugin-cfg.xml file. Ignored when the option webserver.name is specified.
-destination.root root: Installation root of the machine configuration is used on. Ignored when the option webserver.name is specified.
-destination.operating.system windows/unix: Operating system of the machine configuration is used on. Ignored when the option webserver.name is specified.
-debug yes/no: Defaults to no.
-help: Prints a usage statement.
-?: Prints a usage statement.

Usage scenario

To generate a plug-in configuration for all of the clusters in a cell:

GenPluginCfg -cell.name NetworkDeploymentCell -profileName myprofile

To generate a plug-in configuration for a single server:

GenPluginCfg -cell.name BaseApplicationServerCell -node.name appServerNode -server.name appServerName

To generate a plug-in configuration file for a Web server:

GenPluginCfg -cell.name BaseApplicationServerCell -node.name webserverNode -webserver.name webserverName