Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, z/OS
PlacementControllerProcs.jacl script
You can use the PlacementControllerProcs.jacl script to modify the application placement runtime configuration.
Purpose
Depending on your administrative role, you are allowed specific privileges when configuring the autonomic managers. To use this script to configure the autonomic managers, have administrator privileges. The PlacementControllerProcs.jacl script is provided with WebSphere XD. At installation time, the script is copied onto the installation target machine in the install_root\bin directory. Use the PlacementControllerProcs.jacl script to modify an entire series of application placement controller configuration options. With the PlacementControllerProcs.jacl script you can perform the following operations on the runtime configuration:
- Enable or disable the application placement controller
- Make the specified node managed or unmanaged by the application placement controller
- Enable or disable a dynamic cluster
- Get or set the values of apditional settings
This script modifies only the runtime configuration of the application placement controller. To make persistent changes to the configuration, use the xd_APCconfig.jacl script.
Usage
To run the PlacementControllerProcs.jacl script with the wsadmin utility, use the following command:wsadmin -profile PlacementControllerProcs.jacl -c "insert_proc_parameters"In place of the insert_proc_parameters variable, use the name of the procedure and the proper variable values to complete your changes. You must enclose the procedures in quotation marks ("). You might have to modify the wsadmin command to wsadmin.sh or wsadmin.bat, depending upon your operating environment. You can also launch the scripting client first. In the wsadmin utility, type:wsadmin> source PlacementControllerProcs.jacl wsadmin> procedure variablesIn place of procedure, insert the procedure. In place of variables, provide the variables to support your procedure.
Procedures
You can use the following command to see a list of all the available procedures:wsadmin -profile PlacementControllerProcs.jacl -c "help" The following procedures are available:
- anyFailedServerOperations
- Displays a list of failed starts by servers that the application placement controller tried to start.
- closeLockMultiAPCGate removeAPCID
- Closes and locks a gate for a multiple application placement controller setup.
- deferFailedServerOperations
- Disables the enablement of maintenance mode on any servers that failed to start by the application placement controller.
- disable
- Disables the application placement controller.
- disableDynamicCluster dynamic_cluster_name
- Sets the specified dynamic cluster to run manually.
- disableNode node_name
- Makes the specified node unmanaged by the application placement controller.
- enable
- Enables the application placement controller.
- enableDynamicCluster dynamic_cluster_name
- Sets the specified dynamic cluster to run automatically.
- enableNode node_name
- Enables the application placement controller for the specified node.
- findBestLocation cell_name node_name server_name
- Returns the best location to stop a server for placement. This procedure returns one of the following values:
- null: You can stop the server that was passed into the procedure without problems.
- server name: You should not stop the server name that you passed into the procedure.
- alternate server name: If the name of another server is returned, you should stop that server first.
- getApprovalTimeOut
- When running in supervised mode, returns the amount of time to wait for an administrator to approve a task before the task times out.
- getMinTimeBetweenPlacementChange
- Returns the minimum time between two consecutive placement changes.
- getNodeName
- Displays the node on which the application placement controller is running.
- getServerOperationTimeOut
- Returns the amount of time after which the start and stop operation that is performed on the server is considered a failure, if not completed.
- handleFailedServerOperations
- Places any servers into maintenance mode that did not start when the application placement controller tried to start the server.
- isNodeInUse node_name
- Checks if a node is still in use after it is in maintenance mode.
- isPrimary
- Returns if this node is the primary node where the application placement controller is running.
- isEnabled
- Returns if the application placement controller is enabled.
- openMultiAPCGate remoteAPCID
- Opens the gate for a multiple application placement controller setup.
- recomputePlacement
- Triggers the application placement controller to compute its optimization and perform any necessary placement changes.
- setMinTimeBetweenPlacementChange time
- Sets the minimum time, in minutes, between two consecutive placement changes.
- setServerOperationTimeOut timeout
- Sets the timeout, in minutes, after which the start or stop operation that is performed on the server is considered a failure, if not completed.
- setApprovalTimeOut approval_timeout
- Sets the amount of time, in minutes, to wait for the administrator approval when operating in supervised mode before considering the task denied.
- unlockMultiAPCGate remoteAPCID
- Unlocks the gate for a multiple application placement controller setup.
Related concepts
Overview of application placement
Related tasks
Configure dynamic application placement
Monitor and tuning the application placement controller
Related reference
Administrative roles and privileges