updateEndpointBindingsOnPortal command

Use the updateEndpointBindingsOnPortal command to create endpoint references on the WebSphere® Portal application server so that your team can use the widgets 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.

The updateEndpointBindingsOnPortal command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

The following conditions must be met:
  • 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 widgets to work with WebSphere Portal.
  • Make sure that the remote WebSphere Portal server is started.
  • Run the command on the deployment manager node.
  • Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
  • Run the command from your product deployment manager, but make sure to designate the user name and the password for the WebSphere Portal administrator user ID.
  • You must connect to the remote WebSphere Portal deployment manager with a user ID that has WebSphere Application Server administrator privileges for WebSphere Portal.

Location

Start the wsadmin scripting client from the profile_root/bin directory.

Syntax

updateEndpointBindingsOnPortal 
-serverName WebSphere_Portal_server_name
 -nodeName WebSphere_Portal_node_name
 -clusterName WebSphere_Portal_cluster_name
 -host server_IP_or_host -port SOAP_port
 -user WebSphere_Portal_admin_ID
 -password WebSphere_Portal_admin_password
 -endpointBindingDirectoryName directory_containing_endpoints_files

Parameters

-serverName WebSphere_Portal_server_name
A required parameter that specifies the name of the target server for the WebSphere Portal configuration. For configuring Business Space on a WebSphere Portal application server, you must specify both a serverName and a nodeName.
-nodeName WebSphere_Portal_node_name
A required parameter that specifies the name of the target node for the WebSphere Portal configuration. For configuring Business Space on a WebSphere Portal application server, you must specify both a serverName and a nodeName.
-clusterName WebSphere_Portal_cluster_name
A required parameter that specifies the name of the target cluster for the WebSphere Portal configuration. For configuring Business Space on a WebSphere Portal cluster, you must specify only a clusterName. Do not specify a serverName or a nodeName.
-host server_IP_or_host
A required 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 required 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.
-userWebSphere_Portal_admin_ID
A required 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 WebSphere_Portal_admin_password
A required parameter that specifies the administrator password for the remote WebSphere Portal server or the Deployment Manager.
-endpointBindingDirectoryName directory_containing_endpoints_files
A required 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.
wsadmin -user admin -password admin -lang jython 

wsadmin>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.
wsadmin -user admin -password admin -lang jython 

wsadmin>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' ] )
Parent topic: Commands (wsadmin scripting)