InfoCenter Home >
6: Administer applications >
6.6: Tools and resources quick reference >
6.6.0: About user assistance >
6.6.0.2: Command line administration >
6.6.0.2.1: XMLConfig command line interface for XML configuration >
6.6.0.2.1.1: XMLConfig - Command syntax >
6.6.0.2.1.1.1: XMLConfig - Example of a full export

6.6.0.2.1.1.1: XMLConfig - Example of a full export

The following example shows the XML elements for each object type in the WebSphere administrative domain. It is a full export of the administrative repository, featuring the default administrative configuration.

To produce a similar export, you would issue the command:

XMLConfig -adminNodeName host_name -export export.xml

where host_name is the host name of the machine that contains the administrative server and export.xml is the name of the output file.

When you perform an export, the XML output file does not contain blank lines or gaps. In contrast, the following export has been broken into segments, each of which is briefly discussed.

Also, this example was obtained from a system that used the default configuration, and might vary slightly from actual output due to changes on your particular system. It is recommended that you try the export command yourself to see exactly what output is produced.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE websphere-sa-config
SYSTEM "file:///$XMLConfigDTDLocation$$dsep$xmlconfig.dtd">
<websphere-sa-config>

These tags mark the beginning of the export. The following part of the export contains a tag for the default virtual host, default_host, in the administrative domain.

The default host recognizes several MIME types, which are listed as part of a MIME table in the virtual-host tag. In fact, there are so many MIME types that many are omitted from the example. These are followed by the aliases for the virtual host.

Skip ahead
<virtual-host action="update" name="default_host">
<mime-table>
<mime type="application/vnd.lotus-wordpro">
<ext>lwp</ext>
<ext>sam</ext>
</mime>
<mime type="text/tab-separated-values">
<ext>tsv</ext>
</mime>
<mime type="application/x-troff-me">
<ext>me</ext>
</mime>
<mime type="image/x-portable-anymap">
<ext>pnm</ext>
</mime>
<mime type="text/x-ssi-html">
<ext>htmls</ext>
<ext>shtml</ext>
</mime>
<mime type="application/vnd.lotus-screencam">
<ext>scm</ext>
</mime>
<mime type="application/xml">
<ext>xsl</ext>
</mime>
...
</mime-table>
<alias-list>
<alias>*:80</alias>
<alias>*:9080</alias>
</alias-list>
</virtual-host>

Next is the Java Messaging Service (JMS) configuration:

Skip ahead
<jms-provider action="update" name="IBM MQSeries">
<description>(OPTIONAL) Description of JMS provider.</description>
<external-initial-context-factory>
com.ibm.websphere.naming.WsnInitialContextFactory
</external-initial-context-factory>
<external-provider-url>iiop://localhost</external-provider-url>
<jndi-binding-mechanism/>
<jms-connection-factory action="update" name="Test JMSConnFactory">
<description>Test factory</description>
<jndi-name>jms/Test JMSConnFactory</jndi-name>
<external-jndi-name>TestJMSFactory</external-jndi-name>
</jms-connection-factory>
<jms-destination action="update" name="JMSTestDest">
<description>JMS destination </description>
<external-jndi-name>JMSDest</external-jndi-name>
<jndi-name>jms/JMSTestDest</jndi-name>
</jms-destination>
</jms-provider>

The following configuration describes a resource adaptor for CICS:

