Manage environment configurations with properties files using wsadmin.sh

Use this topic to modify the environment using properties files. Use the wsadmin tool to generate, validate and apply properties files in the application server, profile, node, or other resource configurations.

Use the PropertiesBasedConfiguration command group for the AdminTask object, we can extract the configuration attributes and values from the environment to properties files. Use this functionality for various purposes, including:

• To modify our existing configuration in one location, instead of configuring multiple administrative console panels or running many commands

• To improve the application development life cycle

Use this topic to manage the following resources in the environment:

• Application servers
• Nodes
• Profiles
• Virtual hosts
• Authorization tables
• Data replication domains
• Variable maps
• JDBC providers
• URL providers
• Mail providers
• Resource environment providers
• Java 2 Connector (J2C) resource adapters

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

Extract a properties file for an application server, edit the properties, and apply them to the configuration. We can also use interactive mode with these commands...

AdminTask.commandName('-interactive')

Tasks

Modify an application server configuration, and apply the changes using a properties file.

1. Launch the wsadmin tool.

2. Extract the application server configuration to modify.

   Use the extractConfigProperties command to extract the object configuration...

   AdminTask.extractConfigProperties('-propertiesFileName ConfigProperties_server1.props -configData Server=server1')

   The system extracts the properties file, which contains each of the configuration objects and attributes for the server1 application server.

3. Open the properties file, and manually edit the attribute values of interest.

   Because we are manually editing the properties file, make a back-up copy of the properties file before you edit it..

   The following sample is a section of an application server properties file:

   #
   # Configuration properties file for cells/myCell/nodes/myNode/servers/server1|server.xml#
   # Extracted on Thu Sep 06 00:27:26 CDT 2007
   #
   #
   # Section 1.0 ## cells/myCell/nodes/myNode/servers/server1|server.xml#server1
   #
   #
   # SubSection 1.0 # Server Section
   #
   ResourceType=Server
   ImplementingResourceType=Server
   ResourceId=cells/myCell/nodes/myNode/servers/server1|server.xml#server1
   #
   #
   #Properties
   #
   shortName=null
   serverType=APPLICATION_SERVER
   developmentMode=false #boolean
   name=server1
   parallelStartEnabled=true #boolean
   clusterName=C
   modelId=null
   uniqueId=null
   #
   

   To modify the application server to run in development mode and disable parallel start, modify the developmentMode and parallelStartEnabled properties...

   #
   # Configuration properties file for cells/myCell/nodes/myNode/servers/server1|server.xml#
   # Extracted on Thu Sep 06 00:27:26 CDT 2007
   #
   #
   # Section 1.0 ## cells/myCell/nodes/myNode/servers/server1|server.xml#server1
   #
   #
   # SubSection 1.0 # Server Section
   #
   ResourceType=Server
   ImplementingResourceType=Server
   ResourceId=cells/myCell/nodes/myNode/servers/server1|server.xml#server1
   #
   #
   #Properties
   #
   shortName=null
   serverType=APPLICATION_SERVER
   developmentMode=true #boolean
   name=server1
   parallelStartEnabled=false #boolean
   clusterName=C
   modelId=null
   uniqueId=null
   #
   

4. Validate the properties file.

   As a best practice, use the validateConfigProperties command to validate the modified properties file before applying the changes...

   AdminTask.validateConfigProperties('-propertiesFileName ConfigProperties_server1.props -reportFileName report.txt')

   The command returns a value of true if the system successfully validates the properties file. The command returns a value of false if the system does not validate the file.

5. Apply the changes to the application server.

   Use the applyConfigProperties command to apply the changes to the application server.

   AdminTask.applyConfigProperties('-propertiesFileName ConfigProperties_server1.props -validate true')

6. Save the configuration changes.
   AdminConfig.save()

Subtopics

• Create, modify, and delete configuration objects using one properties file
  We can specify to create, modify, and delete objects in one properties file. You run the applyConfigProperties command to apply the configuration changes.

• Create and delete configuration objects using properties files and wsadmin scripting
  Use this topic to use an extracted properties file to create or delete configuration objects that are not server, cluster, application, or authorization group object types.

• Create server, cluster, application, or authorization group objects using properties files and wsadmin scripting
  Use this topic to create new server, cluster, application, or authorization group objects for our configuration.

• Delete server, cluster, application, or authorization group objects using properties files
  Use this topic to delete server, cluster, application, or authorizationgroup objects from the configuration.

Extracting properties files

Applying properties files

Validate properties files

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

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

Create and delete configuration objects using properties files and wsadmin scripting

Extracting properties files to troubleshoot the environment

Manage servers, nodes and cells with scripting

PropertiesBasedConfiguration .