Work with virtual host properties files

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

Determine the changes to make to the virtual host configuration or its configuration objects.

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

Using a properties file create, modify, or delete a virtual host object. We can also work with host aliases and mime entries of a virtual host.

Run administrative commands using wsadmin to create or change a properties file for a virtual host, validate the properties, and apply them to the configuration.

properties files. We can create, modify, and delete

Action	Procedure
create	Set required properties and then run the applyConfigProperties command.
modify	Edit required properties and then run the applyConfigProperties command.
delete	To delete an entire virtual host object, uncomment #DELETE=true and run the deleteConfigProperties command.
create Property	To add a host alias, add an entry such as the example 9999=* alias to the Host Alias section and then run the applyConfigProperties command. To add a mime type, add an entry such as the example newMime={a,b,c} to the Mime Types section and then run the applyConfigProperties command.
delete Property	To delete an existing host alias, list only that alias in the Properties section of the properties file and then run the deleteConfigProperties command. For example, to delete the example 9999=* alias, keep only that 9999=* alias and remove other properties from the Host Alias section and then run deleteConfigProperties.

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

• Create a virtual host and its properties.

  1. Create a properties file for a VirtualHost object.

     Open an editor and create a virtual host properties file. We can copy an example properties file in this step into an editor and modify the properties as needed for the situation.

     The following example defines a virtual host named myHost at the cell scope:

     #
     # Header
     #
     ResourceType=VirtualHost
     ImplementingResourceType=VirtualHost
     ResourceId=Cell=!{cellName}:VirtualHost=myHost
     #DELETE=true
     #
      #
     #Properties
     #
     name=myHost
      EnvironmentVariablesSection
     #
     #
     #Environment Variables
     cellName=WASCell06

     The following example defines a virtual host named myVh, mime types, and host aliases:

     #
     # Header  #
     ResourceType=VirtualHost
     ImplementingResourceType=VirtualHost
     ResourceId=Cell=!{cellName}:VirtualHost=myVh
     #DELETE=true
     #
      #
     #Properties
     #
     name=myVh # required
      
     #
     # Header MimeTypes section
     #
     ResourceType=VirtualHost
     ImplementingResourceType=VirtualHost
     ResourceId=Cell=!{cellName}:VirtualHost=myVh
     AttributeInfo=mimeTypes(type,extensions)
     #
      #
     #Properties
     #
     video/x-sgi-movie={movie}
     application/x-csh={csh}
     text/richtext={rtx}
     image/tiff={tif,tiff}
     application/x-bsh={bsh}
     application/x-tcl={tcl}
     application/drafting={DRW}
     application/pdf={pdf}
     application/SLA={STL,stl}
     audio/x-wav={wav}
     video/mpeg={MPE,MPEG,MPG,mpe,mpeg,mpg}
     newMime={a,b,c}
     ...
      #
     ResourceType=VirtualHost
     ImplementingResourceType=VirtualHost
     ResourceId=Cell=!{cellName}:VirtualHost=myVh
     AttributeInfo=aliases(port,hostname)
     #
      #
     #Properties
     #
     80=*
     9080=*
     9453=*
     9096=*
     9092=*
     443=*
     9999=*
      
     EnvironmentVariablesSection
      #Environment Variables
     cellName=myCell

  2. Run the applyConfigProperties command to create a virtual host 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'])

• Modify an existing properties file.

  1. Obtain a properties file for the virtual host to change.

     We can extract a properties file for a VirtualHost object using the extractConfigProperties command.

  2. Open the properties file in an editor and change the properties as needed.

     Ensure that the environment variables in the properties file match the system.

  3. Run the applyConfigProperties command to change a virtual host configuration.

• If we no longer need the virtual host or an existing property, we can delete the entire virtual host object or property.

  • To delete the entire object, specify DELETE=true in the header section of the properties file and run the deleteConfigProperties command; for example:
    AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]')

  • To delete an alias or mime entry, specify only the alias or mime entry to be deleted in the host alias Properties section of the properties file and then run the deleteConfigProperties command.

Results

We can use the properties file to configure and manage the virtual host object.

What to do next

Save the changes to the configuration.

Subtopics

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

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

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)