modifyBPMApiFederationDomain command

Use the modifyBPMApiFederationDomain command to add or remove targets from a federation domain using the addTarget and deleteTarget steps.

This command adds or removes targets from a federation domain. 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. Use the addTarget step to add one or more deployment targets to a federation domain. Use the deleteTarget step to delete one or more deployment targets from a federation domain. The Federation API federates over all systems on the added deployment targets.

After using the command, save your changes to the master configuration using one of the following commands:

For Jython:
```
AdminConfig.save()
```
For Jacl:
```
$AdminConfig save
```

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.

-name federation_domain_name: The name of the new federation domain that you are modifying. This name must be unique. This parameter is always required.

Required parameters for the addTarget and deleteTarget steps

-targetCellName cell_name: A parameter that specifies the name of the cell that is used as federation target. If this parameter is specified and the nodeName, serverName and clusterName parameters are not specified, the federation API federates across all systems in the cell.

-targetNodeName node_name: A parameter that specifies the name of the node that is used as federation target. If this parameter is specified, the federated API will federate across the systems on this server. If this parameter is specified, then the targetServerName parameter must be specified. Do not specify this parameter if the targetClusterName parameter is specified.

-targetServerName server_name: A parameter that specifies the name of the server that is used as federation target. If this parameter is specified, the federated API will federate across the systems on this server. If this parameter is specified, then the targetNodeName parameter must be specified. Do not specify this parameter if the targetClusterName parameter is specified.

-targetClusterName cluster_name: A parameter that specifies the name of the server that is used as federation target. If this parameter is specified, the federated API federates across the systems on this cluster. Do not specify this parameter if the targetNodeName or targetServerName parameter are specified.

Examples

The following example uses the modifyBPMApiFederationDomain command to delete the deployment target myNode, myServer and add a new deployment target myNewNode, myNewServer.

Jython example:

AdminTask.modifyBPMApiFederationDomain('[-nodeName node_name
-serverName server_name -name myCustomFederationDomain
-deleteTarget [["" myNode myServer ""]]')
-addTarget [["" myNewNode myNewServer ""]]]')

Jacl example:

$AdminTask modifyBPMApiFederationDomain {-nodeName node_name
 -serverName server_name -name myCustomFederationDomain
 -deleteTarget {{"" myNode myServer ""}}
 -addTarget {{"" myNewNode myNewServer ""}}}