(dist)(zos)(v8550)

pluginIntelligentManagement.py script

Use the pluginIntelligentManagement.py script to perform Intelligent Management functions.

Location

To learn more about the Intelligent Management capabilities, read about configuring Intelligent Management for web servers.

The pluginIntelligentManagement.py script is in the app_server_root/bin directory. Before you run this script, ensure that we have the environment variable WAS_HOME configured to point to the WebSphere directory.

Operations

Perform the following operations with the pluginIntelligentManagement.py script:

• add RemoteCell

• deleteRemoteCell

• disable

• enable

• listRemoteCells

• modify

• modifyRemoteCells

• refreshLocalCell

• refreshRemoteCell

• addConditionalTraceRule

• setDefaultTraceRule

• removeConditionalTraceRule

• listTraceRules

• generatePlugin

• addRemoteCell <webServerNode>:<webServerName> <remoteCellHost> <remoteCellPort> <importCertificates> [-u <remoteCellUserId>] [-w <remoteCellPassword>] [-e <enableRemoteCellConnectors>] [-r <remoteCellId>]

  Add a remote cell to the list of cells for this web server. This operation enables a web server to extend the Intelligent Management service to multiple cells.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <remoteCellHost>	Host name for the remote cell.
  <remoteCellPort>	Port for the remote cell.
  <importCertificates>	Whether to import certificates. Valid values are true or false.
  <remoteCellUserId>	User ID for the remote cell.
  <remoteCellPassword>	Password for the remote cell.
  <enableRemoteCellConnectors>	Enables Intelligent Management remote cell connectors. Valid values are true or false.
  <remoteCellId>	Unique cell identifier. The default is the cell host name.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython addRemoteCell myNode:myWebserver remoteHostname 8879 true

  Add the remote cell that is managed by the server at remoteHostname:8879 to the list of cells that myWebserver can communicate with via Intelligent Management.

• deleteRemoteCell <webServerNode>:<webServerName> <remoteHost> <remotePort> <deleteCertificates>

  Removes a remote cell from the list of cells for this web server. Use this operation to configure the Intelligent Management environment.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <remoteHost>	Host name for the remote cell.
  <remotePort>	Port for the remote cell.
  <deleteCertificates>	Delete certificates. Valid values are true or false.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython deleteRemoteCell myNode:myWebserver remoteHostname 8879 true

  Removes the remote cell that is managed by the server at remoteHostname:8879 from the list of cells that myWebserver can communicate with via Intelligent Management.

• disable <webServerNode>:<webServerName>

  Disables Intelligent Management for this web server if Intelligent Management is not required.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython disable myNode:myWebserver

  Disables the Intelligent Management service for myWebServer.

• enable <webServerNode>:<webServerName>[-i <retryInterval>] [-r <maxRetries>] [-x <cellId>]

  Enables Intelligent Management for a web server. By enabling theIntelligent Management service, we can take advantage of Intelligent Management capabilities.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <retryInterval>	Time interval (in seconds) between connection attempts.
  <maxRetries>	Maximum number of retries for enabling the Intelligent Management service. Valid values are: zero, positive integer numbers, and infinite.
  <cellId>	Unique cell identifier.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython enable myNode:myWebserver

  Enables the Intelligent Management service for myWebServer.

• listRemoteCells <webServerNode>:<webServerName>

  This operation lists the remote cells for a web server. These remote cells are available for Intelligent Management service.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython listRemoteCells myNode:myWebserver

  Lists the remote cells that the Intelligent Management service on myWebserver can reach.

• modify<webServerNode>:<webServerName> [-i <retryInterval>] [-r <maxRetries>] [-x <cellId>]

  Modifies Intelligent Management properties for a web server. Use this operation to configure the Intelligent Management service.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <retryInterval>	Time interval (in seconds) between connection attempts.
  <maxRetries>	Maximum number of retries for enabling the Intelligent Management service. Valid values are: zero, positive integer numbers, and infinite.
  <cellId>	Unique cell identifier.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython modify myNode:myWebserver -i 10 -r 5

  Changes the settings for communicating with the Intelligent Management service on myWebserver to retry connecting a maximum of five times, with a 10-second wait after a failure.

