listBPMApiFederationDomains command

Use the listBPMApiFederationDomains command to list all federation domains for your environment.

This command lists all federation domains that exist for a server or a cluster. The Federation API allows you to display processes and tasks created in Process Designer and Integration Designer in the same task list. The Federation API is automatically configured with your product as part of the REST Services Gateway application. If you want to change that configuration for your environment with multiple deployment targets, use wsadmin commands to create and manage federation domains.

If the application server is not running, supply the -conntype NONE option when running this command.

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 listBPMApiFederationDomains 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.

Target object

Scope at which the federation domain is to be administered. The target object can be used instead of the nodeName, serverName and clusterName parameters.

Required parameters

-serverName server_name
A parameter that specifies the name of the server on which the federation domain should be administered. If this parameter is specified, the nodeName parameter must be specified. Do not specify this parameter if the clusterName parameter or a target object is specified. If no deployment target is specified, the federation domain is administered on the cell scope.
-nodeName node_name
A parameter that specifies the name of the node on which the federation domain should be administered. If this parameter is specified, the serverName parameter must be specified. Do not specify this parameter if the clusterName parameter or a target object is specified. If no deployment target is specified, the federation domain is administered on the cell scope.
-clusterName cluster_name
A parameter that specifies the name of the cluster on which the federation domain should be administered. Do not specify this parameter if the nodeName and serverName parameters or a target object are specified. If no deployment target is specified, the federation domain is administered on the cell scope.

Examples

The following example uses the listBPMApiFederationDomains command to list all federation domains on a server.
AdminTask.listBPMApiFederationDomains('[-nodeName myNode -serverName
 myServer]')
Tip: To see formatted output, add the print statement before the command.
Tip: To see formatted output, add the print statement before the command.
Parent topic: Commands (wsadmin scripting)