(dist)(zos)(v8550)

Intelligent Management: administrative tasks for web servers

Intelligent Management capabilities are available for Apache or IBM HTTP servers in managed and unmanaged nodes. We can use the command line to run administrative tasks for Intelligent Management.

The GenPluginCfg command generates a plug-in from the command-line interface. If we run this command, Intelligent Management capabilities are included, if they are enabled. To learn more about the Intelligent Management capabilities, read about configuring Intelligent Management for web servers.

Run the following commands from wsadmin prompt:

Command list

• addRemoteCellToIntelligentManagement

• addConditionalTraceRuleForIntelligentManagement

• removeConditionalTraceRuleForIntelligentManagement

• setDefaultTraceRuleForIntelligentManagement

• listTraceRulesForIntelligentManagement

• addPluginPropertyForIntelligentManagement

• removePluginPropertyForIntelligentManagement

• deleteRemoteCellFromIntelligentManagement

• disableIntelligentManagement

• enableIntelligentManagement

• listRemoteCellsFromIntelligentManagement

• modifyIntelligentManagement

• refreshCellForIntelligentManagement

addRemoteCellToIntelligentManagement

The addRemoteCellToIntelligentManagement command adds remote cell connectors to Intelligent Management.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

-host

The host name for the remote cell. (String, required)

-port

The port for the remote cell. (Integer, required)

-importCertificates

Whether to import certificates. Valid values are true or false. (String, required)

Optional parameters

-cellIdentifier

Unique cell identifier. The default value is the cell name.

-userid

The user ID for the remote cell. Only required if security is enabled.

-password

The password for the remote cell. Only required if security is enabled.

-enable

Enables an Intelligent Management remote cell. The default value is true.

Batch mode example

• Jacl:

  $AdminTask addRemoteCellToIntelligentManagement {-node unmanagednode1 -webserver ws1 -host  test1.ibm.com -port 8879 -userid janedoe -password pw1234 -importCertificates true}
  (cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)

