IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced for z/OS: Process Server > Configure IBM BPM Advanced for z/OS: Process Server > Configure components > Configure additional components > Configure Process Portal > Configure the Business Space component for Process Portal > Commands (wsadmin scripting) for configuring the Business Space component for Process Portal
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.
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.
If you are using jython, you can add the print statement before the command if you want to see formatted output.
- Jython example:
AdminTask.listBPMApiFederationDomains('[-nodeName myNode -serverName myServer]') - Jacl example:
$AdminTask listBPMApiFederationDomains {-nodeName myNode -serverName myServer}
Commands (wsadmin scripting) for configuring the Business Space component for Process Portal
Related tasks:
Enabling the Federation API across multiple deployment targets
Related information:
Obtaining online help using wsadmin scriptingAdministrative command invocation syntax using wsadmin scriptingUse the wsadmin scripting toolJython script library