setBPMVirtualHost command

Use the setBPMVirtualHost command to create or update an IBM BPM virtual host. For both stand-alone and network deployment (ND) environments, it is not necessary to restart the server or cluster after running the setBPMVirtualHost command if you also run the clearBPMEndpointServiceCache command. In ND environments, you must wait until node synchronization has completed before you run the clearBPMEndpointServiceCache command.

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

Prerequisites

The following conditions must be met:

The command must be run on the deployment manager node.
If the deployment manager is stopped, use the wsadmin -conntype none option to run the command in disconnected mode.
If the deployment manager 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 deployment_manager_profile/bin directory. The setBPMVirtualHost 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

setBPMVirtualHost
-de deployment_environment_name
-name virtual_host_name
-transportProtocol virtual_host_transport_protocol
-hostname virtual_host_hostname
-port virtual_host_port
-uriPrefix virtual_host_URI_prefix

Parameters

-de deployment_environment_name: A required parameter that specifies the name of the current deployment environment.
-name virtual_host_name: A required parameter that specifies the name of a new IBM BPM virtual host that you want to create or the name of an existing IBM BPM virtual host that you want to update.
-transportProtocol virtual_host_transport_protocol: An optional parameter that specifies the transport protocol for the IBM BPM virtual host.
-hostname virtual_host_hostname: An optional parameter that specifies the host name for the IBM BPM virtual host. If you are creating a new IBM BPM virtual host, the -hostname parameter must be specified.
-port virtual_host_port: An optional parameter that specifies the port number for the IBM BPM virtual host. This parameter must be specified if the IBM BPM virtual host is used as the default virtual host. If the virtual host is not used as the default virtual host, then this parameter should only be used to specify a port that is not the default port for the specified protocol. For example, if the specified protocol is HTTPS, then this parameter should only be used to specify a port that is not the default port 443. If you want to reset the port to its default value for the specified protocol, specify the special value -1. You must use the wsadmin string parameter syntax instead of the preferred Jython list parameter syntax, which allows you to specify the -1 option value.
-uriPrefix virtual_host_URI_prefix: An optional parameter that specifies the URI prefix for the IBM BPM virtual host.

Note: At least one of the optional parameters should be specified, but it is not enforced.

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 setBPMVirtualHost command to create or update an IBM BPM virtual host:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMVirtualHost(['-de', 'De1', '-name', 'myVirtualHost', '-transportProtocol', 'https', '-hostname', 'myHostName', '-port', '9443', '-uriPrefix', 'virtualHosts'])
wsadmin>AdminConfig.save()

The following Jython example uses the setBPMVirtualHost command to reset the port to its default value:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMVirtualHost("[-de De1 -name myVirtualHost -hostname myHostName -port '-1']")
wsadmin>AdminConfig.save()