Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • We can run suspendServer operation in both Standalone and Domain mode.
  • 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 Final and above only.

Environment/Instance Properties

Property Name

Required

Description

FDWFLY_WILDFLY_HOME

Yes

The pathname to the directory in which WildFly has been installed.

FDWFLY_ADMIN_LISTEN_ADDRESS

Yes

The url of the Manager web application within the WildFly server.

FDWFLY_ADMIN_LISTEN_PORT

Yes

The port number of the manager web application within the WildFly server.

FDWFLY_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.

FDWFLY_ADMIN_PASSWORD

Yes

The password for the FDWFLY_ADMIN_USER user.

Project Properties

Property Name

Required

Description

FDWFLY_SERVER_NAME

NO

No

The WildFly Server name to suspend.

FDWFLY_SERVER_GROUP_NAME

NO

No

The WildFly Server Group name to suspend.

Inputs

Input Name

Required

Description

FDWFLY_INP_WILDFLY_MODE

Yes

The mode in which server has been started. Valid values are Standalone, Domain

FDWFLY_INP_WILDFLY_

SUBDOMAIN

HOST_

MODE

NAME

Yes

Specifies the way you want to interact with. Valid values are Server, ServerGroup, All

WildFly server host name which the server resides on. Required if resuming a Server, ignored if resuming a Server Group.

FDWFLY_INP_SERVER_NAMENoWildFly server name for suspend operation. Overrides the FDWFLY_SERVER_NAME property.
FDWFLY_INP_
WILDFLY
SERVER_
HOST
GROUP_NAME
Yes
NoWildFly server
host name
group name for suspend operation. Overrides the FDWFLY_SERVER_GROUP_NAME property.

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 . Since the admin server only runs on one server, it is expected that for a given domain, there will only be one endpoint with a resource type set to WFLY Admin Serverwhich 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 Admin Server endpoint selected using the WFLY Admin Server resource typeabove (the one which is identified as the WildFly Management Server).

Special Considerations

This plugin has the following prerequisites:

  • The WildFly user specified by property FDWFLY_ADMIN_USER must be granted the add-user script.
  • The target WildFly server must be running prior to calling this operation.