deleteBPMVirtualHost command

Use the deleteBPMVirtualHost command to delete an Business Automation Workflow virtual host. In stand-alone environments, such as IBM® BPM Express and the unit test environment of Integration Designer, the value of the virtual host is set immediately when you run the command. In network deployment (ND) environments, the value of the virtual host is set when the next node synchronization occurs. For both stand-alone and ND environments, it is not necessary to restart the server or cluster after running the command.

The deleteBPMVirtualHost command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

The following conditions must be met:

  • In a network deployment environment, run the command on the deployment manager node. In a single-server environment, run the command on the stand-alone server.
  • If the deployment manager or stand-alone server is stopped, use the wsadmin -conntype none option to run the command in disconnected mode (which is the recommended mode for this command).
  • If the deployment manager or stand-alone server is running, you must connect with a user ID that has WebSphere Application Server configurator privileges. Do not use the wsadmin -conntype none option.

Location

Start the wsadmin scripting client from the profile_root/bin directory. The deleteBPMVirtualHost command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you will find exception stack traces and other information.

Syntax

deleteBPMVirtualHost
[-de deployment_environment_name]
-name virtual_host_name

Parameters

-de deployment_environment_name
A parameter that specifies the name of the current deployment environment. If there is only one deployment environment in the WebSphere cell, you can omit this parameter.
-name virtual_host_name
A required parameter that specifies the name of the Business Automation Workflow virtual host.
Note: If you are deleting a virtual host that was set as the default virtual host, then the default virtual host property will be unset.

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.
The following Jython example uses the deleteBPMVirtualHost command to delete a virtual host:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.deleteBPMVirtualHost(['-de', 'De1', '-name', 'myVirtualHost'])
wsadmin>AdminConfig.save()