Commands (wsadmin scripting)

Look up a scripting object or command class to find details about its command syntax.

You can also search for commands by name or by using key words.

addGroupToBusConnectorRole command
Use the addGroupToBusConnectorRole command to add a group to the connector role for a local bus.
addGroupToDefaultRole command
Use the addGroupToDefaultRole command to add a group to the default roles for a local bus.
addGroupToDestinationRole command
Use the addGroupToDestinationRole command to add a group to the destination roles for a local or foreign bus.
addGroupToForeignBusRole command
Use the addGroupToForeignBusRole command to grant a group permission to access a foreign bus from a local bus, in the sender role.
addGroupToTopicRole command
Use the addGroupToTopicRole command to add a group to a topic role within a specified topic space.
addGroupToTopicSpaceRootRole command
Use the addGroupToTopicSpaceRootRole command to add a group to topic space roles on the topic space root.
addSIBBootstrapMember command
Use the addSIBBootstrapMember command to add a nominated bootstrap member to a specified bus.
addSIBPermittedChain command
Use the addSIBPermittedChain command to add a new transport mechanism to the list of permitted transports for a service integration bus.
addSIBusMember command
Use the addSIBusMember command to add a member to a service integration bus by using the wsadmin tool. A bus member can be an application server, a WebSphere® MQ server, or a server cluster.
addSIBWSInboundPort command
Use the addSIBWSInboundPort command to add a service integration bus-enabled web services inbound port.
addSIBWSOutboundPort command
Use the addSIBWSOutboundPort command to add a service integration bus-enabled web services outbound port.
addUserToBusConnectorRole command
Use the addUserToBusConnectorRole command to add a user to the connector role for a local bus.
addUserToDefaultRole command
Use the addUserToDefaultRole command to add a user to the default roles for a local bus.
addUserToDestinationRole command
Use the addUserToDestinationRole command to add a user to the destination roles for a local or foreign bus.
addUserToForeignBusRole command
Use the addUserToForeignBusRole command to grant a user permission to access a foreign bus from a local bus, in the sender role.
addUserToTopicRole command
Use the addUserToTopicRole command to add a user to a topic role within a specified topic space.
addUserToTopicSpaceRootRole command
Use the addUserToTopicSpaceRootRole command to add a user to the sender and receiver roles on the topic space root.
addWSGWTargetService command
Use the addWSGWTargetService command to add a target service to a gateway service configuration.
AdministrationReports command group for the AdminTask object using wsadmin scripting
You can use the Jython or Jacl scripting languages to troubleshoot your configuration with the wsadmin tool. The commands in the AdministrationReports group can be used to create a report of inconsistencies in your system configuration or a report that describes the port usage in the system.
Administrative command invocation syntax using wsadmin scripting
The administrative command uses a specific syntax to invoke operations.
AdministrativeJobs command group for the AdminTask object using wsadmin scripting (deprecated)
You can use the Jython scripting language to configure and manage administrative jobs with the wsadmin tool.
Administrative job types using wsadmin scripting (deprecated)
In a flexible management environment, you can use the wsadmin tool to submit administrative jobs to the job manager. This topic provides detailed information about the administrative jobs, the job parameters, and sample command syntax.
Administrative properties for using wsadmin scripting
Scripting administration utilizes several Java property files. Property files can be used to control your system configurations. Before any property file is specified on the command line, three levels of default property files are loaded. These property files include an installation default file, a user default file, and a properties file.
AdminSDKCmds command group for the AdminTask object
You can use commands and parameters in the AdminSDKCmds group in the Jython or Jacl scripting languages to manage software development kit configurations.
APCconfig.jacl script
Use the APCconfig.jacl script to make persistent changes to the application placement controller configuration.
appEditionRename.py script
You can use the appEditionRename.py script to change the edition of all applications installed on a server or a cluster, excluding system applications.
Application administration scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that start and stop applications. You can run each script individually or combine procedures to create custom automation scripts for your environment.
Application deployment configuration scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that deploy applications. You can run each script individually or combine procedures to create custom automation scripts for your environment.
Application export scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that export applications. You can run each script individually or combine procedures to create custom automation scripts for your environment.
Application installation and uninstallation scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that install applications. You can run each script individually or combine procedures to create custom automation scripts for your environment.
Application management command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage applications with the wsadmin tool. Use the commands and parameters in the AppManagementCommands group can be used to display and process SQL Java™ (SQLJ) profiles or IBM Optim PureQuery Runtime bind files.
Application query scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that query your application configuration. You can run each script individually or combine procedures to create custom automation scripts for your environment.
Application update scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that update applications. You can run each script individually or combine procedures to create custom automation scripts for your environment.
arfmController.py script
You can use the arfmController.py script to force the autonomic request flow manager (ARFM) to forget all of its historical data.
AuditEmitterCommands for the AdminTask object
You can use the Jython scripting language to configure audit service providers with the wsadmin tool. Use the commands and parameters in the AuditEmitterCommands group to create, manage, and remove audit service providers from your security auditing system configuration.
AuditEncryptionCommands command group for the AdminTask object
You can use the Jython scripting language to configure the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditEncryptionCommands group to configure the security audit system to encrypt audit records.
AuditEventFactoryCommands for the AdminTask object
You can use the Jython scripting language to configure the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditEventFactoryCommands group to configure the default or a third-party audit event factory.
AuditEventFormatterCommands command group for the AdminTask object
You can use the Jython scripting language to manage the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditEventFormatterCommands group to manage the event formatter for the audit service provider.
AuditFilterCommands command group for the AdminTask object
You can use the Jython scripting language to configure the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditFilterCommands group to configure and manage auditable events.
AuditKeyStoreCommands command group for the AdminTask object
You can use the Jython scripting language to configure the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditKeyStoreCommands group to configure audit keystores in the security auditing system.
AuditNotificationCommands command group for the AdminTask object
You can use the Jython scripting language to manage the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditNotificationCommands group to configure and manage audit notifications and audit notification monitors.
AuditPolicyCommands command group for the AdminTask object
You can use the Jython scripting language to manage the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditPolicyCommands group to enable and configure the security auditing system.
AuditReaderCommands command group for the AdminTask object
You can use the Jython scripting language to manage the security auditing system with the wsadmin tool. Use the commands and parameters in the AuditReaderCommands group to display audit record information from the binary audit log.
AuditSigningCommands command group for the AdminTask object
You can use the Jython scripting language to configure the signing of audit records with the wsadmin tool. Use the commands and parameters in the AuditSigningCommands group to enable, disable, and configure the security audit system to sign audit records.
AuthorizationGroupCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the AuthorizationGroupCommands group can be used to create and manage authorization groups.
Authorization group configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the scripts in this topic to create, configure, remove and query your security authorization group configuration. You can run each script individually or combine procedures to create custom automation scripts.
Business-level application configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the scripts in this topic to create, query, and manage your business-level applications. You can run each script individually or combine procedures to create custom automation scripts.
BLAManagement command group for the AdminTask object using wsadmin scripting
You can use the Jython scripting language to configure and administer business-level applications with the wsadmin tool. Use the commands and parameters in the BLAManagement group to create, edit, export, delete, and query business-level applications in your configuration.
CAClientCommands command group for the AdminTask object
You can use the Jython scripting language to manage your certificate authority (CA) client configurations with the wsadmin tool. Use the commands and parameters in the CAClientCommands group to create, modify, query, and remove connections to a third-party CA server.
CertificateRequestCommands command group of the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the CertificateRequestCommands group can be used to create and manage certificate requests.
ChannelFrameworkManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security. The commands and parameters in the ChannelFrameworkManagement group can be used to create and manage transport channels and transport channel chains.
checkHmmLocation.jacl script
You can use the checkHmmLocation.jacl script to locate the health controller. Locating the health controller is useful when you are troubleshooting your configuration.
checkPlacementLocation.jacl script
You can use the checkPlacementLocation.jacl script to locate the application placement controller. Locating the application placement controller is useful when you are troubleshooting your configuration.
Cluster administration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the scripts in this topic to start and stop cluster processes with a variety of options. You can run each script individually or combine procedures to create custom automation scripts.
ClusterConfigCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to cluster application servers, generic servers, and proxy servers using scripting. The commands and parameters in the ClusterConfigCommands group can be used to create and delete server clusters and servers known as cluster members.
Cluster configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the scripts in this topic to configure clusters with or without cluster members, using a template, and to remove clusters from your configuration. You can run each script individually, or combine procedures to create custom automation scripts.
Cluster query scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the scripts in this topic to determine if clusters and cluster members exist and to display the clusters and cluster members that are configured in your environment. You can run each script individually, or combine procedures to create custom automation scripts.
Commands for the AdminApp object using wsadmin scripting
Use the AdminApp object to install, modify, and administer applications.
Commands for the AdminConfig object using wsadmin scripting
Use the AdminConfig object to invoke configuration commands and to create or change elements of the WebSphere Application Server configuration, for example, creating a data source.
Commands for the AdminControl object using wsadmin scripting
Use the AdminControl object to invoke operational commands that manage objects for the application server.
Commands for the AdminTask object using wsadmin scripting
Use the AdminTask object to run administrative commands with the wsadmin tool.
Commands for the Help object using wsadmin scripting
You can use the Jython or Jacl scripting languages to find general help and dynamic online information about the currently running MBeans with the wsadmin tool. Use the Help object as an aid in writing and running scripts with the AdminControl object.
ConfigArchiveOperations command group for the AdminTask object using wsadmin scripting
You can use the Jython or Jacl scripting languages to configure servers in your environment. The commands and parameters in the ConfigArchiveOperations group can be used to export or import server configurations and entire cell configurations.
configCGSharedLib.py batch script
You can use the configCGSharedLib.py Jython script to assign the shared library to the job scheduler.
connectSIBWSEndpointListener command
Use the connectSIBWSEndpointListener command to connect a service integration bus-enabled web services endpoint listener to a service integration bus.
CoreGroupBridgeManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage deployed applications using scripting. The commands and parameters in the CoreGroupBridgeManagement group can be used to create and manage core group access points, TCP inbound channel port, and bridge interfaces. A bridge interface specifies a particular node and server that runs the core group bridge service.
CoreGroupManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage deployed applications. The commands and parameters in the CoreGroupManagement group can be used to create and manage core groups. A core group is a high availability domain that consists of a set of processes in the same cell that can directly establish high availability relationships. A cell must contain at least one core group.
CoreGroupPolicyManagement command group for the AdminTask object
You can use the Jython scripting language to configure and administer policies for high availability groups with the wsadmin tool. Use the commands and parameters in the CoreGroupPolicyManagement group to create, delete, and modify policies.
coregroupsplit.py script
You can use the coregroupsplit.py script to split your existing cell into multiple core groups. Consider running this script if you have more than 40 WebSphere Application Server related processes such as application servers, node agents, and on demand routers (ODRs) defined in your core group.
correctSIBEnginePolicy command
Use the correctSIBEnginePolicy command to change a core group policy for a messaging engine in a cluster that is a member of a service integration bus, so that the core group policy conforms to the current messaging engine policy set for the cluster.
createDynamicCluster.jacl script
You can use the createDynamicCluster.jacl script to create a dynamic cluster.
createJAXWSHandler command
Use the createJAXWSHandler command to create a new Java API for XML-based Web Services (JAX-WS) handler configuration so that the handler can be used, as part of a handler list, with Version 7.0 WS-Notification services.
createJAXWSHandlerList command
Use the createJAXWSHandlerList command to create a Java API for XML-based Web Services (JAX-WS) handler list for use with Version 7.0 WS-Notification services.
createMissingSIBEnginePolicy command
Use the createMissingSIBEnginePolicy command to create a core group policy for a messaging engine in a cluster that is a member of a service integration bus.
createodr.jacl script
You can use the createodr.jacl script to create an on demand router (ODR) from the command line.
createSIBDestination command
Use the createSIBDestination command to create a new bus destination for a service integration bus.
createSIBDestinations command
Use the createSIBDestinations command to create new bus destinations for a service integration bus.
createSIBEngine command
Use the createSIBEngine command to create a messaging engine for a server or cluster bus member by using the wsadmin tool. When you add a server or a cluster as a member of a service integration bus, at least one messaging engine is created automatically. Use the createSIBEngine command to create an additional messaging engine for a cluster bus member.
createSIBForeignBus command
Use the createSIBForeignBus command to create a new service integration foreign bus.
createSIBJMSActivationSpec command
Use the createSIBJMSActivationSpec command to create a new JMS activation specification for the default messaging provider at a specific scope.
createSIBJMSConnectionFactory command
Use the createSIBJMSConnectionFactory command to create a new JMS connection factory for the default messaging provider at a specific scope.
createSIBJMSQueue command
Use the createSIBJMSQueue command to create a new JMS queue for the default messaging provider at a specific scope.
createSIBJMSTopic command
Use the createSIBJMSTopic command to create a new JMS topic for the default messaging provider at a specific scope.
createSIBLink command
Use the createSIBLink command to create a new service integration bus link.
createSIBMediation command
Use the createSIBMediation command to create a new mediation.
createSIBMQLink command
Use the createSIBMQLink command to create a new IBM MQ link for a specified service integration bus.
createSIBus command
Use the createSIBus command to create a new service integration bus.
createSIBWMQServer command
Use the createSIBWMQServer command to create a new IBM MQ server at cell scope.
createSIBWSEndpointListener command
Use the createSIBWSEndpointListener command to create a new service integration bus-enabled web services endpoint listener configuration.
createSIBWSInboundService command
Use the createSIBWSInboundService command to create a new service integration bus-enabled web services inbound service configuration.
createSIBWSOutboundService command
Use the createSIBWSOutboundService command to create a new service integration bus-enabled web services outbound service configuration.
createWMQActivationSpec command
Use the createWMQActivationSpec command to create an activation specification for the IBM MQ messaging provider at a specific scope.
createWMQConnectionFactory command
Use the createWMQConnectionFactory command to create a connection factory for the IBM MQ messaging provider at a specific scope.
createWMQQueue command
Use the createWMQQueue command to create a queue type destination for the WebSphere MQ messaging provider at a specific scope.
createWMQTopic command
Use the createWMQTopic command to create a JMS topic destination for the WebSphere MQ messaging provider at a specific scope.
createWSGWGatewayService command
Use the createWSGWGatewayService command to create a new gateway service configuration.
createWSGWProxyService command
Use the createWSGWProxyService command to set the gateway to act as a proxy for your service, then use JAX-RPC handlers to set the endpoints for incoming request messages for the service.
createWSNAdministeredSubscriber command
Use the createWSNAdministeredSubscriber command to create a new administered subscriber. An administered subscriber provides a mechanism for the WS-Notification service point to subscribe to an external notification producer at server startup time.
createWSNService command
Use the createWSNService command to create a new WS-Notification service and the associated objects that form the infrastructure of the WS-Notification configuration. A WS-Notification service provides access to service integration bus resources for web services publish and subscribe clients.
createWSNServicePoint command
Use the createWSNServicePoint command to create a new WS-Notification service point. A WS-Notification service point defines access to a WS-Notification service on a given bus member through a specified web service binding (for example SOAP over HTTP). Applications use the bus members associated with the WS-Notification service point to connect to the WS-Notification service.
createWSNTopicDocument command
A topic namespace can optionally have topic namespace documents applied to it that define the structure of the topics that are permitted within the namespace. Use the createWSNTopicDocument command to apply a topic namespace document to an existing topic namespace.
createWSNTopicNamespace command
Use the createWSNTopicNamespace command to create a new WS-Notification permanent topic namespace. A topic namespace is a grouping of topics that allows information to be shared between applications. You use a permanent topic namespace to statically define the association between a WS-Notification topic namespace URI and a service integration bus topic space destination.
CustomProperties policy and binding properties
Use the -attributes parameter for the setBinding command to specify additional configuration information for the CustomProperties policy set binding. Application and system policy sets can use the CustomProperties policy and binding.
DataReaderWrapper class
You can use a command-line Java class to configure the runtime operations reports to log data for reuse in external programs.
Data types for the AdminTask object using wsadmin scripting
The parameters for the AdminTask object accept various data types for different commands.
Defining destination defaults inheritance by using the wsadmin tool
By default, the inheritance of default permissions by destinations is allowed for all local destinations. Use this command to override inheritance for an individual destination, or to restore default inheritance in cases where you have previously overridden it.
Defining topic role inheritance by using the wsadmin tool
Use these commands to define the inheritance of topic roles by child topics within a topic hierarchy.
deleteDynamicCluster.jacl script
You can use the deleteDynamicCluster.jacl script to delete dynamic clusters.
deleteJAXWSHandler command
Use the deleteJAXWSHandler command to delete the configuration for a Java API for XML-based Web Services (JAX-WS) handler that is configured for use, as part of a handler list, with Version 7.0 WS-Notification services.
deleteJAXWSHandlerList command
Use the deleteJAXWSHandlerList command to delete the configuration for a Java API for XML-based Web Services (JAX-WS) handler list that is configured for use with Version 7.0 WS-Notification services.
deleteodr.jacl script
You can use the deleteodr.jacl script to delete an on demand router (ODR) from the command line.
deleteSIBDestination command
Use the deleteSIBDestination command to delete a bus destination.
deleteSIBDestinations command
Use the deleteSIBDestinations command to delete bus destinations.
deleteSIBEngine command
Use the deleteSIBEngine command to delete a messaging engine from a service integration bus member.
deleteSIBForeignBus command
Use the deleteSIBForeignBus command to delete a foreign bus.
deleteSIBJMSActivationSpec command
Use the deleteSIBJMSActivationSpec command to delete a JMS activation specification for the default messaging provider at a specific scope.
deleteSIBJMSConnectionFactory command
Use the deleteSIBJMSConnectionFactory command to delete a JMS connection factory for the default messaging provider at a specific scope.
deleteSIBJMSQueue command
Use the deleteSIBJMSQueue command to delete a JMS queue for the default messaging provider at a specific scope.
deleteSIBJMSTopic command
Use the deleteSIBJMSTopics command to delete a JMS topic for the default messaging provider at a specific scope.
deleteSIBLink command
Use the deleteSIBLink command to delete a service integration bus link from a bus.
deleteSIBMediation command
Use the deleteSIBMediation command to delete a mediation.
deleteSIBMQLink command
Use the deleteSIBMQLink command to delete a IBM MQ link from a service integration bus.
deleteSIBus command
Use the deleteSIBus command to delete a specified service integration bus.
deleteSIBWMQServer command
Use the deleteSIBWMQServer command to delete a specified IBM MQ server and remove the associated IBM MQ server bus members, assigned queue points and mediation points.
deleteSIBWSEndpointListener command
Use the deleteSIBWSEndpointListener command to delete a service integration bus-enabled web services endpoint listener configuration.
deleteSIBWSInboundService command
Use the deleteSIBWSInboundService command to delete a service integration bus-enabled web services inbound service configuration.
deleteSIBWSOutboundService command
Use the deleteSIBWSOutboundService command to delete a service integration bus-enabled web services outbound service configuration.
deleteWMQActivationSpec command
Use this command to delete a IBM MQ messaging provider activation specification at a specific scope.
deleteWMQConnectionFactory command
Use the deleteWMQConnectionFactory command to delete a IBM MQ messaging provider connection factory at a specific scope.
deleteWMQQueue command
Use this command to delete a IBM MQ messaging provider queue type destination at a specific scope.
deleteWMQTopic command
Use this command to delete a IBM MQ messaging provider topic at a specific scope.
deleteWSGWGatewayService command
Use the deleteWSGWGatewayService command to delete a gateway service configuration.
deleteWSGWInstance command
Use the deleteWSGWInstance command to delete a gateway instance.
deleteWSGWProxyService command
Use the deleteWSGWProxyService command to delete a proxy service configuration.
deleteWSNAdministeredSubscriber command
Use the deleteWSNAdministeredSubscriber command to delete a WS-Notification administered subscriber. An administered subscriber provides a mechanism for the WS-Notification service point to subscribe to an external notification producer at server startup time.
deleteWSNService command
Use the deleteWSNService command to delete a WS-Notification service and associated resources. A WS-Notification service provides access to service integration bus resources for web services publish and subscribe clients.
deleteWSNServicePoint command
Use the deleteWSNServicePoint command to delete a WS-Notification service point and the associated resources. A WS-Notification service point defines access to a WS-Notification service on a given bus member through a specified web service binding (for example SOAP over HTTP). Applications use the bus members associated with the WS-Notification service point to connect to the WS-Notification service.
deleteWSNTopicDocument command
A topic namespace can optionally have topic namespace documents applied to it that define the structure of the topics that are permitted within the namespace. Use the deleteWSNTopicDocument command to delete a WS-Notification topic namespace document and the associated resources.
deleteWSNTopicNamespace command
Use the deleteWSNTopicNamespace command to delete a WS-Notification permanent topic namespace and the associated resources. A topic namespace is a grouping of topics that allows information to be shared between applications. You use a permanent topic namespace to statically define the association between a WS-Notification topic namespace URI and a service integration bus topic space destination.
DescriptivePropCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the DescriptivePropCommands group can be used to create, delete, and manage key manager setting in your configuration.
Determining destination defaults inheritance by using the wsadmin tool
By default, the inheritance of default permissions by destinations is allowed for all local destinations. Use this command to determine whether the inheritance of default permissions is enabled or disabled for a local destination.
Determining topic role inheritance by using the wsadmin tool
Use these commands to list whether the child topics within a topic hierarchy currently have inheritance set or disabled.
disconnectSIBWSEndpointListener command
Use the disconnectSIBWSEndpointListener command to disconnect a bus-enabled web services endpoint listener from a service integration bus.
DRS command group for the AdminTask object using wsadmin scripting
You can use the Jython scripting language to configure the data replication service. Use the commands in the DRS command group display each configuration object that references a specific replication domain.
dumpIMPState.py script
Use the dumpIMPState.py script to record the state of various Intelligent Management processes. You can use this script for problem diagnosis and debugging purposes when requested by IBM® support. The detailed state of the on demand router (ODR), the deployment manager, and application server processes are displayed when using this script.
dumpOdrState.jacl script
You can use the dumpOdrState.jacl script to dump on demand router (ODR) states, and for problem diagnosis and debugging purposes. The detailed state of the queues and throttles of each gateway running in the ODR, as well as other global counters, are returned.
DynamicCache command group for the AdminTask object
You can use the Jython scripting language to manage the dynamic cache service. Use the commands in the DynamicCache command group to create object and service cache instances with the wsadmin tool.
Dynamic cache MBean statistics
The dynamic cache service provides an MBean interface to access cache statistics.
DynamicSSLConfigSelections command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the DynamicSSLConfigSelections group can be used to create, delete, and query dynamic SSL configuration selection objects.
Example: Collecting arguments for the AdminControl object using wsadmin scripting
This example shows how to use multiple arguments with the AdminControl object.
Example: Identifying running objects using wsadmin scripting
Use the AdminControl object to interact with running MBeans.
Example: Listing the modules in an application server
This example lists all of the modules on all of the enterprise applications that are installed on the server1 server in a node named node1.
Example: Obtaining option information for AdminApp object commands using wsadmin scripting
Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application.
FileRegistryCommands command group for the AdminTask object
Federated repositories provides a file registry. Use the commands in the FileRegistryCommands command group to administer the file registry using the wsadmin tool.
FIPSCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure Federal Information Processing Standards (FIPS) with the wsadmin tool.
getClientDynamicPolicyControl command
Use the getClientDynamicPolicyControl command to find out whether an application that is a web service client obtains the policy configuration of a web service provider, and to list the properties that apply to obtaining that configuration.
getProviderPolicySharingInfo command
Use the getProviderPolicySharingInfo command to find out whether an application or service that is a web service provider can share its policy configuration, and list the properties that apply to sharing that configuration.
getWSN_SIBWSInboundPort command
Use the getWSN_SIBWSInboundPort command to retrieve a reference to an inbound port associated with a Version 6.1 WS-Notification service point.
getWSN_SIBWSInboundService command
Use the getWSN_SIBWSInboundService command to retrieve a reference to an inbound service that is associated with a Version 6.1 WS-Notification service.
HmmControllerProcs.jacl script
Using the HmmControllerProcs.jacl script, you can modify your health management runtime configuration to enable or disable the health controller and automated restarts for the server, and set or retrieve values for other health management settings.
httpPluginManagement.py script
Use the httpPluginManagement.py script to generate a new plugin-cfg.xml file for an application.
HTTPTransport policy and binding properties
Use the -attributes parameter for the setPolicyType and setBinding commands to specify additional configuration information for the HTTPTransport policy and policy set binding. Application and system policy sets can use the HTTPTransport policy and binding.
IdMgrConfig command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure the virtual member manager with the wsadmin tool. The commands and parameters in the IdMgrConfig group can be used to create and manage your entity type configuration.
IdMgrDataModel command group for the AdminTask object
You can use the Jython or Jacl scripting language to manage the federated repository schema using the wsadmin tool. Use the commands and parameters in the IdMgrDataModel group to manage the property extension repository. The commands are available in connected or local mode using the -conntype NONE option.
IdMgrDBSetup command group for the AdminTask object
You can use the Jython or Jacl scripting language to manage the federated repository schema using the wsadmin tool. Use the deleteIdMgrPropertyExtensionEntityData command and its parameters in the IdMgrDBSetup group to manage the property extension repository. The command is available in both connected and local mode using the -conntype NONE option.
IdMgrRealmConfig command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure federated repositories realms. The commands and parameters in the IdMgrRealmConfig group can be used to create and manage your realm configuration.
IdMgrRepositoryConfig command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security. The commands and parameters in the IdMgrRepositoryConfig group can be used to create and manage the virtual member manager and LDAP directory properties.
importOverlayConfig.py script
When setting up a star topology, you can use the importOverlayConfig.py script to configure the overlay communication between multiple cells.
Intelligent Management: administrator scripting interface
This reference information provides examples of how to complete various tasks using the administrative scripting interface.
Intelligent Management: application edition management administrative tasks
You can use the Jacl or Jython scripting languages to manage application editions. You can also use the AdminApp object to manage applications with specific editions.
Intelligent Management: default work class administrative tasks
You can use the default work class administrative tasks to create work classes.
Intelligent Management: dynamic cluster administrative tasks
Use the dynamic cluster commands to view or edit the dynamic clusters, without using the administrative console.
Intelligent Management: health controller commands with the AdminConfig object
You can use the AdminConfig object to modify the health controller settings. You can change the controller cycle, prohibit server restarts at certain times of the day, and so on.
Intelligent Management: health policy administrative tasks
You can use the following administrative tasks to create, delete, and manage health policies.
Intelligent Management: maintenance mode administrative tasks
You can use the server maintenance mode commands to view or edit the maintenance mode of your servers without using the administrative console. To set maintenance mode on a node, you can use the NodeGroupManager MBean .
Intelligent Management: middleware application administrative tasks
You can use the Jacl or Jython scripting languages to create and manage middleware applications with the wsadmin tool.
Intelligent Management: middleware descriptor administrative tasks
You can use the middleware descriptor administrative tasks to list the middleware descriptors and versions, display or change middleware descriptor information, and modify the middleware descriptor discovery interval.
Intelligent Management: middleware server creation administrative tasks
You can use administrative tasks to write a script that can recreate your middleware server configuration.
Intelligent Management: middleware server management administrative tasks
You can use the Jython and Jacl scripting languages to manage middleware servers with the wsadmin tool. Use the commands and parameters in the MiddlewareServerManagement group.
Intelligent Management: middleware server template administrative tasks
Use middleware server template administrative tasks to create server templates for middleware servers that you have created.
Intelligent Management: PHP server administrative tasks
Use the following commands to create and configure PHP servers and server templates.
Intelligent Management: rules for ODR routing policy administrative tasks
You can use administrative tasks to configure HTTP or Session Initiation Protocol (SIP) rules for the on demand router (ODR) routing policy.
Intelligent Management: rules for ODR service policy administrative tasks
You can use administrative tasks to configure Session Initiation Protocol (SIP) or HTTP rules for an on demand router (ODR) service policy.
Intelligent Management: runtime operations user preferences administrative tasks
You can use the Jacl and Jython scripting languages to clone, set, and get preferences with the wsadmin tool. Use the commands and parameters in the UserPreferences group.
Intelligent Management: scripts
You can use the Intelligent Management scripts after you install the product. The scripts are in the app_server_root/bin directory. In addition, you can use a new series of scripting objects. To access the new scripting objects, invoke the $AdminConfig types command from the wsadmin tool.
Intelligent Management: trace settings for autonomic request flow manager and application placement
To troubleshoot the autonomic request flow manager and application placement, you can enable diagnostic trace.
J2C configuration scripts
The scripting library provides many script procedures to manage your Java 2 Connector (J2C) configurations. Use the scripts in this topic to create activation specifications, administrative objects, and connection factories, and to install resource adapters. You can run each script individually or combine many procedures to create custom automation scripts for your environment.
J2C query scripts
The scripting library provides many script procedures to manage your Java 2 Connector (J2C) configurations. This topic provides usage information for scripts that query your J2C configuration. You can run each script individually or combine many procedures to create custom automation scripts for your environment.
JACCUtilityCommands command group for the AdminTask object
Use this topic as a reference for the commands for the JACCUtilityCommands group for the AdminTask object. Use these commands to determine whether Java Authorization Contract for Containers (JACC) is enabled and whether the runtime uses a single security domain. You can also use these commands to propagate the security policies for application to the JACC provider.
JaspiManagement command group for the AdminTask object
Use the commands and parameters in the JaspiManagement command group to manage the configuration of authentication providers.
JavaEEDefaultResources command group for the AdminTask object
You can use the Jython scripting language to configure resource providers with the wsadmin tool.
JCAManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure messaging with scripting. The commands and parameters in the JCA management group can be used to create and manage resource adapters, Java EE Connector Architecture (J2C) activation specifications, administrative objects, connection factories, administrative object interfaces, and message listener types.
JDBC configuration scripts
The scripting library provides many script procedures to manage Java Database Connectivity (JDBC) configurations in your environment. See the usage information for scripts that configure JDBC settings. You can run each script individually or combine many procedures to create custom automation scripts for your environment.
JDBCProviderManagement command group for AdminTask object
You can use the Jython or Jacl scripting languages in interactive mode to configure data access and data sources with scripting. The commands and parameters in the JDBCProviderManagement group can be used to create or list data sources and Java database connectivity (JDBC) providers.
JDBC query scripts
The scripting library provides many script procedures to manage Java Database Connectivity (JDBC) configurations in your environment. See the usage information for scripts that retrieve configuration IDs for your JDBC configuration. You can run each script individually or combine many procedures to create custom automation scripts for your environment.
JMS configuration scripts
The scripting library provides many script procedures to manage your Java Messaging Service (JMS) configurations. See the usage information for scripts that query your JMS configuration. You can run each script individually or combine many procedures to create custom automation scripts for your environment.
JMS query scripts
The scripting library provides many script procedures to manage your Java Messaging Service (JMS) configurations. See the usage information for scripts that retrieve configuration IDs from your JMS configuration. You can run each script individually or combine many procedures to create custom automation scripts for your environment.
JMSTransport policy and binding properties
Use the -attributes parameter for the setPolicyType and setBinding commands to specify additional configuration information for the JMSTransport policy and policy set binding. Application policy sets can use the JMSTransport policy and binding.
JobManagerNode command group for the AdminTask object using wsadmin scripting (deprecated)
You can use the Jython scripting language to manage job manager settings with the wsadmin tool. Use the commands and parameters in the JobManagerNode group to register targets that do not contain an administrative agent with the job manager.
JobManagerUpkeep command group for the AdminTask object using wsadmin scripting (deprecated)
You can use the Jython scripting language to manage job manager settings with the wsadmin tool. Use the commands and parameters in the JobManagerUpkeep group to back up the job manager database.
JobSchedulerCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure the job scheduler with the wsadmin tool. The commands and parameters in the JobSchedulerCommands command group can be used to manage configuration attributes and custom properties.
JSFCommands command group for the AdminTask object
You can use the Jython scripting language to display and modify the JavaServer Faces (JSF) implementation.
Kerberos authentication commands
Use wsadmin commands to create, modify or delete Kerberos as the authentication mechanism for WebSphere Application Server.
keyManagerCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security. The commands and parameters in the keyManagerCommands group can be used to manage key manager settings. You can use these commands to create, modify, list, or obtain information about key managers.
KeyReferenceCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the KeyReferenceCommands group can be used to create and manage the key reference settings for key set objects in your configuration.
KeySetCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the KeySetCommands group can be used to create, delete, and query for key set settings in your configuration.
KeySetGroupCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the KeySetGroupCommands group can be used to create and manage key set groups. Use these commands to manage groups of public, private, and shared keys.
KeyStoreCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure keystores with the wsadmin tool. A keystore is created by the application server during installation and can contain cryptographic keys or certificates. The commands and parameters in the KeyStoreCommands group can be used to create, delete, and manage keystores.
linkCells|linkCellsZOS script
When you set up a star topology, you can use the linkCells script to configure the overlay communication between multiple cells. On z/OS® systems, use the linkCellsZOS script instead.
listAllSIBBootstrapMembers command
Use the listAllSIBBootstrapMembers command to list all the bootstrap members that can bootstrap into a selected bus.
listGroupsInBusConnectorRole command
Use the listGroupsInBusConnectorRole command to list all the groups in the connector role for a local bus.
listGroupsInDefaultRole command
Use the listGroupsInDefaultRole command to list the groups in the default roles for a local bus.
listGroupsInDestinationRole command
Use the listGroupsInDestinationRole command to list the groups in the destination roles for a local bus.
listGroupsInForeignBusRole command
Use the listGroupsInForeignBusRole command to list the groups in the sender role for a foreign bus.
listGroupsInTopicRole command
Use the listGroupsInTopicRole command to list the groups in topic roles for a topic space on a local bus.
listGroupsInTopicSpaceRootRole command
Use the listGroupInTopicSpaceRootRole command to list all the groups in topic space roles on the topic space root for a local bus.
Listing security roles for service integration by using the wsadmin tool
When you are administering messaging security, use these commands to list the security roles that are associated with service integration bus destinations, foreign buses, topics within a topic space, users and groups.
listJAXWSHandlerLists command
Use the listJAXWSHandlerLists command to list the Java API for XML-based Web Services (JAX-WS) handler lists that are configured, for a given cell, for use with Version 7.0 WS-Notification services.
listJAXWSHandlers command
Use the listJAXWSHandlers command to list the Java API for XML-based Web Services (JAX-WS) handlers that are configured for use, as part of a handler list, with Version 7.0 WS-Notification services.
listSIBDestinations command
Use the listSIBDestinations command to list the bus destinations for a service integration bus.
listSIBEngines command
Use the listSIBEngines command to list the messaging engines for a service integration bus member.
listSIBForeignBuses command
Use the listSIBForeignBuses command to list all foreign buses for a specified service integration bus.
listSIBJMSActivationSpecs command
Use the listSIBJMSActivationSpecs command to list all JMS activation specifications for the default messaging provider at a specific scope.
listSIBJMSConnectionFactories command
Use the listSIBJMSConnectionFactories command to list all JMS connection factories for the default messaging provider at a specific scope.
listSIBJMSQueues command
Use the listSIBJMSQueues command to list all JMS queues for the default messaging provider at a specific scope.
listSIBJMSTopics command
Use the listSIBJMSTopics command to list all JMS topics for the default messaging provider at a specific scope.
listSIBLinks command
Use the listSIBLinks command to list all service integration bus links for a given bus.
listSIBMediations command
Use the listSIBMediations command to list mediations on a service integration bus.
listSIBMQLinks command
Use the listSIBMQLinks command to list all IBM MQ links for a specified service integration bus.
listSIBNominatedBootstrapMembers command
Use the listSIBNominatedBootstrapMembers command to list all the nominated bootstrap members for a specified bus.
listSIBPermittedChain command
Use the listSIBPermittedChain command to list the permitted transport chains for a service integration bus.
listSIBuses command
Use the listSIBuses command to list all service integration buses for a given scope.
listSIBusMembers command
Use the listSIBusMembers command to list the members of a service integration bus.
listSIBWMQServerBusMembers command
Use the listSIBWMQServerBusMembers command to list the IBM MQ server bus members known to the bus.
listSIBWMQServers command
Use the listSIBWMQServers command to list the IBM MQ servers known to a cell.
listUsersInBusConnectorRole command
Use the listUsersInBusConnectorRole command to list users in the connector role for a local bus.
listUsersInDefaultRole command
Use the listUsersInDefaultRole command to list users in the default roles for a local bus.
listUsersInDestinationRole command
Use the listUsersInDestinationRole command to list users in the destination roles for a local bus.
listUsersInForeignBusRole command
Use the listUsersInForeignBusRole command to list users that can send messages from a local bus to a foreign bus.
listUsersInTopicRole command
Use the listUsersInTopicRole command to list users in the topic roles within a specified topic space.
listUsersInTopicSpaceRootRole command
Use the listUsersInTopicSpaceRootRole command to list the users in the sender and receiver roles on the topic space root.
listWMQActivationSpecs command
Use the listWMQActivationSpecs command to list IBM MQ messaging provider activation specifications.
listWMQConnectionFactories command
Use the listWMQConnectionFactories command to list IBM MQ messaging provider connection factories.
listWMQQueues command
Use the listWMQQueues command to list IBM MQ messaging provider queue type destinations.
listWMQTopics command
Use the listWMQTopics command to list IBM MQ messaging provider topics.
listWSNAdministeredSubscribers command
Use the listWSNAdministeredSubscribers command to list the WS-Notification administered subscribers in the configuration of the target WS-Notification service point that match the specified input parameters. An administered subscriber provides a mechanism for the WS-Notification service point to subscribe to an external notification producer at server startup time.
listWSNServicePoints command
Use the listWSNServicePoints command to list the WS-Notification service points in the configuration of the target WS-Notification service that match the specified input parameters. A WS-Notification service point defines access to a WS-Notification service on a given bus member through a specified web service binding (for example SOAP over HTTP). Applications use the bus members associated with the WS-Notification service point to connect to the WS-Notification service.
listWSNServices command
Use the listWSNServices command to list WS-Notification services. A WS-Notification service provides access to service integration bus resources for web services publish and subscribe clients.
listWSNTopicDocuments command
A topic namespace can optionally have topic namespace documents applied to it that define the structure of the topics that are permitted within the namespace. Use the listWSNTopicDocuments command to list the topic namespace documents in the configuration of the target WS-Notification topic namespace that match the specified input parameters.
listWSNTopicNamespaces command
Use the listWSNTopicNamespaces command to list the WS-Notification topic namespaces in the configuration of the target WS-Notification service that match the specified input parameters. A topic namespace is a grouping of topics that allows information to be shared between applications.You use a permanent topic namespace to statically define the association between a WS-Notification topic namespace URI and a service integration bus topic space destination.
LTPA_LDAPSecurityOn and LTPA_LDAPSecurityOff command usage
Use the examples in this topic to enable and disable LTPA/LDAP security, based on single sign-on using the LDAP user registry.
LTPACommandGroup command group for the AdminTask object
You can use the Jython or Jacl scripting languages to import and export LTPA keys.
manageBBSON.py script
Use the manageBBSON.py script to gather the BBSON bulletin board usage statistics, and periodically dump BBSON states. The statistics are available in the standard output and trace log files.
ManagedNodeAgent command group for the AdminTask object using wsadmin scripting (deprecated)
You can use the Jython scripting language to configure the job manager with the wsadmin tool. Use the commands and parameters in the ManagedNodeAgent group to configure, query, and manage your job manager configuration for managed nodes.
ManagedNodeGroup command group for the AdminTask object using wsadmin scripting (deprecated)
You can use the Jython scripting language to configure managed node groups with the wsadmin tool. Use the commands and parameters in the ManagedNodeGroup command group to create and manage node groups. Create managed node groups to submit jobs from the job manager to one or many managed nodes.
ManagedObjectMetadata command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the ManagedObjectMetadata group can be used to retrieve configuration and metadata information for a specified node.
ManagementScopeCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. Inbound and outbound management scopes represent opposing directions during the connection handshake process. The commands and parameters in the ManagementScopeCommands group can be used to create, delete, and list management scopes.
manageODC.py script
manageODC.py permits the interaction with the On Demand Configuration (ODC) tree. The ODC tree is an in-memory representation of the state of a WebSphere Application Server cell.
manageODR.py script
You can use the manageODR.py script to create a cluster of on demand routers (ODRs), and to manage routing rules and custom logging.
manageWMQ command
Use the manageWMQ command to manage the settings of the IBM MQ resource adapter that is installed at a particular scope.
Mapping of administrative console panel names to command names and IBM MQ names
Use these tables to relate the names used in the administrative console panels to the names in the commands and the names used by IBM MQ.
mediateSIBDestination command
Use the mediateSIBDestination command to mediate a bus destination for a service integration bus.
migrateServerMEtoCluster command
When a server that is a member of a bus is converted to a cluster, use the migrateServerMEtoCluster command to migrate the messaging engine (ME) in the server to cluster scope. During the conversion, the bus membership is not automatically transferred to cluster scope. If you want the cluster to be a member of the bus, use this command to perform that transfer.
migrateWMQMLP command
Use the migrateWMQMLP command to migrate a IBM MQ message listener port definition to an activation specification definition.
MirrorCell script
You can use the MirrorCell script to create representations of servers that are running previous versions of WebSphere Application Server in the Intelligent Management environment.
modifyJAXWSHandler command
Use the modifyJAXWSHandler command to modify a Java API for XML-based Web Services (JAX-WS) handler configuration for a handler that is used, as part of a handler list, with Version 7.0 WS-Notification services.
modifyJAXWSHandlerList command
Use the modifyJAXWSHandlerList command to modify the configuration details for a Java API for XML-based Web Services (JAX-WS) handler list that has been configured for use with Version 7.0 WS-Notification services.
modifySIBDestination command
Use the modifySIBDestination command to change properties of a bus destination for a service integration bus.
modifySIBEngine command
Use the modifySIBEngine command to modify the properties of a messaging engine for a service integration bus member.
modifySIBForeignBus command
Use the modifySIBForeignBus command to modify the properties of a foreign bus.
modifySIBJMSActivationSpec command
Use the modifySIBJMSActivationSpec command to change properties of a JMS activation specification for the default messaging provider at a specific scope.
modifySIBJMSConnectionFactory command
Use the modifySIBJMSConnectionFactory command to modify the properties of a JMS connection factory for the default messaging provider at a specific scope.
modifySIBJMSQueue command
Use the modifySIBJMSQueue command to change the properties of a JMS queue for the default messaging provider at a specific scope.
modifySIBJMSTopic command
Use the modifySIBJMSTopic command to change the properties of a JMS topic for the default messaging provider at a specific scope.
modifySIBLink command
Use the modifySIBLink command to modify the properties of a service integration bus link.
modifySIBMediation command
Use the modifySIBMediation command to change the properties of a mediation.
modifySIBMQLink command
Use the modifySIBMQLink command to modify the properties of a IBM MQ link.
modifySIBus command
Use the modifySIBus command to modify the properties of a service integration bus.
modifySIBusMemberPolicy command
Use the modifySIBusMemberPolicy command to change the messaging engine configuration for a cluster that is a member of a service integration bus.
modifySIBWMQServerBusMember command
Use the modifySIBWMQServerBusMember command to modify the attributes of a IBM MQ server bus member.
modifySIBWMQServer command
Use the modifySIBWMQServer command to modify a IBM MQ server.
modifyWMQActivationSpec command
Use the modifyWMQActivationSpec command to change certain parameters of a WebSphere MQ messaging provider activation specification.
modifyWMQConnectionFactory command
Use the modifyWMQConnectionFactory command to change certain parameters of a WebSphere MQ messaging provider connection factory.
modifyWMQQueue command
Use the modifyWMQQueue command to change certain parameters of a IBM MQ messaging provider queue type destination.
modifyWMQTopic command
Use the modifyWMQTopic command to change certain parameters of a IBM MQ messaging provider topic.
NamingAuthzCommands command group for the AdminTask object
You can use the Jython scripting language to configure naming roles for groups and users with the wsadmin tool. Use the commands and parameters in the NamingAuthzCommands group to assign, remove, and query naming role configuration. CosNaming security offers increased granularity of security control over CosNaming functions.
Node administration scripts
The scripting library provides multiple script procedures to automate your server configurations. See the usage information for scripts that query, configure, and manage your node configurations. You can run each script individually, or combine procedures to create custom automation scripts for your environment.
NodeGroupCommands command group for the AdminTask object using wsadmin scripting
You can use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the NodeGroupCommands group can be used to create and manage node groups and node group members.
Node group configuration scripts
The scripting library provides multiple script procedures to automate your server configurations. Use the information in this topic to use scripts that query, configure, and manage your node configurations. You can run each script individually, or combine procedures to create custom automation scripts for your environment.
odrDebug.py script
You can use the odrDebug.py script to diagnose errors that an on demand router (ODR) returns.
Options for the AdminApp object install, installInteractive, edit, editInteractive, update, and updateInteractive commands using wsadmin scripting
This topic lists the available options for the install, installInteractive, edit, editInteractive, update, and updateInteractive commands of the AdminApp object.
PasswordUtilCommands group for the AdminTask object
Use the PasswordUtilCommands group to configure password encryption by using the Jython or Jacl scripting languages in the wsadmin tool. You can enable, disable, or modify password encryption, and manage the keystore for password encryption.
PersonalCertificateCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the PersonalCertificateCommands group can be used to create and manage personal or signer certificates.
PlacementControllerProcs.jacl script
You can use the PlacementControllerProcs.jacl script to modify the application placement runtime configuration.
pluginIntelligentManagement.py script
Use the pluginIntelligentManagement.py script to perform Intelligent Management functions.
pluginMerge script
You can use the pluginMerge script to merge the plugin-cfg.xml files from two or more unbridged cells in order to allow an IBM HTTP server plug-in to route to all cells according to the defined mode.
Policy configuration properties for all policies
You can use the attributes parameter with the setPolicyType and setBinding commands to specify various properties for each quality of service (QoS) within a policy set. You can use the properties in this topic with each QoS within application and system policy sets.
PolicySetManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage policy set configurations with the wsadmin tool. Use the commands and parameters in the PolicySetManagement group to create, delete, and manage policy set, policy, and policy set attachment configurations.
populateUniqueNames command
Use the populateUniqueNames command to add missing unique names to the authorization policy for a service integration bus.
PortManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure servers with the wsadmin tool. The commands and parameters in the PortManagement group can be used to list and modify application and server ports.
propagatePluginCfg.py script
Use the propagatePluginCfg.py script to automatically propagate the generated plugin-cfg.xml file.
PropertiesBasedConfiguration command group for the AdminTask object using wsadmin scripting
You can use scripting to customize part of your system configuration using properties files. The WebSphere configuration repository stores many different types of configurations. You can use properties files to customize some of these configurations. You can customize some configurations that are created by the WebSphere Common Configuration Model (WCCM) or configurations that are deployed as Java EE applications.
Properties file syntax
To use the properties file based configuration tool, properties files must use supported syntax.
Properties for web services endpoint URL fragments using property files
You can use properties files to work with web services endpoint URL fragments.
Provider command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure mail settings with the wsadmin tool. The commands and parameters in the provider group can be used to create, delete, and manage providers.
ProxyManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage proxy configurations. Use the commands and parameters in the ProxyManagement group to configure proxy servers for web modules.
publishSIBWSInboundService command
Use the publishSIBWSInboundService command to publish to UDDI a service integration bus-enabled web services inbound service WSDL file.
RARUpdate command group
Use the resource adapter archive (RAR) update wizard to upgrade the RAR module and property configuration of J2C Resource Adapters. The application server uses the classes and other code that comprise a resource adapter archive to support the resource adapters that you configure.
recoverMEConfig command
Use the recoverMEConfig command to recover the configuration data of the failed or crashed messaging engine from the message store if there is no backup available. The message store could either be a database or file store system to which the previous messaging engine was connected to.
redeployLRS.py batch script
You can use the redeployLRS.py Jython script to redeploy the job scheduler on your deployment target.
refreshSIBWSInboundServiceWSDL command
Use the refreshSIBWSInboundServiceWSDL command to refresh a service integration bus-enabled web services inbound service WSDL file.
refreshSIBWSOutboundServiceWSDL command
Use the refreshSIBWSOutboundServiceWSDL command to refresh a service integration bus-enabled web services outbound service WSDL file.
removeGroupFromAllRoles command
Use the removeGroupFromAllRoles command to remove a group from all access roles for a local bus.
removeGroupFromBusConnectorRole command
Use the removeGroupFromBusConnectorRole command to remove a group from the connector role for a local bus.
removeGroupfromDefaultRole command
Use the removeGroupFromDefaultRole command to remove a group from the default roles for a local bus.
removeGroupFromDestinationRole command
Use the removeGroupFromDestinationRole command to remove a group from the destination roles for a local or foreign bus.
removeGroupFromForeignBusRole command
Use the removeGroupFromForeignBusRole command to remove a group from the sender role for a foreign bus.
removeGroupFromTopicRole command
Use the removeGroupFromTopicRole command to remove a group from a topic role within a specified topic space.
removeGroupFromTopicSpaceRootRole command
Use the removeGroupFromTopicSpaceRootRole command to remove a group from access roles on the topic space root.
removeMapPlatformSubject script
If you want to use distributed identity mapping for System Authorization Facility (SAF), use the removeMapPlatformSubject Jython script that is provided to remove the unnecessary Java Authentication and Authorization Service (JAAS) login module, MapPlatformSubject, from the security configuration.
removePGC.py batch script
You can use the removePGC.py Jython script to remove the common batch container from your deployment target.
removeSIBBootstrapMember command
Use the removeSIBBootstrapMember command to remove a nominated bootstrap member from a selected bus.
removeSIBPermittedChain command
Use the removeSIBPermittedChain command to remove a selected transport chain from the list of permitted transport chains for a selected service integration bus.
removeSIBusMember command
Use the removeSIBusMember command to remove a member from a service integration bus by using the wsadmin tool. A bus member can be an application server, an IBM MQ server, or a server cluster.
removeSIBWSInboundPort command
Use the removeSIBWSInboundPort command to remove a service integration bus-enabled web services inbound port.
removeSIBWSOutboundPort command
Use the removeSIBWSOutboundPort command to remove a service integration bus-enabled web services outbound port.
removeUserFromAllRoles command
Use the removeUserFromAllRoles command to remove a user from all access roles for a local bus.
removeUserFromBusConnectorRole command
Use the removeUserFromBusConnectorRole command to remove a user from the connector role for a local bus.
removeUserfromDefaultRole command
Use the removeGroupFromDefaultRole command from remove a user from the default roles for a local bus.
removeUserFromDestinationRole command
Use the removeUserFromDestinationRole command to remove a user from the destination roles for a local or foreign bus.
removeUserFromForeignBusRole command
Use the removeUserFromForeignBusRole command to remove a user from the sender role for a foreign bus.
removeUserFromTopicRole command
Use the removeUserFromTopicRole command to remove a user from a topic role within a specified topic space.
removeUserFromTopicSpaceRootRole command
Use the removeUserFromTopicSpaceRootRole command to remove a user from access roles on the topic space root.
removeWSGWTargetService command
Use the removeWSGWTargetService command to remove a target service from a gateway service configuration.
Removing authorization data by using the wsadmin tool
Use these commands to remove authorization data for the default roles, or for a destination or a foreign bus.
Removing users and groups by using the wsadmin tool
Use these commands to remove a user or group. Removing a user or group withdraws the authorization permissions for all roles to which they have previously been added.
RepositoryCheckpointCommands command group for the AdminTask object using wsadmin scripting
You can use the Jython or Jacl scripting language to create, restore, delete, and administer checkpoints with the wsadmin tool. Repository checkpoints represent saved images of the repository before configuration changes are made. The commands in the RepositoryCheckpointCommands group support the repository checkpoint functions in wsadmin local and connected modes.
Resource configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the mail, URL, and resource environment configuration scripts to create and configure resources in your environment. You can run each script individually or combine procedures to create custom automation scripts.
ResourceManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure resource providers with the wsadmin tool. The commands and parameters in the ResourceManagement group can be used to define and display properties for resource providers.
Ruleset administrative tasks
You can use the ruleset commands to add, remove, or modify rules and actions of the ruleset.xml file without using the administrative console.
SecureConversation command group for the AdminTask object (Deprecated)
Use this topic as a reference for the commands for the SecureConversation group of the AdminTask object. Use these commands with your administrative scripts to query, update, and remove secure conversation client cache configuration data.
SecurityConfigurationCommands command group for the AdminTask object
You can use the Jython scripting language to configure security with the wsadmin tool. Use the commands and parameters in the SecurityConfigurationCommands group to configure and manage user registries, single sign-on, data entries, trust association, login modules, and interceptors.
SecurityDomainCommands command group for the AdminTask object
You can use the Jython scripting language to configure and administer security domains with the wsadmin tool. Use the commands and parameters in the SecurityDomainCommands group to create and manage security domains, assign servers and clusters to security domains as resources, and to query the security domain configuration.
SecurityRealmInfoCommands command group for the AdminTask object
You can use the Jython scripting language to manage security realm configurations with the wsadmin tool. Use the commands and parameters in the SecurityRealmInfoCommands group to query and manage trusted realms.
Server administration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the application server scripts to delete, start, and stop servers. You can run each script individually or combine procedures to create custom automation scripts for your environment.
Server configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the application server scripts to create application servers, web servers, and generic servers. You can run each script individually, or combine procedures to create custom automation scripts for your environment.
ServerManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the ServerManagement group can be used to create and manage application server, web server, proxy server, generic server and Java virtual machine (JVM) configurations.
Server query scripts
The scripting library provides multiple script procedures to automate your server configurations. See the usage information for scripts that query your application server configuration. You can run each script individually, or combine procedures to create custom automation scripts for your environment.
serverQuiesce.py script
You can use the serverQuiesce.py script to decrease workload to a Session Initiation Protocol (SIP) container over an interval, and optionally stop the server. You can also cancel the quiesce during a set time interval if certain conditions are met.
Server settings configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the application server scripts to configure class loaders, Java Virtual Machine (JVM) settings, Enterprise JavaBeans (EJB) containers, performance monitoring, dynamic cache, and so on. You can run each script individually, or combine procedures to create custom automation scripts for your environment.
servicepolicy.py script
You can use the servicepolicy.py script to perform operations on service policies from the command line, such as creating service policies, removing service policies, and editing transaction classes.
setClientDynamicPolicyControl command
Use the setClientDynamicPolicyControl command to set how an application that is a web services client obtains the policy configuration of a web services provider. You can set, refresh, or remove this information about how a provider policy is obtained.
setDefaultSIBWSOutboundPort command
Use the setDefaultSIBWSOutboundPort command to set the default service integration bus-enabled web services outbound port.
setProviderPolicySharingInfo command
Use the setProviderPolicySharingInfo command to set how an application or service that is a web service provider can share its policy configuration with other clients, service registries, or services that support the WS-Policy specification. You can set or remove this information about how a provider policy is shared.
showJAXWSHandler command
Use the showJAXWSHandler command to show the properties of a Java API for XML-based Web Services (JAX-WS) handler that is configured for use (as part of a handler list) with Version 7.0 WS-Notification services.
showJAXWSHandlerList command
Use the showJAXWSHandlerList command to show the properties of a Java API for XML-based Web Services (JAX-WS) handler list that is configured for use with Version 7.0 WS-Notification services.
showSIBDestination command
Use the showSIBDestination command to list the property values for a bus destination.
showSIBEngine command
Use the showSIBEngine command to list properties of a messaging engine for a service integration bus member.
showSIBForeignBus command
Use the showSIBForeignBus command to show the properties of a foreign bus.
showSIBJMSActivationSpec command
Use the showSIBJMSActivationSpec command to show properties of a JMS activation specification for the default messaging provider at a specific scope.
showSIBJMSConnectionFactory command
Use the showSIBJMSConnectionFactory command to show the properties of a JMS connection factory for the default messaging provider at a specific scope.
showSIBJMSQueue command
Use the showSIBJMSQueue command to show properties of a JMS queue for the default messaging provider at a specific scope.
showSIBJMSTopic command
Use the showSIBJMSTopic command to show properties of a JMS topic for the default messaging provider at a specific scope.
showSIBLink command
Use the showSIBLink command to show the properties of a service integration bus link.
showSIBMediation command
Use the showSIBMediation command to list the property values for a mediation.
showSIBMQLink command
Use the showSIBMQLink command to show the properties of a IBM MQ link.
showSIBus command
Use the showSIBus command to show the properties of a service integration bus.
showSIBusMember command
Use the showSIBusMember command to show the properties of a service integration bus member.
showSIBWMQServerBusMember command
Use the showSIBWMQServerBusMember command to show a list of attributes for a IBM MQ server bus member.
showSIBWMQServer command
Use the showSIBWMQServer command to show details of a IBM MQ server.
showWMQActivationSpec command
Use the showWMQActivationSpec command to display information about a specific IBM MQ messaging provider activation specification.
showWMQ command
Use the showWMQ command to show the settings which can be set by the manageWMQ command.
showWMQConnectionFactory command
Use the showWMQConnectionFactory command to display information about a specific IBM MQ messaging provider connection factory.
showWMQQueue command
Use the showWMQQueue command to display information about a specific WebSphere MQ messaging provider queue type destination.
showWMQTopic command
Use the showWMQTopic command to display information about a specific IBM MQ messaging provider topic.
showWSNAdministeredSubscriber command
Use the showWSNAdministeredSubscriber command to show the properties of an administered subscriber. An administered subscriber provides a mechanism for the WS-Notification service point to subscribe to an external notification producer at server startup time.
showWSNService command
Use the showWSNService command to show the properties of a WS-Notification service. A WS-Notification service provides access to service integration bus resources for web services publish and subscribe clients.
showWSNServicePoint command
Use the showWSNServicePoint command to show the properties of a WS-Notification service point. A WS-Notification service point defines access to a WS-Notification service on a given bus member through a specified web service binding (for example SOAP over HTTP). Applications use the bus members associated with the WS-Notification service point to connect to the WS-Notification service.
showWSNTopicDocument command
A topic namespace can optionally have topic namespace documents applied to it that define the structure of the topics that are permitted within the namespace. Use the showWSNTopicDocument command to show the contents of a WS-Notification topic namespace document.
showWSNTopicNamespace command
Use the showWSNTopicNamespace command to show the properties of a WS-Notification topic namespace. A topic namespace is a grouping of topics that allows information to be shared between applications.You use a permanent topic namespace to statically define the association between a WS-Notification topic namespace URI and a service integration bus topic space destination.
SIBAdminBusSecurityCommands command group for the AdminTask object
You can use these administrative commands to manage service integration bus security.
SIBAdminCommands: Bus administrative commands for the AdminTask object
You can use these administrative commands to manage service integration buses.
SIBAdminCommands: Bus link administrative commands for the AdminTask object
You can use these administrative commands to manage service integration bus links. A service integration bus link defines a link between a messaging engine in one service integration bus and a messaging engine in a foreign service integration bus.
SIBAdminCommands: Destination administrative commands for the AdminTask object
You can use these administrative commands to manage bus destinations.
SIBAdminCommands: Foreign bus administrative commands for the AdminTask object
You can use these administrative commands to manage foreign buses. A foreign bus represents a service integration bus with which another service integration bus can exchange messages.
SIBAdminCommands: Mediation administrative commands for the AdminTask object
You can use these administrative commands to manage mediations.
SIBAdminCommands: Messaging engine administrative commands for the AdminTask object
You can use these administrative commands to manage messaging engines.
SIBAdminCommands: IBM MQ link administrative commands for the AdminTask object
You can use these administrative commands to manage IBM MQ links. A IBM MQ link connects a messaging engine as a queue manager to IBM MQ, thereby providing a bridge between a service integration bus and an IBM MQ network.
SIBAdminCommands: IBM MQ server administrative commands for the AdminTask object
Use command scripts to create, modify, list, show and delete IBM MQ servers and server bus members. These commands do not support the automatic resource discovery feature provided by the administrative console.
SIBJMSAdminCommands command group for the AdminTask object
You can use these administrative commands to manage JMS resources for the default messaging provider.
SIBWebServices command group for the AdminTask object
Use command scripts to configure service integration bus-enabled web services.
SignerCertificateCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the SignerCertificateCommands group can be used to create and modify signer certificates in relation to the key store file and to query for signer information on ports of remote hosts.
SpnegoTAICommands group for the AdminTask object (deprecated)
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the SpnegoTAICommands group can be used to create and manage configurations that are used by the Simple and Protected GSS-API Negotiation Mechanism (SPNEGO) trust association interceptor (TAI).
SPNEGO web authentication configuration commands
Use wsadmin commands to configure, unconfigure, validate, or display Simple and Protected GSS-API Negotiation Mechanism (SPNEGO) in the security configuration.
SPNEGO web authentication filter commands
Use wsadmin commands to add, modify, delete, or show Simple and Protected GSS-API Negotiation Mechanism (SPNEGO) Web authentication filters in the security configuration.
SSLConfigCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the SSLConfigCommands group can be used to create and manage Secure Sockets Layer (SSL) configurations and properties.
SSLConfigGroupCommands group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the SSLConfigGroupCommands group can be used to create and manage SSL configuration groups.
SSLMigrationCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to migrate key store configurations. Use the commands in the SSLMigrationCommands group to convert self-signed certificates to chained personal certificates and to enable writable key rings.
SSLTransport policy and binding properties
Use the -attributes parameter for the setPolicyType and setBinding commands to specify additional configuration information for the SSLTransport policy and policy set binding. Application and system policy sets can use the SSLTransport policy and binding.
STSManagement command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the STSManagement group can be used to manage and query trust service token provider configurations and endpoint configurations.
TAMConfig command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure embedded IBM Tivoli® Access Manager with the wsadmin tool. The commands and parameters in the TAMConfig group can be used to configure or unconfigure Tivoli Access Manager.
TargetGroup command group for the AdminTask object using wsadmin scripting (deprecated)
You can use the Jython scripting language to configure target groups with the wsadmin tool. Use the commands and parameters in the TargetGroup command group to create and manage target groups. Create target groups to submit jobs from the job manager to one or many targets. Commands in the TargetGroup command group provide function that replaces deprecated commands in the ManagedNodeGroup command group.
The Kerberos configuration file
The Kerberos configuration properties, krb5.ini or krb5.conf files, must be configured on every WebSphere Application Server instance in a cell in order to use the Simple and Protected GSS-API Negotiation Mechanism (SPNEGO) trust association interceptor (TAI) for WebSphere Application Server.
TrustManagerCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the TrustManagerCommands group can be used to create, delete, and query trust manager settings in your configuration. You can also use these commands to create a custom trust manager for a pure client.
unlinkCells|unlinkCellsZOS script
You can use unlinkCells script to disable the overlay communication between multiple cells. On z/OS systems, use unlinkCellsZOS.
UnmanagedNodeCommands command group for the AdminTask object using wsadmin scripting
You can use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the UnmanagedNodeCommands group can be used to create and query for managed and unmanaged nodes. An unmanaged node is a node that does not have a node agent or a deployment manager.
unmediateSIBDestination command
Use the unmediateSIBDestination command to remove a mediation from a service integration bus destination.
unpublishSIBWSInboundService command
Use the unpublishSIBWSInboundService command to remove from UDDI a service integration bus-enabled web services inbound service WSDL file.
updateZOSStartArgs script
If you are running the product on z/OS Version 1.9 or higher, you can use the updateZOSStartArgs script that is provided with the product to control for which of your servers, z/OS can reuse address space identifiers (ASIDs) that are associated with cross-process services when those services end.
Usage table for the options of the AdminApp object install, installInteractive, update, updateInteractive, edit, and editInteractive commands using wsadmin scripting
This table lists all of the options available for the install, installInteractive, update, updateInteractive, edit, and editInteractive commands of the AdminApp object.
useBBSON.py script
Intelligent Management uses the bulletin board service overlay network (BBSON) by default, which alleviates the dependency on the WebSphere Application Server Network Deployment (ND) high availability manager and its required core group configuration. Run useBBSON.py to disable the usage of BBSON, enabling the ND high availability manager instead. You can also use the script to enable BBSON if it was previously disabled.
Utility command group of the AdminTask object
You can use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the Utility group can be used to change the host name of a node, to query for the name of the deployment manager, and to determine if the system is a single server or network deployment.
Utility scripts
The scripting library provides multiple script procedures to automate your application configurations. See the usage information for scripts that set notification options, save configuration changes, and display scripting library information.
VariableConfiguration command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure servers with the wsadmin tool. The commands and parameters in the VariableConfiguration group can be used to remove variable definitions from the system, to set values for variables, or to query for variable values with a specific scope.
WebServicesAdmin command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. Use the commands in the WebServicesAdmin group to list all web services, service references and attributes, find attributes of a specific web service, determine the web service endpoint, and determine the operation name of a Web service.
WIMManagementCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the WIMManagementCommands group can be used to create and manage groups, members, and users in the virtual member manager.
WMQAdminCommands command group for the AdminTask object
You can use the IBM MQ administrative commands to manage JMS resources for the IBM MQ messaging provider.
workclassoperations.py script
You can use the workclassoperations.py script to create, update, and manage work classes.
WSAddressing policy and binding properties
Use the -attributes parameter for the setPolicyType and setBinding commands to specify additional configuration information for the WSAddressing policy and policy set binding. Application and system policy sets use the WSAddressing policy and binding.
wsadmin (Jython) scripting procedures for CEA
The Communications Enabled Applications (CEA) samples package includes a wsadmin (Jython) script library to simplify the development and testing of scripts to automate related configuration changes. The script library is provided as a samples, and as such, IBM has no obligation to provide maintenance, support, updates, enhancements or modifications.
wsadmin scripting tool
The wsadmin tool runs scripts. You can use the wsadmin tool to manage application servers as well as the configuration, application deployment, and server runtime operations.
wsadmin tool performance tips
Follow these tips to get the best performance from the wsadmin tool.
WSCertExpMonitorCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the WSCertExpMonitorCommands group can be used to start or update the certificate expiration monitor.
WSGateway command group for the AdminTask object
wsgridConfig.py batch script
Use the wsgridConfig.py script to configure the three steps that are required for configuring the external scheduler interface.
WSNotificationCommands command group for the AdminTask object
WSNotifierCommands command group for the AdminTask object
You can use the Jython or Jacl scripting languages to configure deployed applications with the wsadmin tool. The commands and parameters in the WSNotifierCommands group can be used to create and manage notifications settings. WS-Notification enables web services to use the publish and subscribe messaging pattern, creating a one-to-many message distribution pattern.
WS-Policy commands for the AdminTask object
You can manage WS-Policy settings for web service resources by using wsadmin scripting. You can view or manage how a service provider shares its policies, and how a service client obtains and applies the policies of a service provider.
WSReliableMessaging policy and binding properties
Use the attributes parameter for the setPolicyType and setBinding commands to specify additional configuration information for the ReliableMessaging policy and policy set binding. The WSReliableMessaging quality of service (QoS) is only available for application policy sets.
WSSCacheManagement command group for the AdminTask object
Use this topic as a reference for the commands for the WSSCacheManagement group of the AdminTask object. Use these commands with your administrative scripts to query, update, and remove distributed cache configuration data.
WSScheduleCommands command group of the AdminTask object
You can use the Jython or Jacl scripting languages to manage deployed applications with the wsadmin tool. The commands and parameters in the WSScheduleCommands group can be used to create and manage scheduler settings in your configuration. Schedulers enable J2EE application tasks to run at a requested time.
WSSecurity policy and binding properties
Use the attributes parameter for the setPolicyType and setBinding commands to specify additional configuration information for the WSSecurity policy and binding configurations. Application and system policy sets can use the WSSecurity policy and binding configuration.
wve_encodePassword script
You can use the wve_encodePassword script to encode a password value that you enter in the administrative console. By encoding your password, you can prevent the password from being shared.