Intelligent Management: middleware descriptor administrative tasks

Use the middleware descriptor administrative tasks to list the middleware descriptors and versions, display or change middleware descriptor information, and modify the middleware descriptor discovery interval.

Manage the middleware descriptors in the environment:

• listMiddlewareDescriptors
• listMiddlewareDescriptorVersions
• showMiddlewareDescriptorInformation
• modifyMiddlewareDescriptorProperty
• modifyMiddlewareDescriptorDiscoveryInterval

listMiddlewareDescriptors

The listMiddlewareDescriptors command lists the installed middleware descriptors in the cell.

Required parameters: None

Return value.

The command returns a list of the middleware descriptors, for example:

jboss_server
application_server
liberty_server
phpRuntime
customhttp_server
wasceRuntime
apacheWebServerRuntime
apache_server
weblogic_server
tomcat_server

Batch mode example usage

• Use Jacl:

  $AdminTask listMiddlewareDescriptors
  

• Use Jython:

  AdminTask.listMiddlewareDescriptors()
  

listMiddlewareDescriptorVersions

The listMiddlewareDescriptorVersions command lists which versions have specific information provided in the middleware descriptors.

Required parameters

• -name: Name of the middleware descriptor. (String, required)

Return value.

A list of versions that have specific information provided in the middleware descriptor. For example:

default

Batch mode example usage

• Use Jacl:

  $AdminTask listMiddlewareDescriptorVersions {-name wasceRuntime}
  

• Use Jython:

  AdminTask.listMiddlewareDescriptorVersions ('[-name wasceRuntime]')
  

Interactive mode example usage

• Use Jacl:

  $AdminTask listMiddlewareDescriptorVersions {-interactive}
  

• Use Jython:

  AdminTask.listMiddlewareDescriptorVersions ([-interactive]')
  

showMiddlewareDescriptorInformation

The showMiddlewareDescriptorInformation command displays the contents of the specified middleware descriptor.

Required parameters

• -name: Name of the middleware descriptor. (String, required)

Return value.

An example of the command output follows:

wasceRuntime:
        Discovery Interval: 4 min

        Version: default                 install.locations:win.install.loc="C:\\Program
Files\\IBM\\WebSphere\\AppServerCommunityEdition;C:\\Program Files
(x86)\\WebSphere\\AppServerCommunityEdition"
               
install.locations:unix.install.loc="/opt/IBM/WebSphere/AppServerCommunityEdition"
               
install.locations:foreign.discovery.class="com.ibm.ws.xd.agent.discovery.wasce.WASCEDiscoveryPlugin"
                timeOutGroup:startTimeOutValue="300000"
                timeOutGroup:stopTimeOutValue="300000"

Batch mode example usage

• Use Jacl:

  $AdminTask showMiddlewareDescriptorInformation {-name wasceRuntime}
  

• Use Jython:

  AdminTask.showMiddlewareDescriptorInformation ('[-name wasceRuntime]')
  

Interactive mode example usage

• Use Jacl:

  $AdminTask showMiddlewareDescriptorInformation {-interactive}
  

• Use Jython:

  AdminTask.showMiddlewareDescriptorInformation ([-interactive]')
  

modifyMiddlewareDescriptorProperty

Use the modifyMiddlewareDescriptorProperty command to edit the middleware descriptor properties.

Required parameters

• -name: Name of the middleware descriptor.
• -version: Middleware descriptor version.
• -propName: Property for the middleware descriptor. This property name can be any property that displays when running the showMiddlewareDescriptorInformation command for the middleware descriptor.
• -propValue: Middleware descriptor property.

Return value. None.

Batch mode example usage

• Use Jacl:

  $AdminTask modifyMiddlewareDescriptorProperty {-name wasceRuntime
  -version default -propName install.locations:win.install.loc -propValue
  c:\blade\server1 }
  

• Use Jython:

  AdminTask.modifyMiddlewareDescriptorProperty ('[-name wasceRuntime -version default -propName 
  install.locations:win.install.loc -propValue
  c:\blade\server1]')
  

Interactive mode example usage

• Use Jacl:

  $AdminTask modifyMiddlewareDescriptorProperty {-interactive}
  

• Use Jython:

  AdminTask.modifyMiddlewareDescriptorProperty ([-interactive]')
  

modifyMiddlewareDescriptorDiscoveryInterval

Use the modifyMiddlewareDescriptorDiscoveryInterval command to modify the discovery interval of the selected middleware descriptor.

Required parameters

• -name: Name of the middleware descriptor.
• -interval: The integer value of the discovery interval. We can use one of the following values:
  • -1: Disables automatic discovery.
  • 0 : Performs middleware discovery when the node agent starts.
  • value greater than 0: That middleware discovery runs when the node agent starts and at the integer value interval.

• -units: Units for the discovery interval. Use one of the following values:
  • seconds
  • minutes
  • hours
  • days

Return value. None.

Batch mode example usage

• Use Jacl:

  $AdminTask modifyMiddlewareDescriptorDiscoveryInterval {-name wasceRuntime
  -interval 5 -units seconds}
  

• Use Jython:

  AdminTask.modifyMiddlewareDescriptorDiscoveryInterval ('[-name wasceRuntime -interval 5 -units seconds]')
  

Interactive mode example usage

• Use Jacl:

  $AdminTask modifyMiddlewareDescriptorProperty {-interactive}
  

• Use Jython:

  AdminTask.modifyMiddlewareDescriptorProperty ([-interactive]')
  

Configure middleware descriptors