> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# suspendServer

> This operation signals a running WildFly server or server groups to suspend. The suspendServer operation can be used for both Standalone and Domain mo

* This operation signals a running WildFly server or server groups to suspend.

* The suspendServer operation can be used for both Standalone and Domain mode.

* This operation is supported starting with **WildFly 9.0.2 and above only**.

# Target Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>WildFly Home</td><td>`FDWFLY_WILDFLY_HOME`</td><td>Yes</td><td>The pathname to the directory in which WildFly has been installed.</td></tr><tr><td>WildFly Admin Listen Address</td><td>`FDWFLY_ADMIN_LISTEN_ADDRESS`</td><td>Yes</td><td>The url of the Manager web application within the WildFly server.</td></tr><tr><td>WildFly Admin Listen Port</td><td>`FDWFLY_ADMIN_LISTEN_PORT`</td><td>Yes</td><td>The port number of the manager web application within the WildFly server.</td></tr><tr><td>WildFly Admin User</td><td>`FDWFLY_ADMIN_USER`</td><td>Yes</td><td>The name of the WildFly user with which to connect to the Manager web application. This user must be configured with the add-user script file.</td></tr><tr><td>WildFly Admin Password</td><td>`FDWFLY_ADMIN_PASSWORD`</td><td>Yes</td><td>The password for the **WildFly Admin User**.</td></tr></tbody></table>

# Project Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>WildFly Server</td><td>`FDWFLY_SERVER_NAME`</td><td>No</td><td>WildFly Server name to activate application on.</td></tr><tr><td>WildFly Server Group</td><td>`FDWFLY_SERVER_GROUP_NAME`</td><td>No</td><td>WildFly Server Group name to activate application on.</td></tr></tbody></table>

# Inputs

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Input Name**</th><th>**Input Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>WildFly Mode</td><td>`FDWFLY_INP_WILDFLY_MODE`</td><td>Yes</td><td>The mode in which server has been started. Valid values are Standalone, Domain</td></tr><tr><td>WildFly Host Name</td><td>`FDWFLY_INP_WILDFLY_HOST_NAME`</td><td>\*</td><td>WildFly server host name which the server resides on.\*Required if resuming a Server, ignored if resuming a Server Group.</td></tr><tr><td>Server Name</td><td>`FDWFLY_INP_SERVER_NAME`</td><td>No</td><td>WildFly server name for suspend operation. Overrides the `WildFly Server` project property.</td></tr><tr><td>Server Group Name</td><td>`FDWFLY_INP_SERVER_GROUP_NAME`</td><td>No</td><td>WildFly server group name for suspend operation. Overrides the `WildFly Server Group` project property.</td></tr></tbody></table>

# Artifacts

This operation doesn't consume or produce any artifacts.

# Endpoint Selection

This operation will select all available endpoints associated to the Target which have a resource type of **WildFly Management Server**. For Standalone mode, this is the single endpoint which is mapped to the Target.  For Domain mode, this is the endpoint which hosts the Domain Controller.

# Endpoint Execution

This operation will execute on the endpoint selected above (the one which is identified as the WildFly Management Server).

# Special Considerations

This plugin has the following prerequisites:

* The WildFly user specified by the **WildFly Admin User** property must be granted the add-user script.

* The target WildFly server must be running prior to calling this operation.