undeploy(Mule)
- Karl Henselin
- Ben Hoffman
- Rama Rimmalapudi
The undeploy operation undeploys a Mule Application. It can be used in deploy workflows. It requires that the artifact used to deploy the application be present so that it can be determined whether it is an application or domain which is being undeployed.
This operation is compatible with the following types of servers:
| FDMULE_TYPE | Notes Specific to the FDMULE_TYPE |
|---|---|
| CloudHub | |
| Anypoint Runtime Manager | |
| Runtime Agent | |
| Standalone | This operation runs on the Mule server endpoint(s). In order to undeploy an application from an entire cluster, set up multiple instances or endpoints. The operation will be run on all of them so the application will be removed from all of the cluster members. |
 Â
Environment/Instance Properties
Property Name | Property Code | Required for which Mule Type | Description |
|---|---|---|---|
Mule Home | FDMULE_HOME | Standalone | Path to the Mule Standalone Install |
| Anypoint Username | FDMULE_USER | CloudHub, Anypoint Runtime Manager | Anypoint Platform Username |
| Anypoint Password | FDMULE_PASSWORD | CloudHub, Anypoint Runtime Manager | Anypoint Platform Password |
| Mule Type | FDMULE_TYPE | All | The type Mule server that this environment includes. (CloudHub, Anypoint Runtime Manager, Runtime Agent, Standalone) |
| Organization Name | FDMULE_ORG_NAME | CloudHub, Anypoint Runtime Manager | Mule Organization Name |
| Environment Name | FDMULE_ENV_NAME | CloudHub, Anypoint Runtime Manager | Mule Environment Name Defaults to |
| Timeout in Milliseconds | FDMULE_TIMEOUT | None | Timeout for deployment and utility operations such as start and stop application. Defaults to 600000 which is 10 minutes. |
| Anypoint URL | FDMULE_ANYPOINT_URL | CloudHub, Anypoint Runtime Manager | The URL of Anypoint Runtime Manager Defaults to https://anypoint.mulesoft.com |
| Runtime Agent URL | FDMULE_AGENT_URL | Runtime Agent | The URL of Runtime Agent |
| Mule Region Code | FDMULE_REGION | None. Used for CloudHub, but optional | Region Code for Mule |
 Â
Project Properties
Property Name | Property Code | Required for which Mule Type | Description |
|---|---|---|---|
Mule Application Name | FDMULE_APP_NAME | All | Name of the Mule Application to stop |
| Target Type | FDMULE_TARGET_TYPE | Anypoint Runtime Manager | Mule Target Server Type (Server, Cluster, ServerGroup) If necessary, this property can be overridden at the property/environment/instance level. |
| Target Name | FDMULE_TARGET_NAME | Anypoint Runtime Manager | Name for the Target Server, Cluster or Group If necessary, this property can be overridden at the property/environment/instance level. |
| Static IP Address | FDMULE_STATIC_IPADDRESS | None. Used for CloudHub, but optional | Static IP Address for the Application If necessary, this property can be overridden at the property/environment/instance level. |
 Â
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
 Â
Outputs
Output Name | Required | Description |
|---|---|---|
 Â
Artifacts
This operation consumes Mule Application and Domain artifacts from the artifacts repository.
 Â
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
 Â
Endpoint Execution
This operation will execute on all of the selected endpoints.
- style