updateEndpointBindingsOnPortal command

Use the updateEndpointBindingsOnPortal command to create endpoint references on the WebSphere® Portal application server so that your team can use the widgets in Business Space on WebSphere Portal.

This command creates references to the Representational State Transfer (REST) endpoints on the WebSphere Portal application server. Business Space and product-specific endpoint reference entries must be created so that Business Space works properly in the WebSphere Portal environment. Business Space widgets are registered as iWidgets with WebSphere Portal by a bulk import using the WebSphere Portal-specific widget catalog file with your product. The catalog XML file is available at the root of the product web archive (WAR) file. Each product has a different context root. This command works only for the resource environment provider named WP Mashup Endpoints.

Before you run this command, you must install WebSphere Portal V7.0.0.1 or later, configure Business Space and REST services for your product, and configure SSL and SSO. For more information, see Configuring Business Space on WebSphere Portal.

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
```

Required parameters

-serverName WebSphere_Portal_server_name: A parameter that specifies the name of the target server for the WebSphere Portal configuration. For configuring Business Space on a server, you must specify both a serverName and a nodeName.

-nodeName WebSphere_Portal_node_name: A parameter that specifies the name of the target node for the WebSphere Portal configuration. For configuring Business Space on a server, you must specify both a serverName and a nodeName.

-clusterName WebSphere_Portal_cluster_name: A parameter that specifies the name of the target cluster for the WebSphere Portal configuration. For configuring Business Space on a cluster, you must specify only a clusterName. Do not specify a serverName or a nodeName.

-host server_IP_or_host: A parameter that specifies the IP or host name for the remote WebSphere Portal server. In a clustered environment, this parameter specifies the IP or host name of the Deployment Manager.

-port SOAP_port: A parameter that specifies the SOAP port name for the remote WebSphere Portal server; the default is 10025. In a clustered environment, this parameter specifies the SOAP port name of the Deployment Manager; the default is 8879.

-user admin_ID: A parameter that specifies the administrator ID for the remote WebSphere Portal server. In a clustered environment, this parameter specifies an ID with administrative rights on the Deployment Manager.

-password admin_password: A parameter that specifies the administrator password for the remote WebSphere Portal server or the Deployment Manager.

-endpointBindingDirectoryName directory_containing_endpoints_files: A parameter that specifies the directory that contains the endpoints files. Make sure that no other files exist in this directory.

Examples

The following example creates endpoint references on the WebSphere Portal application server for a stand-alone environment.

Jython example:
AdminTask.updateEndpointBindingsOnPortal('[-nodeName Portal_node_name -serverName WebSphere_Portal -endpointBindingDirectoryName directory_containing_endpoints_files -host Portal_server_IP_or_host -port Portal SOAP_port_default_10025 -user Portal_admin_ID -password Portal_admin_password]')
Jacl example:
$AdminTask updateEndpointBindingsOnPortal {-nodeName Portal_node_name -serverName WebSphere_Portal -endpointBindingDirectoryName directory_containing_endpoints_files -host Portal_server_IP_or_host -port Portal SOAP_port_default_10025 -user Portal_admin_ID -password Portal_admin_password}

The following example creates endpoint references on the WebSphere Portal application server for a clustered environment.

Jython example:
AdminTask.updateEndpointBindingsOnPortal('[-nodeName Portal_node_name -serverName WebSphere_Portal -endpointBindingDirectoryName directory_containing_endpoints_files -host DMGR_IP_or_host -port DMGR_SOAP_port_default_8879 -user DMGR_admin_ID -password DMGR_admin_password]')
Jacl example:
$AdminTask updateEndpointBindingsOnPortal {-clusterName Portal_cluster_name -endpointBindingDirectoryName directory_containing_endpoints_files_on_local_system -host DMGR_IP_or_host -port DMGR_SOAP_port_default_8879 -user DMGR_admin_ID -password DMGR_admin_password}