• Jython string...

  AdminTask.addRemoteCellToIntelligentManagement(['-node', 'unmanagednode1', '-webserver',  'ws1', '-host', 'test1.ibm.com', '-port', '8879', '-userid', 'janedoe', '-password', 'pw1234',  '-importCertificates', 'true'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask addRemoteCellToIntelligentManagement {-interactive}

• Jython string...
  AdminTask.addRemoteCellToIntelligentManagement ('[-interactive]')

addConditionalTraceRuleForIntelligentManagement

The addConditionalTraceRuleForIntelligentManagement command adds conditional trace rules for Intelligent Management.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

-condition

Trace condition. If the condition option is not specified, then conditional trace is not set. The trace is always displayed.

-spec

Indicates the trace specification. If the -spec option is not specified, all the trace specifications are set by default. For each specification parameter, we can choose one of the following trace levels:

• emerg

• alert

• critical

• error

• warning

• notice

• info

• debug

• off

The default level value is notice.

Batch mode example

• Jacl:

  wsadmin>$AdminTask addConditionalTraceRuleForIntelligentManagement { -node
   unmanagednode1 -webserver ws1 -spec "http.request:DEBUG" -condition "port=1" }

• Jython string...
  AdminTask.addConditionalTraceRuleForIntelligentManagement(['-node', 'unmanagednode1', '-webserver', 'ws1', '-spec', 'http.request:DEBUG', '-condition', 'port=1'])

Interactive mode

• Jacl:
  $AdminTask addConditionalTraceRuleForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.addConditionalTraceRuleForIntelligentManagement ('[-interactive]')

removeConditionalTraceRuleForIntelligentManagement

The removeConditionalTraceRuleForIntelligentManagement command removes conditional trace rules for Intelligent Management.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

None.

Batch mode example

• Jacl:
  wsadmin>$AdminTask removeConditionalTraceRuleForIntelligentManagement { -node unmanagednode1 -webserver ws1 }

• Jython string...
  AdminTask.removeConditionalTraceRuleForIntelligentManagement(['-node', 'unmanagednode1', '-webserver', 'ws1'])

Interactive mode

• Jacl:
  $AdminTask removeConditionalTraceRuleForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.removeConditionalTraceRuleForIntelligentManagement ('[-interactive]')

setDefaultTraceRuleForIntelligentManagement

The setDefaultTraceRuleForIntelligentManagement command sets a default trace rule for Intelligent Management trace specification.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

-spec

Indicates the trace specification. For each specification parameter, we can choose one of the following trace levels:

• emerg

• alert

• critical

• error

• warning

• notice

• info

• debug

• off

The default level value is notice.

Batch mode example

• Jacl:
  wsadmin>$AdminTask setDefaultTraceRuleForIntelligentManagement { -node unmanagednode1 -webserver ws1 -spec "control.mapper:ERROR" }

• Jython string...

  AdminTask.setDefaultTraceRuleForIntelligentManagement(['-node', 'unmanagednode1',  '-webserver', 'ws1', '-spec', 'control.mapper:ERROR'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask setDefaultTraceRuleForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.setDefaultTraceRuleForIntelligentManagement ('[-interactive]')

listTraceRulesForIntelligentManagement

The listTraceRulesForIntelligentManagement command lists Intelligent Management trace rules.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

None.

Batch mode example

• Jacl:

  wsadmin>$AdminTask listTraceRulesForIntelligentManagement { -node unmanagednode1
   -webserver ws1 }
  "default control.mapper:ERROR true"
  "1 http.request:DEBUG port=1"

• Jython string...
  AdminTask.listTraceRulesForIntelligentManagement(['-node', 'unmanagednode1', '-webserver', 'ws1'])

Interactive mode

• Jacl:
  $AdminTask listTraceRulesForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.listTraceRulesForIntelligentManagement ('[-interactive]')

addPluginPropertyForIntelligentManagement

The addPluginPropertyForIntelligentManagement command adds a child <Property> element to the <IntelligentManagement> element in the plugin-cfg.xml file. The format in the plugin-cfg.xml file is: <Property name=inputname value=inputvalue/>

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

-name

Indicates the web server custom plug-in property name for Intelligent Management. (String, required)

-value

Indicates the web server custom plug-in property value for Intelligent Management. (String, required)

Optional parameters

None.

Batch mode example

• Jacl:
  $AdminTask addPluginPropertyForIntelligentManagement {-node node1 -webserver ws1 -name INPUTNAME -value inputvalue}

• Jython string...
  AdminTask.addPluginPropertyForIntelligentManagement(['-node', 'node1', '-webserver', 'ws1', '-name INPUTNAME', '-value', 'inputvalue'])

Interactive mode

• Jacl:
  $AdminTask addPluginPropertyForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.addPluginPropertyForIntelligentManagement ('[-interactive]')

removePluginPropertyForIntelligentManagement

The removePluginPropertyForIntelligentManagement command removes a child <Property> element from the <IntelligentManagement> element in the plugin-cfg.xml file.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

-name

Indicates the web server custom plug-in property name for Intelligent Management. (String, required)

Optional parameters

None.

Batch mode example

• Jacl:
  $AdminTask removePluginPropertyForIntelligentManagement {-node node1 -webserver ws1 -name INPUTNAME}

• Jython string...
  AdminTask.removePluginPropertyForIntelligentManagement(['-node', 'node1', '-webserver', 'ws1', '-name INPUTNAME'])

Interactive mode

• Jacl:
  $AdminTask removePluginPropertyForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.removePluginPropertyForIntelligentManagement ('[-interactive]')

deleteRemoteCellFromIntelligentManagement

The deleteRemoteCellFromIntelligentManagement command deletes a remote cell from Intelligent Management.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

-host

The host name for the remote cell. (String, required)

-port

The port for the remote cell. (Integer, required)

Optional parameters

None.

Batch mode example

• Jacl:

  $AdminTask deleteRemoteCellFromIntelligentManagement {-node unmanagednode1  -webserver ws1 -host test1.ibm.com -port 8879 -deleteCertificates true}
  (cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)

• Jython string...

  AdminTask.deleteRemoteCellFromIntelligentManagement(['-node', 'unmanagednode1',  '-webserver', 'ws1', '-host', 'test1.ibm.com', '-port', '8879', '-deleteCertificates', 'true'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask deleteRemoteCellFromIntelligentManagement {-interactive}

• Jython string...
  AdminTask.deleteRemoteCellFromIntelligentManagement ('[-interactive]')

disableIntelligentManagement

The disableIntelligentManagement disables Intelligent Management on the web server.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

None.

Batch mode example

• Jacl:

  $AdminTask disableIntelligentManagement {-node unmanagednode1 -webserver ws1}
  (cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526) 

• Jython string...

  AdminTask.disableIntelligentManagement(['-node', 'unmanagednode1', '-webserver', 'ws1'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask disableIntelligentManagement {-interactive}

• Jython string...
  AdminTask.disableIntelligentManagement ('[-interactive]')

enableIntelligentManagement

The enableIntelligentManagement command enables Intelligent Management.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

-cellIdentifier

Unique cell identifier. The default value is the cell name.

-retryInterval

Retry interval (in seconds) for enabling the Intelligent Management service. The default value is 60 seconds.

-maxRetries

Maximum number of retries for enabling the Intelligent Management service. The default value is -1.

Batch mode example

• Jacl:

  $AdminTask enableIntelligentManagement {-node unmangednode1 -webserver ws1  -retryInterval 120 -maxRetries "-1"}
  (cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)

• Jython string...

  AdminTask.enableIntelligentManagement(['-node', 'unmanagednode1', '-webserver', 'ws1',  '-retryInterval', '120', '-maxRetries', '-1'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask enableIntelligentManagement {-interactive}

• Jython string...
  AdminTask.enableIntelligentManagement ('[-interactive]')

listRemoteCellsFromIntelligentManagement

The listRemoteCellsFromIntelligentManagement command lists remote cells.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

None.

Batch mode example

• Jacl:

  wsadmin>$AdminTask listRemoteCellsFromIntelligentManagement { -node unmanagednode1  -webserver ws1 }
  "testell07 test1.ibm.com:8879"
  wsadmin>

• Jython string...

  wsadmin>AdminTask.listRemoteCellsFromIntelligentManagement(['-node', 'unmanagednode1',  '-webserver', 'ws1'])
  'testCell07 test1.ibm.com:8879'
  wsadmin>

Interactive mode

• Jacl:
  $AdminTask listRemoteCellsFromIntelligentManagement {-interactive}

• Jython string...
  AdminTask.listRemoteCellsFromIntelligentManagement ('[-interactive]')

modifyIntelligentManagement

The modifyIntelligentManagement command modifies Intelligent Management properties.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

-cellIdentifier

Unique cell identifier.

-retryInterval

Retry interval (in seconds) for enabling the Intelligent Management service.

-maxRetries

Maximum number of retries for enabling the Intelligent Management service.

Batch mode example

• Jacl:

  $AdminTask modifyIntelligentManagement {-node unmanagednode1 -webserver ws1  -retryInterval 90}
  (cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)

• Jython string...

  AdminTask.modifyIntelligentManagement(['-node', 'unmanagednode1', '-webserver',  'ws1', '-retryInterval', '90'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask modifyIntelligentManagement {-interactive}

• Jython string...
  AdminTask.modifyIntelligentManagement ('[-interactive]')

refreshCellForIntelligentManagement

The refreshCellForIntelligentManagement command refreshes cell connectors for Intelligent Management. Local and remote cells can be refreshed.

Required parameters

-node

Specifies the web server node name. (String, required)

-webserver

Specifies the web server name. (String, required)

Optional parameters

-local

Specifies if the cell is local. Values are true or false

-host

The host name for the remote cell. (String, required)

-port

The port for the remote cell. (Integer, required)

-userid

The user ID for the remote cell. Only required if security is enabled.

-password

The password for the remote cell. Only required if security is enabled.

Batch mode example

• Jacl:
  $AdminTask refreshCellForIntelligentManagement {-node unmanagednode1 -webserver ws1 -local false -host test1.ibm.com -port 8879 -userid janedoe -password pw1234}

• Jython string...

  AdminTask.refreshCellForIntelligentManagement(['-node', 'unmanagednode1', '-webserver',  'ws1 ', '-local', 'false', '-host', 'test1.ibm.com', '-port', '8879',  '-userid', 'janedoe', '-password', 'pw1234'])
  '(cells/testCell08/nodes/unmanagednode1/servers/ws1|intellmgmt.xml
  #IntelligentManagement_1350344826526)'

Interactive mode

• Jacl:
  $AdminTask refreshCellForIntelligentManagement {-interactive}

• Jython string...
  AdminTask.refreshCellForIntelligentManagement ('[-interactive]')

Related tasks

Configure Intelligent Management for web servers

Configure Intelligent Management properties for web servers

Configure trace on the web server plug-in

pluginIntelligentManagement.py script