Working with host alias properties

You can use virtual host properties files to create or change host alias properties.

Before you begin

Determine the changes that you want to make to your host alias configuration.

Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the wsadmin -lang jython command from the bin directory of the server profile.

About this task

Using a virtual host properties file, you can create, modify, or delete a host alias. Run administrative commands using wsadmin to configure or delete a host alias.

Table 1. Actions for host alias properties. You can create, modify, and delete host alias properties.
Action Procedure
create Set properties and then run the applyConfigProperties command.
modify Edit the properties and then run the applyConfigProperties command.
delete Specify the host aliases to delete in the Properties section and then run the deleteConfigProperties command.

Optionally, you can use interactive mode with the commands:

AdminTask.command_name('-interactive')

Procedure

  • Create a host alias.
    1. Edit a VirtualHost properties file so that it specifies a host alias property.

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

      The following example defines a host alias inside a virtual host named default_host at the cell scope with host name newHost and port 5555:

      #
      # Header
      #
      ResourceType=VirtualHost
      ImplementingResourceType=VirtualHost
      ResourceId=Cell=!{cellName}:VirtualHost=default_host
      AttributeInfo=aliases(port,hostname)
      #
      
      #	
      #Properties
      #
      5555=newHost
      
      EnvironmentVariablesSection
      #
      #
      #Environment Variables
      cellName=WASCell06
    2. Run the applyConfigProperties command to create a host alias.

      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 host alias.
    1. Obtain a virtual host properties file that defines the host alias that you want to change.

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

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

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

    3. Run the applyConfigProperties command to change a host alias.
  • Delete an existing host alias.

    If you no longer need one or more host aliases, list the host aliases that you want removed in the Properties section of the virtual host properties file and then run the deleteConfigProperties command:

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

Results

You can use the properties file to configure and manage the host alias.

What to do next

Save the changes to your configuration.