Skip ahead
<j2c-resource-adapter action="update" name="TestJ2cAdapter">
<description>TestJ2cAdapter</description>
<archive-file>D:\WebSphere\AppServer\bin\cicseci.rar</archive-file>
<j2c-adapter-install-info>
<node-name>subodh</node-name>
<resource-archive-file>
D:\WebSphere\AppServer\installedConnectors\cicseci.rar
</resource-archive-file>
</j2c-adapter-install-info>
<j2c-connection-factory action="update" name="TestFactory">
<jndi-name>TestJ2cFactory</jndi-name>
<description>Test factory</description>
<connection-timeout>0</connection-timeout>
<maximum-connections>0</maximum-connections>
<minimum-connections>0</minimum-connections>
<reap-time>0</reap-time>
<unused-timeout>0</unused-timeout>
<pool-name>POOLNAME</pool-name>
<subpool-name>SUBPOOLNAME</subpool-name>
<config-property name="TraceLevel" value="1">
<description>(OPTIONAL)The level of trace to be output
to the Server Trace Log. Range 0-3. 0=off,
1=exceptions, 2=1+entry/exit, 3=2+debug</description>
<type>java.lang.Integer</type>
</config-property>
<config-property name="ServerSecurity" value="">
<description>(OPTIONAL)Fully Qualified Class
implementing ServerSecurity for connections to the
Gateway (use on conjunction with ClientSecurity
</description>
<type>java.lang.String</type>
</config-property>
<config-property name="PortNumber" value="2006">
<description>The port number the gateway is listening on</description>
<type>java.lang.String</type>
</config-property>
<config-property name="KeyRingPassword" value="">
<description>The Password for the KeyRing Class</description>
<type>java.lang.String</type>
</config-property>
<config-property name="ConnectionURL" value="">
<description>The URL of the CICS Transaction Gateway</description>
<type>java.lang.String</type>
</config-property>
<config-property name="ClientSecurity" value="">
<description>(OPTIONAL)Fully Qualified Class
implementing ClientSecurity for connections to the
Gateway (use on conjunction with ServerSecurity</description>
<type>java.lang.String</type>
</config-property>
<config-property name="TranName" value="">
<description>The Transaction name for programs to run under.
</description>
<type>java.lang.String</type>
</config-property>
<config-property name="TPNName" value="">
<description>The TPN id for programs to run under. This
takes precedence over TranName.</description>
<type>java.lang.String</type>
</config-property>
<config-property name="Password" value="">
<description>A Password for the UserName</description>
<type>java.lang.String</type>
</config-property>
<config-property name="ServerName" value="">
<description>The CICS Server as defined in the CICS
Transaction Gateway</description>
<type>java.lang.String</type>
</config-property>
<config-property name="UserName" value="">
<description>A user Name to access CICS Resources</description>
<type>java.lang.String</type>
</config-property>
<config-property name="KeyRingClass" value="">
<description>Fully Qualified Class containing the SSL
Keyrings. Required only for SSL protocol</description>
<type>java.lang.String</type>
</config-property>
</j2c-connection-factory>
</j2c-resource-adapter>

Next is the configuration for the default URL provider:

Skip ahead
<url-provider action="update" name="Default URL Provider">
<description>This is the URL Provider for the protocols
supported by the JDK (e.g., http, file, ftp, etc.).  The
protocol and stream handler class name properties are not
used for this provider.</description>
<protocol>unused</protocol>
<stream-handler-class-name>unused</stream-handler-class-name>
<url action="create" name="TestURL">
<description>test ur</description>
<specification>testurl.com</specification>
<jndi-name>testurl</jndi-name>
</url>
<install-info>
<node-name>subodh</node-name>
<jar-file-location>unused</jar-file-location>
</install-info>
</url-provider>

The following configuration is for JavaMail:

Skip ahead
<mail-session action="update" name="TestMailSession">
<description>Test mail sesson</description>
<jndi-name>TestMail</jndi-name>
<mail-transport-protocol>smtp</mail-transport-protocol>
<mail-transport-host>testServer</mail-transport-host>
<mail-transport-user>testuser</mail-transport-user>
<mail-transport-password>test</mail-transport-password>
<mail-from>testoriginator</mail-from>
<mail-store-protocol>imap</mail-store-protocol>
<mail-store-host>testhost</mail-store-host>
<mail-store-user>testuser</mail-store-user>
<mail-store-password>test</mail-store-password>
</mail-session>

The following section contains information about the JDBC database driver and datasources. The configuration contains multiple data-source elements, only one of which is shown:

Skip ahead
<jdbc-driver action="update" name="Sample DB Driver">
<implementation-class>
COM.ibm.db2.jdbc.DB2ConnectionPoolDataSource
</implementation-class>
<description/>
<data-source action="update" name="SampleDataSource">
<database-name>was</database-name>
<minimum-pool-size>1</minimum-pool-size>
<maximum-pool-size>10</maximum-pool-size>
<connection-timeout>180</connection-timeout>
<idle-timeout>1800</idle-timeout>
<orphan-timeout>1800</orphan-timeout>
<statement-cache-size>100</statement-cache-size>
<default-user>subodhv</default-user>
<default-password>{xor}MzIsZg==</default-password>
<disable-auto-connectioncleanup>false</disable-auto-connectioncleanup>
<description>Sample Data Source</description>
<jndi-name>jdbc/SampleDataSource</jndi-name>
<config-properties>
<property name="serverName" value=""/>
<property name="portNumber" value=""/>
<property name="URL" value=""/>
</config-properties>
</data-source>
...
<install-info>
<node-name>subodh</node-name>
<jdbc-zipfile-location>
K:/PROGRA~1/SQLLIB/java/db2java.zip
</jdbc-zipfile-location>
</install-info>
</jdbc-driver>

The following section contains the node, or physical machine, in the administrative domain. Its host name is subodh:

<node action="update" name="subodh">

Next is an application server. In this case, it is the default application server, Default Server:

Skip ahead
    <application-server action="update" name="Default Server">
<executable>java</executable>
<command-line-arguments/>
<environment/>
<user-id/>
<group-id/>
<working-directory/>
<umask>18</umask>
<stdin/>
<stdout>D:\WebSphere\AppServer/logs/Default_Server_stdout.log</stdout>
<stderr>D:\WebSphere\AppServer/logs/Default_Server_stderr.log</stderr>
<process-priority>20</process-priority>
<maximum-startup-attempts>2</maximum-startup-attempts>
<ping-interval>60</ping-interval>
<ping-timeout>200</ping-timeout>
<ping-initial-timeout>300</ping-initial-timeout>
<selection-policy>roundrobinpreferlocal</selection-policy>
<trace-specification/>
<trace-output/>
<transaction-log-file/>
<olt-enabled>false</olt-enabled>
<system-properties/>
<debug-enabled>false</debug-enabled>
<transaction-timeout>120</transaction-timeout>
<transaction-inactivity-timeout>60000</transaction-inactivity-timeout>
<thread-pool-size>20</thread-pool-size>
<security-enabled>false</security-enabled>
<admin-agent-ior/>
<cache-config>
<cache-size>2047</cache-size>
<cache-sweep-interval>1000</cache-sweep-interval>
<passivation-directory/>
</cache-config>
<log-file-spec/>
<performance-monitor-spec>
pmi=none:beanModule=maximum:connectionPoolModule=medium:
j2cModule=medium:jvmRuntimeModule=none:jvmpiModule=low:
servletSessionsModule=none:threadPoolModule=high:
transactionModule=none:webAppModule=maximum
</performance-monitor-spec>
<olt-server-host>localhost</olt-server-host>
<olt-server-port>2102</olt-server-port>
<selection-policy>roundrobinpreferlocal</selection-policy>
<source-path/>
<wlm-template-ior/>
<thread-pool-size>20</thread-pool-size>
<jvm-config>
<initial-heap-size>64</initial-heap-size>
<max-heap-size>64</max-heap-size>
<generated-command-line-arguments>
-Xms64m -Xmx64m
</generated-command-line-arguments>
<system-properties/>
<additional-command-line-arguments/>
<debug-mode>false</debug-mode>
<debug-string/>
<run-hprof>false</run-hprof>
<hprof-args/>
<disable-jit>false</disable-jit>
<verbose-class-loading>false</verbose-class-loading>
<verbose-jni>false</verbose-jni>
<verbose-gc>false</verbose-gc>
<boot-classpath-replace/>
<boot-classpath-append/>
<boot-classpath-prepend/>
</jvm-config>

Within the application-server configuration are the attributes of the Web container, as follows:

Skip ahead
        <web-container>
<dynamic-cache-config>
<enabled>false</enabled>
<cache-size>0</cache-size>
<default-priority>0</default-priority>
</dynamic-cache-config>
<transport name="http">
<transport-host>*</transport-host>
<transport-port>9080</transport-port>
<http-transport>
<connection-timeout>5</connection-timeout>
<backlog-connections>50</backlog-connections>
<keep-alive-timeout>5</keep-alive-timeout>
<maximum-keep-alive>25</maximum-keep-alive>
<maximum-req-keep-alive>100</maximum-req-keep-alive>
<ssl-enabled>false</ssl-enabled>
</http-transport>
</transport>
<thread-maximum-size>50</thread-maximum-size>
<thread-minimum-size>25</thread-minimum-size>
<thread-inactivity-timeout>10</thread-inactivity-timeout>
<thread-is-growable>true</thread-is-growable>

A session manager configuration follows. The tag for the Web container is still open.

Skip ahead
            <session-manager>
<enable-security-integration>false</enable-security-integration>
<enable-ssl-tracking>false</enable-ssl-tracking>
<invalidation-schedule-first-hour>0</invalidation-schedule-first-hour>
<invalidation-schedule-second-hour>0
</invalidation-schedule-second-hour>
<persistent-db2-row-size>0</persistent-db2-row-size>
<maximum-inmemory-session-count>1000</maximum-inmemory-session-count>
<write-contents>0</write-contents>
<write-frequency>0</write-frequency>
<write-interval>0</write-interval>
<enable-sessions>false</enable-sessions>
<enable-url-rewriting>false</enable-url-rewriting>
<enable-cookies>true</enable-cookies>
<enable-protocol-switch-rewriting>false
</enable-protocol-switch-rewriting>
<cookie name="JSESSIONID">
<domain/>
<maximum>-1</maximum>
<path>/</path>
<secure>false</secure>
</cookie>
<tuning-invalidation-time>30</tuning-invalidation-time>
<persistent-sessions>false</persistent-sessions>
<data-source name="">
<default-user/>
<default-password/>
</data-source>
<using-multi-row>false</using-multi-row>
<allow-overflow>true</allow-overflow>
</session-manager>

Configuration for the Web container ends:

        </web-container>

Next is an ORB configuration:

Skip ahead
        <orb-config>
<bootstrap-host-name/>
<bootstrap-port>900</bootstrap-port>
<comm-trace-enabled>false</comm-trace-enabled>
<connection-cache-maximum>240</connection-cache-maximum>
<connection-cache-minimum>100</connection-cache-minimum>
<external-config-url/>
<force-tunnel>whenrequired</force-tunnel>
<listener-port>0</listener-port>
<locate-request-timeout>180</locate-request-timeout>
<local-host-name/>
<lsd-host-name/>
<no-local-copies>false</no-local-copies>
<request-retries-count>1</request-retries-count>
<request-retries-delay>0</request-retries-delay>
<request-timeout>180</request-timeout>
<thread-pool-size>20</thread-pool-size>
<tunnel-agent-url/>
<rmi-remote-code-base/>
<ssl-listener-port>0</ssl-listener-port>
</orb-config>

The WebSphere plug-in configuration comes next:

Skip ahead
        <custom-service-config-list>
<custom-service-config
name="Automatic Generation of Plugin Configuration">
<description>If enabled, the plugin configuration
files will be regenerated when the application
server is started</description>
<classname>
com.ibm.websphere.plugincfg.initializers.AEPluginCfgService
</classname>
<classpath/>
<external-config-url/>
<enabled>false</enabled>
</custom-service-config>
</custom-service-config-list>

Configuration for the application server ends:

    </application-server>

Then the end tag for the node is placed, indicating that all the elements pertaining to the node have been addressed:

</node>

The security configuration comes next:

Skip ahead
<security-config security-cache-timeout="600" security-enabled="false">
<app-security-defaults>
<realm-name>Default</realm-name>
<challenge-type ssl-enabled="false">
<basic-challenge/>
</challenge-type>
</app-security-defaults>
<auth-mechanism>
<localos>
<user-id/>
<password>{xor}</password>
</localos>
</auth-mechanism>
</security-config>

Then comes the server group configuration:

Skip ahead
<server-group action="update" name="Test Server group">
<server-group-attributes>
<environment/>
<user-id/>
<group-id/>
<working-directory/>
<umask>18</umask>
<stdin/>
<stdout>stdout.txt</stdout>
<stderr>stderr.txt</stderr>
<process-priority>20</process-priority>
<maximum-startup-attempts>2</maximum-startup-attempts>
<ping-interval>60</ping-interval>
<ping-timeout>200</ping-timeout>
<ping-initial-timeout>300</ping-initial-timeout>
<selection-policy>roundrobinpreferlocal</selection-policy>
<debug-enabled>false</debug-enabled>
<transaction-timeout>120</transaction-timeout>
<transaction-inactivity-timeout>60000</transaction-inactivity-timeout>
<selection-policy>roundrobinpreferlocal</selection-policy>
<source-path/>
<jvm-config>
<initial-heap-size>64</initial-heap-size>
<max-heap-size>64</max-heap-size>
<generated-command-line-arguments>
-Xms64m -Xmx256m
</generated-command-line-arguments>
<system-properties/>
<additional-command-line-arguments/>
<debug-mode>false</debug-mode>
<debug-string/>
<run-hprof>false</run-hprof>
<hprof-args/>
<disable-jit>false</disable-jit>
<verbose-class-loading>false</verbose-class-loading>
<verbose-jni>false</verbose-jni>
<verbose-gc>false</verbose-gc>
<boot-classpath-replace/>
<boot-classpath-append/>
<boot-classpath-prepend/>
</jvm-config>
<custom-service-config-list/>
</server-group-attributes>
<clone name="TestCLone">
<parent-node>subodh</parent-node>
</clone>
</server-group>

Several enterprise application entries come next; only one is shown here, with one EJB module and one Web module:

Skip ahead
<enterprise-application action="create" name="subodh/sampleApp">
<source-node>subodh</source-node>
<ear-file-name>
D:\WebSphere\AppServer\installableApps\sampleApp.ear
</ear-file-name>
<enterprise-app-install-info>
<node-name>subodh</node-name>
<ear-install-directory>
D:\WebSphere\AppServer/installedApps/sampleApp.ear
</ear-install-directory>
</enterprise-app-install-info>
<application-binding>
<authorization-table>
<role name="All Role">
<description>
All Authenticated users in the enterprise.
</description>
<all-authenticated-users name="AllAuthenticatedUsers"/>
</role>
<role name="Everyone Role">
<description>Everyone in the enterprise.</description>
<everyone name="Everyone"/>
</role>
</authorization-table>
<run-as-map/>
</application-binding>
<ejb-module name="Increment">
<jar-file>Increment.jar</jar-file>
<module-install-info>
<application-server-full-name>
/NodeHome:subodh/EJBServerHome:Default Server/
</application-server-full-name>
</module-install-info>
<ejb-module-binding>
<data-source>
<jndi-name>jdbc/SampleDataSource</jndi-name>
<default-user/>
<default-password/>
</data-source>
<enterprise-bean-binding name="EnterpriseBeanBinding_1">
<jndi-name>IncBean</jndi-name>
</enterprise-bean-binding>
</ejb-module-binding>
</ejb-module>
...
<web-module name="default_app">
<war-file>default_app.war</war-file>
<context-root>/</context-root>
<module-install-info>
<application-server-full-name>
/NodeHome:subodh/EJBServerHome:Default Server/
</application-server-full-name>
</module-install-info>
<web-module-binding>
<virtual-host-name>default_host</virtual-host-name>
</web-module-binding>
</web-module>
...
</enterprise-application>

The last item is the end tag for the export itself:

</websphere-sa-config>
Go to previous article: XMLConfig - Command syntax Go to next article: XMLConfig - Example of a partial export

 

 
Go to previous article: XMLConfig - Command syntax Go to next article: XMLConfig - Example of a partial export