Transfer server configuration to a member server


In IBM WebSphere Application Server Network Deployment Version 8.5.5, Liberty profile has introduced the Liberty collective feature. Refer to information about collectives in the IBM WebSphere Application Server Version 8.5.5 information center for more specifics.

The sample demonstrates how to call the FileTransfer MBean from a Jython script to transfer a server.xml file to a member server managed by a collective controller.

  • The FileTransfer MBean operation used:
    • uploadFile script

This sample script demonstrates how to transfer a server configuration file to a member server with given server name, server host name and server usr directory. A connection is made to the collective controller located at the given host and port, and the request to upload the server configuration file is passed to the FileTransfer MBean.

Because this script uses the FileTransfer MBean to upload one or more files, the remoteFileAccess element must be specified in the server.xml of the server that will receive the file(s). Without this you will get a file permission error when using the script. Here is an example of a remoteFileAccess element:


For further information and examples for remoteFileAccess, please visit the Information Center for "WebSphere Application Server V8.5 Liberty profile" and search for "List of provided MBean", "remoteFileAccess" or "Configuration elements in the server.xml" information center topics.

File transfer requires remote execution and access (RXA). Before running this sample script, ensure the target system(s) are configured for remote access. For more information on the remote execution and access requirements and setup, refer to Requirements for using Remote Execution and Access (RXA) in the information center.

This sample can be installed onto runtime version ${bvt.prop.appliesto.minimum.version}.


Required parameters

First parameter The path to the server.xml to transfer.
--serverName The name of the member server to transfer the configuration.
--serverHost The host name where the collective member is installed.
--serverUsrdir The usr directory where the collective member is installed.
--truststore The path to the truststore to be used when establishing a connection to the collective controller.
--truststorePassword The password for the truststore specified by the --truststore parameter.
--host The host name where the collective controller is running.
--port The https port where the collective controller is listening.
--user The user name to use when connecting to the collective controller.
--password The password to use when connecting to the collective controller.

Optional parameters

--help Displays help text.
--debug Displays additional details when an error occurs.

Sample use and resulting messages

>> jython path/to/server.xml --serverName=member1 --serverHost=localhost --serverUsrdir=c:\Liberty\usr --host=localhost --port=9443 --user=admin --password=password --truststorePassword=tsPassword --truststore=c:\Liberty\usr\servers\controller1\resources\security\trust.jks 

Connecting to the server...
Successfully connected to the server "localhost:9443"
Pushing the server.xml to server localhost,C:\Liberty\usr,member1


The following additional sample scripts provide shared code which is used by this sample:


Sample Structure

  • Copyright.txt
  • lib
  • readme.html