Program guide > (deprecated) Partitioning facility > Manage the partitioning facility environment
Deprecated feature: The partitioning facility (WPF) feature is deprecated. You can configure partitioning with WebSphere eXtreme Scale.
Management script wpfadmin and usage
The wpfadmin is a python script that allows the user to perform several administrative operations on a cluster. This script is meant not only for customer use, but it also provides programming examples, allowing them to create their own automation command library.
The script calls a HA manager MBean (JMXCoordinator), which then calls directly to the HA Manager runtime support to perform the operations as, described above. The following is the list of operations to be supported in the wpfadmin script, along with specific usage scenarios.
The application WPFKeyBasedPartitionSample is installed to a two node cluster with 30 partitions divided into two classifications: PK000001 - PK000010, which belongs to class1, and PK000011 - PK000030, which belongs to class2. The system wpfsample3 is the deployment manager and has four application servers, and wpfsample2 has five application servers.
In the examples that follow, the wpfadmin command is run to demonstrate example invocations. On the Windows platforms, the wpfadmin.bat application can be used, and referenced on the command line as wpfadmin. The command functions identically across all supported platforms unless documented otherwise for a specific command. When dealing with a large number of partitions, some wpfadmin commands might get OutOfMemory exceptions.
To fix, edit the <WAS_INSTALL_ROOT>/bin/wsadmin.bat (wsadmin.sh on Unix), and increase the -mx256m option for the platform you are running on to -mx512m.
- Management parameters
- Retrive statistics on partitioned applications
Use the following python script to perform administrative operations in the environment.
- listActive
The listActive parameter displays the application servers hosting active partitions. This command can be scoped to display information for a particular application, partition, and classification.
- listActiveWithGroups
The listActiveWithGroups parameter displays the application servers which are active for the set of groups defined by the matchset parameter passed in.
- countActivePartitionsOnServers
The countActivePartitionsOnServers parameter counts the number of partitions on all servers. This command is scoped to only show information for a particular application, partition, and classification.
- countActiveGroupsOnServers
The command countActiveGroupsOnServers counts the number of groups that match the matchset parameter on all servers
- list
The list parameter displays a list of the partitions and the status of the member servers. This command can be scoped to only show information for a particular application, partition, and classification.
- listGroups
The listGroups parameter displays the groups and the status of the members.
- coreGroupStatus
The coreGroupStatus parameter shows the core group name, coordinator names, and active servers in the core group.
- move
The move parameter relocates one partition to another server.
- balance
The balance parameter balances partitions across the set of active servers. If you specify the -id option, only the partitions for which PMI statistics are gathered relative to the ID specified will be balanced.
- disablePartition
The disablePartition parameter disables a partition. Depending on how policies are configured, the partition will either be enabled on another server, or will just be disabled.
- enablePartition
The enablePartition parameter enables a partition.
- addServerToCoreGroup
The addServerToCoreGroup parameter adds the specified server from the DefaultCoreGroup. This command modifies the coregroup.xml located in the <ND_install_root>/config/cells/<cell_name>/coregroups/DefaultCoreGroup directory.
- removeServerFromCoreGroup
The removeServerFromCoreGroup parameter deletes the specified server from the DefaultCoreGroup. This command modifies the coregroup.xml located in the <ND_install_root>/config/cells/<cell_name>/coregroups/DefaultCoreGroup directory.
- enableWPFPMI
The enableWPFPMI parameter enables the WPF PMI module for all active servers.
- subscribeWPFPMI
The subscribeWPFPMI parameter subscribes the asynchronous PMI module for the partitioning facility (WPF).
- setPartitionCount
The command setPartitionCount tells the aggregator server how many partitions to keep PMI statistics for in the bulletin board. For example, if there are 10,000 partitions in the cluster, and the aggregator partition count is set to 20, the top 20 partitions in terms of transaction count and response times will be stored in the bulletin board.
- setStatisticsRange
The setStatisticsRange parameter tells Async PMI to gather statistics cumulatively, or to reset the statistics after each aggregator interval time period. The options are either cumulative or active.
- setEJBName
The setEJBName parameter tells PMI to gather statistics for the specified application.
- setStatisticsType
The setStatisticsType parameter tells Async PMI to gather statistics for transaction count or response time.
- setStatisticsInterval
The setStatisticsInterval parameter determines the interval, in milliseconds, the aggregator server waits between aggregations.
- getTransactionCount
The getTransactionCount parameter returns the latest aggregated data for each of the partitions from the bulletin board regarding the number of transactions processed in the aggregator interval. The number of partitions for which data will be returned is set using the setPartitionCount command.
- getResponseTime
The getResponseTime parameter returns the latest aggregated data for each of the partitions from the bulletin board regarding the response time of transactions processed in the aggregator interval, along with the minimum, maximum, and average response time.
- getFailedTransactionCount
The getFailedTransactionCount parameter returns the latest aggregated data for each of the partitions from the bulletin board regarding the number of failed transactions processed in the aggregator interval.
- setTraceSpec
The setTraceSpec command is used during problem determination and sets the trace specification. With the temp option, the new trace specification only works if the servers are running. If the servers are restarted, the trace specification goes away. With the perm option, the new trace specification is set permanently. But if the servers are started, the new trace specification does not take effect until the servers are restarted.
- unsubscribeWPFPMI
The unsubscribeWPFPMI parameter notifies the server to stop collecting the partitioning facility (WPF) Async PMI data when not needed.
- disableWPFPMI
The disableWPFPMI parameter disables the partitioning facility (WPF) PMI module.
- createPolicy
The createPolicy parameter is used to create a policy.
- createMultiplePolicies
You can create multiple policies using this command.
- updatePolicy
With the updatePolicy parameter, you can update any or all of the attributes of the specified policy.
- deletePolicy
Use the deletePolicy parameter to delete the specified policy from the DefaultCoreGroup.
- updateJMXTimeout
The updateJMXTimeout parameter sets the timeout value for JMX commands. This modifies the coregroup.xml file in <ND_install_root>/config/cells/<cell_name>/coregroups/DefaultCoreGroup directory.
- updateCoreGroupCoordinators
The updateCoreGroupCoordinators parameter allows you to adjust number of coordinators for the core group as well as the preferred coordinator servers list. This modifies the coregroup.xml file in <ND_install_root>/config/cells/<cell_name>/coregroups/DefaultCoreGroup directory.
- updateHamConfig
The updateHamConfig parameter changes the buffer or maxThreads size for a server (specified by --s), cluster (specified by --c), or cell (specified by --cell).
- listPolicies
The listPolicies parameter lists the name of all of the policies in the core group.
- queryPolicy
The queryPolicy parameter shows the attributes of the given policy.
- resolvePolicyForGroup
The resolvePolicyForGroup parameter shows the name of the policy for each partition.
Parent topic:
Manage the partitioning facility environment
Related concepts
Related tasks
Manage the partitioning facility environment
Related reference
Retrive statistics on partitioned applications