Work with plug-in properties files

We can use properties files to create, modify, or delete web server plug-in properties and custom properties.

Determine the changes to make to the plug-in properties configuration or its configuration objects.

From the server profile bin directory, run wsadmin -lang jython

Using a properties file, we can create, modify, or delete a plug-in object. We can also create, modify, or delete plug-in custom properties.

Run administrative commands using wsadmin to change a properties file for a plug-in, validate the properties, and apply them to the configuration.

Action	Procedure
create	Not applicable
modify	Edit properties and then run the applyConfigProperties command to modify the value of a custom property.
delete	Run the deleteConfigProperties command to delete a property. If the deleted property has a default value, the property is set to the default value.
create Property	Not applicable
delete Property	Not applicable

plug-in custom properties. We can create, modify, and

Action	Procedure
create	Not applicable
modify	Edit properties and then run the applyConfigProperties command to modify the value of an existing custom property.
delete	Not applicable
create Property	Set properties and then run the applyConfigProperties command to create a custom property.
delete Property	Specify the properties to delete in the properties file and then run the deleteConfigProperties command to delete an existing custom property. The properties file must contain only the properties to be deleted.

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

• Create or edit a web server plug-in properties file.

  1. Set PluginProperties object properties as needed.

     Open an editor on a PluginProperties properties file. Modify the Environment Variables section to match the system and set any property value that needs to be changed. An example PluginProperties properties file follows:

     #
     # Header
     #
     ResourceType=PluginProperties
     ImplementingResourceType=WebServer
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:WebServer=:PluginProperties=
     AttributeInfo=pluginProperties
     #
      #
     #Properties
     #
     LogFilename="c:\Program Files\IBM\HTTPServer\Plugins\logs\IHS\http_plugin.log"
     ConfigFilename=plugin-cfg.xml #default(plugin-cfg.xml)
     RemoteKeyRingFilename="c:\Program Files\IBM\HTTPServer\Plugins\config\IHS\plugin-key.kdb"
     LogLevel=ERROR #ENUM(DETAIL|DEBUG|ERROR|WARN|STATS|TRACE),default(ERROR)
     PluginPropagation=AUTOMATIC #ENUM(MANUAL|AUTOMATIC),default(AUTOMATIC)
     AcceptAllContent=false #boolean,default(false)
     PluginInstallRoot="c:\Program Files\IBM\HTTPServer\Plugins"
     IgnoreDNSFailures=false #boolean,default(false)
     ESIInvalidationMonitor=false #boolean,default(false)
     IISDisableNagle=false #boolean,default(false)
     RemoteConfigFilename="c:\Program Files\IBM\HTTPServer\Plugins\config\IHS\plugin-cfg.xml"
     PluginGeneration=AUTOMATIC #ENUM(MANUAL|AUTOMATIC),default(AUTOMATIC)
     ResponseChunkSize=64 #integer,default(64)
     RefreshInterval=60 #integer,default(60)
     VHostMatchingCompat=false #boolean,default(false)
     ASDisableNagle=false #boolean,default(false)
     IISPluginPriority=HIGH #ENUM(MEDIUM|HIGH|LOW),default(HIGH)
     KeyRingFilename=plugin-key.kdb #default(plugin-key.kdb)
     ChunkedResponse=false #boolean,default(false)
     ESIEnable=true #boolean,default(true)
     ESIMaxCacheSize=1024 #integer,default(1024)
     AppServerPortPreference=HOSTHEADER #ENUM(WEBSERVERPORT|HOSTHEADER),default(WEBSERVERPORT)
      #
     EnvironmentVariablesSection
     #
     #
     #Environment Variables
     cellName=myNode04Cell
     nodeName=myNode04
     serverName=IHS

  2. Run the applyConfigProperties command to create or change a plug-in properties configuration.

     Running the applyConfigProperties command applies the properties file to the configuration. In this Jython example, the optional -reportFileName parameter produces a report named report.txt:

     AdminTask.applyConfigProperties(['-propertiesFileName myObjectType.props -reportFileName report.txt'])

• Create or edit web server plug-in custom properties.

  1. Set PluginProperties custom properties as needed.

     Open an editor on a PluginProperties properties. Modify the Environment Variables section to match the system and set any property value that needs to be changed. To specify a custom property, edit the AttributeInfo value and properties values; for example:

     #
     # Header
     #
     ResourceType=PluginProperties
     ImplementingResourceType=WebServer
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:WebServer=:PluginProperties=
     AttributeInfo=properties(name,value)
      #
     #Properties
     #
     existingProp=newValue
     newProp=newValue
      
     #
     EnvironmentVariablesSection
     #
     #
     #Environment Variables
     cellName=myNode04Cell
     nodeName=myNode04
     serverName=IHS

  2. Run the applyConfigProperties command.

• Delete a web server plug-in property.

  • To delete a property, run the deleteConfigProperties command; for example:
    AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]')

  • To delete a custom property, specify only the property to delete in the properties file and then run the deleteConfigProperties command.

Results

We can use the properties file to configure and manage the plug-in object and its properties.

What to do next

Save the changes to the configuration.

Related tasks

Extracting 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

PropertiesBasedConfiguration (AdminTask)