uninstallBusinessSpaceWidgets command

Use the uninstallBusinessSpaceWidgets command to remove widgets and widget definitions from the profile, including removing individual widget assets (application, catalog, endpoints, spaces, templates, help).

The uninstallBusinessSpaceWidgets command removes widget files in a designated compressed file or an enterprise archive (EAR) file. The structure of the widget compressed file contains the following items:
  • [ear\widgets_name.ear] one or more EAR files.
  • [catalog\catalog_name.xml]
  • [endpoints\*.xml] widget endpoints
  • [templates\*.zip] Templates must be in a compressed file and follow IBM Lotus Mashups template format.
  • [help\eclipse\plugins\*]
All folders are not required. Empty folders are valid.
Note: If you customized REST endpoint information without using the updateBusinessSpaceWidgets command, those endpoint changes are lost after running the uninstallBusinessSpaceWidgets command.

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

Prerequisites

The following conditions must be met:
  • 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.
  • You must connect with a user ID that has WebSphere® Application Server administrator privileges.

Location

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

Syntax

uninstallBusinessSpaceWidgets 
-serverName WebSphere_Portal_server_name
 -nodeName WebSphere_Portal_node_name
 -clusterName cluster_name
 -widgets widget_path
 [-save true|false]

Parameters

-serverName server_name
A required parameter that specifies the server name for the configuration. For configuring Business Space on a server, you must specify both a serverName and a nodeName.
-nodeName node_name
A required parameter that specifies the node name for the configuration. For configuring Business Space on a server, you must specify both a serverName and a nodeName.
-clusterName cluster_name
A required parameter that specifies the cluster name for the configuration. For configuring Business Space on a cluster, you must specify a clusterName.
-widgets widgets_path
A required parameter that specifies one of the following:
  • the full path for the directory that contains the compressed files or the widget EAR files that contain the widgets. If you specify a directory, all widgets will be installed for all compressed files and EAR files in that directory.
  • the full path to an individual compressed file that contains the widgets.
  • the full path to an individual EAR file that contains the widgets.
-save true|false
An optional parameter that indicates saving your configuration changes. The default value is true. If the value is false, you must run AdminConfig.save() at the end of the command to save your changes.

Example

The following example uses the uninstallBusinessSpaceWidgets command to remove widgets from a cluster.
wsadmin -user admin -password admin -lang jython 

wsadmin>AdminTask.uninstallBusinessSpaceWidgets( [ '-clusterName',
'cluster_name', '-widgets', 'X:/WPS/Temp' ] )
Parent topic: Commands (wsadmin scripting)