Manage specific configuration objects using properties files

Use wsadmin.sh to change configuration properties and manage configuration objects of the environment using properties files.

Determine the changes to make to the server configuration or its configuration objects.

Read Properties file syntax so that changes made to properties files use the supported syntax.

Using a properties file, we can create, modify, or delete a configuration object.

Extracted properties files identify all required properties and default values for an object of a given type. Required properties have the comment # required following a property setting. Properties that have default values have the comment #object_type,default(default_value) following a property setting. When a property that has a default value is deleted, the value of that property is set automatically to the default value. If a property does not have default value, it is not shown. Because extracted properties files contain information about all required and default properties, we can verify that property values are set properly before applying the properties file to create, modify, or delete an object.

For example, an extracted properties file of type JDBCProvider identifies all required and default properties:

#
# SubSection 1.0 # JDBCProvider attributes #
ResourceType=JDBCProvider
ImplementingResourceType=JDBCProvider
ResourceId=Cell=!{cellName}:ServerCluster=!{clusterName}:JDBCProvider=Derby JDBC Provider (XA)
#
 #
# Properties #
classpath={${DERBY_JDBC_DRIVER_PATH}/derby.jar}
name=Derby JDBC Provider (XA) # required
implementationClassName=org.apache.derby.jdbc.EmbeddedXADataSource # required
isolatedClassLoader=false #boolean,default(false)
nativepath={}
description=Built-in Derby JDBC Provider (XA)
providerType=Derby JDBC Provider (XA) #readonly
xa=true #boolean,default(false)

1. Start the wsadmin scripting tool.

   To start wsadmin using the Jython language, run the following command from the bin directory of the server profile:

   wsadmin -lang jython

2. Create, edit, and apply the properties file of the configuration object.

   Instructions for creating and updating properties files of various configuration objects follow:

   • Activity session service

   • Application

     • Application deployment

       • Web module deployment

       • EJB module deployment

       • Application configuration

         • Session manager

         • Web module configuration

           • Session manager

         • EJB module configuration

           • Session manager

     • Servlet cache

     • Eviction policy

     • Data replication service (DRS)

   • Cache provider

     • Object cache

       • Object cache J2EE resource

     • Servlet cache

     • Eviction policy

     • Data replication service (DRS)

   • Data replication domain

     • Data replication

   • J2C resource adapter

   • Java 2 Platform, Enterprise Edition (J2EE) resource property

   • J2EE resource property set

   • JVM

   • JDBC provider

     • Data source

       • Connection pool

       • Data source J2EE resource property set

     • CMP connection factory

       • Mapping module

   • JMS provider

     • MQ topic

     • MQ topic connection factory

     • MQ queue

     • MQ queue connection factory

     • Mapping module

   • Mail provider

     • Mail session

   • Object pool

     • Object pool provider

       • Object pool provider J2EE resource

     • Object pool manager

       • Object pool manager J2EE resource

   • Scheduler provider

     • Scheduler configuration

       • Scheduler configuration J2EE resource

   • Security

     • LDAP

     • LTPA

     • JAAS configuration entry

     • JAAS authorization data

     • SSL configuration

       • Secure socket layer

     • Retrieve SSL signer certificate

     • Enable global security and configure a federated user registry

     • Map users and resources using authorization group properties files

   • Server

     • Application server

       • Class loader

       • Library reference

     • Custom service

     • Dynamic cache

     • End point

     • EJB container

     • HTTP transport

     • Listener port

     • Object Request Broker

     • Performance Monitoring Infrastructure (PMI) service

     • Process definition

     • SOAP connector

     • Stream redirect

     • Thread pool

     • Trace service

     • Transaction service

     • Web container

       • Session manager

   • SIBus

     • SIBus member

     • SIB destination

     • SIB engine

   • Timer manager provider

     • Timer manager information

       • Timer manager information J2EE resource

   • Transport channel service

     • HTTP inbound channel

     • SSL inbound channel

     • TCP inbound channel

     • Web container inbound channel

   • URL provider

     • URL

   • Variable map

   • Virtual host

     • Host alias

     • Mime entry

   • Web server

     • Plug-in

     • Plug-in server cluster

     • Key store file

     • Administrative server authentication

     • Web server process definition

     • Web server JVM

     • Web server JVM system

   • Work area service

     • Work area partition service

   • Work manager provider

     • Work manager information

       • Work manager information J2EE resource

   • Web services endpoint URL fragment

   The instructions contain examples to create, delete and modify WebSphere configuration objects using the properties file based configuration tool. Instructions are provided for many configuration objects but not all the supported configuration objects.

   We can use interactive mode with a command to extract, edit, or apply a properties file. Run the command with the interactive option:

   AdminTask.command_name('-interactive')

   (dist)(zos) Avoid trouble: We cannot apply a z/OS operating system properties file directly to a distributed operating system. Similarly, we cannot apply a distributed operating system properties file directly to a z/OS operating system. See the topic on applying portable properties files across multiple environments.gotcha

