Manage environment configurations with properties files

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

Use the PropertiesBasedConfiguration (AdminTask), we can extract the configuration attributes and values from the environment to properties files. We can use this functionality for various purposes, including:

• To modify the existing configuration in one location, instead of configuring multiple console panels or running many commands
• To improve the application development life cycle

We can use this topic to manage the following resources in our environment:

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

Complete the following steps to 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, as the following syntax demonstrates:

AdminTask.commandName('-interactive')

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

1. Launch wsadmin.sh.

2. Extract the application server configuration to modify.

   Use the extractConfigProperties command to extract the object configuration, as the following Jython example demonstrates:

   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.

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

   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.

   Best practice: As a best practice, use the validateConfigProperties command to validate the modified properties file before applying the changes, as the following Jython example demonstrates:bprac

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

   Returns 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
  
• Create and delete configuration objects using properties files and wsadmin scripting
  
• 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
  

Related tasks

Extracting properties files

Apply 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

Create and delete configuration objects using properties files and wsadmin scripting

Extracting properties files to troubleshoot the environment

Manage servers and nodes

PropertiesBasedConfiguration (AdminTask)