getBPMEndpoint command

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Use the getBPMEndpoint command to display the attributes of an Business Automation Workflow endpoint.

The getBPMEndpoint 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 monitor privileges. Do not use the wsadmin -conntype none option.

Location

Start the wsadmin scripting client from the deployment_manager_profile/bin directory. The getBPMEndpoint 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

getBPMEndpoint
[-de deployment_environment_name]
-scenario scenario_name

Parameters

-de deployment_environment_name
An optional 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.
-scenario scenario_name
A required parameter that specifies the scenario of the endpoint.
Tip: For a list of valid scenario values, see "Table 1" and "Table 3" in the topic Configuring endpoints to match your topology.

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 getBPMEndpoint command to display the attributes of an endpoint:
wsadmin -user admin -password admin -lang jython
wsadmin>vh = AdminTask.getBPMEndpoint(['-de', 'De1', '-scenario', 'myScenario'])
wsadmin>print AdminConfig.show( vh )