The GenPluginCfg 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 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
Implementing a web server plug-in.
Avoid trouble: You must delete the
plugin-cfg.xml file
in the
profile_root/config/cells directory
before you use this command. Otherwise, configuration changes do not
persist to the
plugin-cfg.xml file.
gotcha
Avoid trouble: You can update the
global plugin-cfg.xml file using the administrative
console or running the
GenPluginCfg command for
all of the clusters in a cell. However, you must delete the
config/cells/plugin-cfg.xml file before you update the
global plugin-cfg.xml file. If you do not
delete the
config/cells/plugin-cfg.xml file,
only the new properties and their values are added to the
global plugin-cfg.xml file. Any updates to existing
plug-in property values are not added to the
global plugin-cfg.xml file.
gotcha
Syntax
To regenerate the plug-in configuration
perform one of the following:
- Click on Servers > Server Types > Web servers in
the administrative console, select a web server and then click Generate
Plug-in.
- Issue the following command:
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.
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 the 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 CONFIG_ROOT. The setupCmdLine command is invoked
to get this environment variable.
- -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 WAS_CELL. The setupCmdLine command is invoked
to get this environment variable.
- -node.name node
- Defaults to WAS_NODE. The setupCmdLine command is invoked
to get this environment variable.
- -webserver.name webserver1
- Required for creating plug-in configuration file for a given Web
server.
- -propagate yes/no
- Applicable only when the webserver.name option
is specified and the web server is local. Otherwise, you must manually
copy the plugin-cfg.xml file from app_server_root/profiles/profile_name/config\cells\cell_name\nodes\node_name\servers\web_server_name to plugins_root/config/web_server_name in
the remote web server plugins directory. The default value is no.
- -propagateKeyring yes/no
- Applicable only when the option webserver.name is
specified and the web server is local. 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.
- -force yes
- Creates a new configuration instead of attempting to merge with
an exiting configuration when command is issued for a cell-wide file
generation.
- -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
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