Enable or Disable deployment in WildFly or EAP

Octopus.WildFlyState exported 2026-07-22 by Octopus Deploy belongs to ‘JavaAppServer’ category.

Enable or disable an application in WildFly 10+ or Red Hat JBoss EAP 6+.

Parameters

When this step is included in a project’s deployment process, the parameters below can be set.

Management host or IP

WildFly.Deploy.Controller (required)

The hostname or IP address of the application server hosting the application to be enabled or disabled. This value is relative to the host that is executing the step.

Default: localhost

Example: localhost

Management port

WildFly.Deploy.Port (required)

The management port that the application server is listening to. For WildFly 10+ and Red Hat JBoss EAP 7+, the default is 9990. For Red Hat JBoss EAP 6, the default is 9999.

Default: 9990

Example: 9990

Management protocol

WildFly.Deploy.Protocol (required)

The management protocol that the application server is listening to. For WildFly 10+ and Red Hat JBoss EAP 7+, the default is remote+http. For Red Hat JBoss EAP 6, the default is remoting.

Default: remote+http

Example: remote+http

Management user

WildFly.Deploy.User

The username to use with the management interface. Typically configured via the add-user script. By default WildFly does not require credentials for local connections.

Management password

WildFly.Deploy.Password

The password to use with the management interface. By default WildFly does not require credentials for local connections.

Deployment name

WildFly.Deploy.Name (required)

The name of the deployment to enable or disable.

Standalone or Domain Server

WildFly.Deploy.ServerType

Select the kind of server you are deploying to.

Allowed values: Standalone, Domain

Default: Standalone

Enable the deployment

WildFly.Deploy.Enabled

Whether to enable or disable the application on a standalone server. This value has no effect when deploying to domain servers.

Allowed values: True, False

Default: True

Enabled server groups

WildFly.Deploy.EnabledServerGroup

A comma-separated list that defines the domain server groups where the deployment will be enabled. This value is ignored when deploying to a standalone instance.

Disabled server groups

WildFly.Deploy.DisabledServerGroup

A comma-separated list that defines the domain server groups where the deployment will be disabled. This value is ignored when deploying to a standalone instance.

Step configuration using OCL

Example in Octopus Configuration Language (OCL):

step "enable-wildfly-app" {
    name = "Enable WildFly App"
    properties = {
        Octopus.Action.TargetRoles = "wildfly-server"
    }

    action {
        action_type = "Octopus.WildFlyState"
        properties = {
            Octopus.Action.RunOnServer = "false"
            WildFly.Deploy.Controller = "localhost"
            WildFly.Deploy.Enabled = "True"
            WildFly.Deploy.Name = "myapp.war"
            WildFly.Deploy.Port = "9990"
            WildFly.Deploy.Protocol = "remote+http"
            WildFly.Deploy.ServerType = "Standalone"
        }
    }
}

Page updated on Wednesday, July 22, 2026