suspendServer
- Copy Page Tree
- Ben Hoffman
- Karl Henselin
- Erick Jones
- 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.
Environment/Instance Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| WildFly Home |
| Yes | The pathname to the directory in which WildFly has been installed. |
| WildFly Admin Listen Address |
| Yes | The url of the Manager web application within the WildFly server. |
| WildFly Admin Listen Port |
| Yes | The port number of the manager web application within the WildFly server. |
| WildFly Admin User |
| Yes | 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. |
| WildFly Admin Password |
| Yes | The password for the WildFly Admin User. |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
| WildFly Server |
| No | WildFly Server name to activate application on. |
| WildFly Server Group |
| No | WildFly Server Group name to activate application on. |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| WildFly Mode |
| Yes | The mode in which server has been started. Valid values are Standalone, Domain |
| WildFly Host Name |
| * | WildFly server host name which the server resides on. *Required if resuming a Server, ignored if resuming a Server Group. |
| Server Name | FDWFLY_INP_SERVER_NAME | No | WildFly server name for suspend operation. Overrides the |
| Server Group Name | FDWFLY_INP_SERVER_GROUP_NAME | No | WildFly server group name for suspend operation. Overrides the |
Outputs
Output Name | Required | Description |
|---|---|---|
Artifacts
This operation doesn't consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the Environment/Instance which have a resource type of WildFly Management Server. For Standalone mode, this is the single endpoint which is mapped to the Environment/Instance. 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.
Related content
- style