Uninstall Component#

Use this step to uninstall the selected component.


Applications, components, and generic processes share some process steps. This step applies only to application processes.

It is up to you to select an appropriate component process to run. In most cases, select a component process of the Uninstall type. If you select a different type of component process, you might get results that you do not expect. The server runs whatever component process you select, even if that process does not uninstall the component. For example, if you select a component process of the Deployment type, the Uninstall Component step runs that component process as usual. Then, the component process deploys the component and adds the component to the inventory.

Field Description
Name A name for the step. Other process steps can refer to this step by this name.
Component Component that is used by the step; a step can affect a single component. All components that are associated with the application are available. To uninstall more than one component, add another uninstall step to the process.
Remove Versions with Status Restricts the component versions that are affected by the step. Only versions with the selected status are affected. By default, the status Active refers to versions that are currently deployed.
Component Process The component process to run.
Limit to Resource Tag The user-defined resource tag that determines which resource runs the process. Only a resource with this tag, or a resource that has a parent with this tag, runs the process. See Adding tags to objects.
Uninstall Type The All Existing option removes all the versions of this component that are in the inventory. The All Selected For Process option removes only the versions that you specify when you start the application process.
Maximum number of concurrent processes The maximum number of concurrent processes to run. This setting limits the number of processes that run simultaneously to uninstall component instances. For example, if you set the maximum number of concurrent processes to 2, only two instances of the component are uninstalled at a time, even if many instances of the component are currently installed. To run an unlimited number of concurrent processes, specify -1. To limit the number of processes to run at once, as in rolling deployments, specify an integer.The server attempts to resolve the value to an integer. If the value does not resolve to an integer, then the -1 value is used by default. You can use a property in this field, as long as the property resolves to an integer.

Note: The maximum number of component processes that can run concurrently is limited by the hardware that hosts the agent.

| |Fail Fast|If this check box is selected, the step does not start more processes after one process fails.| |Precondition |A JavaScript 1.7 script that defines a condition that must exist before the step can run. The condition must resolve to true or false. In the script, do not use the ${p:component.myProperty} notation. For example, to check the value of a component property in a component process, use properties.get("myProperty") == "myValue". See Property contexts for information about property access.|

Parent topic: Process steps: Reference