• modifyRemoteCell<webServerNode>:<webServerName> <remoteCellHost> <remoteCellPort> [-e <enableRemoteCellConnectors>] [-r <remoteCellId>]

  Modifies a remote cell for a web server. Use this operation to change remote cell properties.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <remoteCellHost>	Host name for the remote cell.
  <remoteCellPort>	Port for the remote cell.
  <enableRemoteCellConnectors>	Enables Intelligent Management remote cell connectors. Valid values are true or false.
  <remoteCellId>	Unique cell identifier.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython modifyRemoteCell myNode:myWebserver remoteHostname 8879 -u username -w password

  Changes the login credentials for the remote cell that is managed by the server at remoteHostname:8879 to username and password.

• refreshLocalCell<webServerNode>:<webServerName>

  Use this operation to refresh the local cell connectors for the web server.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython refreshLocalCell myNode:myWebserver

  Refreshes the local cell connectors on myWebserver.

• refreshRemoteCell<webServerNode>:<webServerName> <remoteCellHost> <remoteCellPort> [-u <remoteCellUserId>] [-w <remoteCellPassword>]

  Use this operation to refresh the remote cell connectors for the web server.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <remoteCellHost>	Host name for the remote cell.
  <remoteCellPort>	Port for the remote cell.
  <remoteCellUserId>	User ID of the remote cell.
  <remoteCellPassword>	Password for the remote cell.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython refreshRemoteCell myNode:myWebserver remoteHostname 8879

  Refreshes the local information about remoteHostname:8879.

• addConditionalTraceRule<webServerNode>:<webServerName>[-x <traceCondition>] [-s <traceSpecification>]

  Sets the conditional trace specification for a web server. Use this operation to configure conditional tracing from the web server plug-in.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <traceCondition>	Trace condition.
  <traceSpecification>	Indicates the trace specification. For each trace specification, we can indicate one of the following levels: emerg alert critical error warning notice info debug off all The default level is notice.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py addConditionalTraceRule unmanagednode1:ws1 -x "port=3" -s "control.mapper:INFO"

  Add the rule control.mapper:INFO with the condition port=3 on a web server ws1.

• setDefaultTraceRule<webServerNode>:<webServerName>[-s <traceSpecification>]

  Sets the default trace rule for a web server.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)
  <traceSpecification>	Indicates the trace specification. For each trace specification, we can indicate one of the following levels: emerg alert critical error warning notice info debug off all The default level is notice.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py setDefaultTraceRule unmanagednode1:ws1 -s "control.mapper:ERROR"

  Sets the default rule control.mapper:ERROR for a web server ws1.

• removeConditionalTraceRule<webServerNode>:<webServerName>

  Removes a conditional trace rule from the web server. Use this operation to manage the conditional trace rules in the environment.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py removeConditionalTraceRule unmanagednode1:ws1

  Removes the conditional trace rules on the web server ws1.

• listTraceRules<webServerNode>:<webServerName>

  Lists the trace rules for a web server. These trace rules are set on the web server.

  Argument	Description
  <webServerNode>	Specifies the web server node name. (String, required)
  <webServerName>	Specifies the web server name. (String, required)

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py listTraceRules unmanagednode1:ws1
   default control.mapper:ERROR true

  Lists trace rules on web server ws1. The output of the command is default control.mapper:ERROR true.

• generatePlugin<dmgrRoot> <cellName> <nodeName> <webServerName>

  Generates a plug-in required by the web server. The plug-in configuration file stores all the Intelligent Management settings.

  Argument	Description
  <dmgrRoot>	dmgr profile directory.
  <cellName>	Name of the cell which contains the web server to be configured.
  <nodeName>	Name of the node which contains the web server to be configured.
  <webServerName>	Name of the web server to be configured.

  Example:

  ./wsadmin.sh -f pluginIntelligentManagement.py -lang jython generatePlugin /opt/WebSphere/AppServer/profiles/Dmgr01 myCell myNode myWebserver

  Generates the Intelligent Management files that are required by myWebserver.

Related tasks

Configure Intelligent Management for web servers

Configure Intelligent Management properties for web servers

Configure trace on the web server plug-in

Intelligent Management: administrative tasks for web servers