What to do next

Save the changes to the configuration.

Subtopics

• Work with activity session service properties files
  We can use properties files to change activity session service configuration objects and custom properties.

• Use application properties files to install, update, and delete enterprise application files
  We can use application properties files to install enterprise application files on a server or cluster, update deployed applications or modules, or uninstall deployed applications or modules. An enterprise application file must conform to Java EE specifications.

• Work with cache provider properties files
  We can use properties files to create, modify, or delete cache provider properties and custom properties.

• Work with data replication domain properties files
  We can use properties files to create, modify, or delete data replication domain properties and custom properties.

• Work with J2C resource adapter properties files
  We can use properties files to install or remove J2EE Connector Architecture (J2C) resource adapters.

• Work with J2EEResourceProperty properties files
  We can use properties files to create or change J2EEResourceProperty properties.

• Work with J2EEResourcePropertySet properties files
  We can use properties files to create or change J2EEResourcePropertySet properties.

• Work with JDBC provider properties files
  We can use properties files to create, modify, or delete JDBC provider properties.

• Work with JVM properties files
  We can use properties files to modify or delete JVM properties.

• Work with JMS provider properties files
  We can use properties files to create or change Java Message Service (JMS) provider properties.

• Work with mail provider properties files
  We can use properties files to create or change mail provider properties.

• Work with object pool properties files
  We can use properties files to create, modify, or delete object pool properties and custom properties.

• Work with scheduler provider properties files
  We can use properties files to create, modify, or delete scheduler provider properties and custom properties.

• Work with security properties files
  We can use properties files to modify or delete security properties.

• Work with server properties files
  We can use properties files to change server properties.

• Transport channel service
  We can use properties files to create, modify, or delete inbound channel properties and custom properties.

• Work with URL provider properties files
  We can use properties files to create or change uniform resource locator (URL) provider properties.

• Work with service integration properties files
  We can use properties files to create, modify, or delete service integration bus objects. Service integration bus is the default Java Message Service (JMS) messaging provider for the product.

• Work with timer manager provider properties files
  We can use properties files to create, modify, or delete timer manager provider properties and custom properties.

• Work with variable map properties files
  We can use properties files to create, modify, or delete property-value pairs in variable maps.

• Work with virtual host properties files
  We can use properties files to create or change virtual host properties.

• Work with web server properties files
  We can use properties files to create, modify, or delete web server properties.

• Work with work area service properties files
  We can use properties files to change work area service configuration objects and custom properties.

• Work with work manager provider properties files
  We can use properties files to create, modify, or delete work manager provider properties and custom properties.

• Work with web services endpoint URL fragment property files
  We can use property files to manage or change endpoint URL fragments for web services accessed through HTTP, SOAP and Java Message Service (JMS), or directly as enterprise beans. URL fragments are used to form complete web services endpoint addresses included in published Web Services Description Language (WSDL) files.

Related tasks

Extracting properties files

Validating properties files

Create server, cluster, application, or authorization group objects using properties files and wsadmin scripting

Delete server, cluster, application, or authorization group objects using properties files

Extracting properties files to troubleshoot the environment

Manage servers and nodes

Properties file syntax

PropertiesBasedConfiguration (AdminTask)