Intelligent Management: middleware descriptor administrative tasks

We can 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.

Use the following commands to 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

• Jacl:
  $AdminTask listMiddlewareDescriptors

• 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

• Jacl:
  $AdminTask listMiddlewareDescriptorVersions {-name wasceRuntime}

• Jython:
  AdminTask.listMiddlewareDescriptorVersions ('[-name wasceRuntime]')

Interactive mode

• Jacl:
  $AdminTask listMiddlewareDescriptorVersions {-interactive}

• 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

• Jacl:
  $AdminTask showMiddlewareDescriptorInformation {-name wasceRuntime}

• Jython:
  AdminTask.showMiddlewareDescriptorInformation ('[-name wasceRuntime]')

Interactive mode

• Jacl:
  $AdminTask showMiddlewareDescriptorInformation {-interactive}

• Jython:
  AdminTask.showMiddlewareDescriptorInformation ([-interactive]')

modifyMiddlewareDescriptorProperty

We can use the modifyMiddlewareDescriptorProperty command to edit the middleware descriptor properties.

Required parameters

• name: Name of the middleware descriptor.

• version: Middleware descriptor version.

• propName: Specifies a property for the middleware descriptor. This property name can be any property that displays when you run the showMiddlewareDescriptorInformation command for the middleware descriptor.

• propValue: Specifies a value for the middleware descriptor property.

Return value

None.

Batch mode example

• Jacl:

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

• Jython:

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

Interactive mode

• Jacl:
  $AdminTask modifyMiddlewareDescriptorProperty {-interactive}

• Jython:
  AdminTask.modifyMiddlewareDescriptorProperty ([-interactive]')

modifyMiddlewareDescriptorDiscoveryInterval

We can use the modifyMiddlewareDescriptorDiscoveryInterval command to modify the discovery interval of the selected middleware descriptor.

Required parameters

• name: Name of the middleware descriptor.

• interval: 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: Specifies that middleware discovery runs when the node agent starts and at the integer value interval.

• units: Units for the discovery interval. We can use one of the following values:

  • seconds

  • minutes

  • hours

  • days

Return value

None.

Batch mode example

• Jacl:

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

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

Interactive mode

• Jacl:
  $AdminTask modifyMiddlewareDescriptorProperty {-interactive}

• Jython:
  AdminTask.modifyMiddlewareDescriptorProperty ([-interactive]')

Related tasks

Configure middleware descriptors