suspend-domain

suspends a running domain

Synopsis

suspend-domain [--help]
[--message reason-message]
[--timeout timeout-in-seconds]

Description

The suspend-domain subcommand suspends a running domain, bringing the domain to a state where GlassFish Server will not accept any asadmin, Administration Console, or REST API commands that might alter the files in the domain directory.

This subcommand is supported in remote mode only.

Options

--help

-?

Displays the help text for the subcommand.

--message

Specifies an explanatory message to be displayed to administrators who try to perform operations that would be blocked because the domain is suspended.

This option has no default value. When the option is not used, administrators receive a message of the form:

The domain was suspended by a user on date-and-time.

When the option is used, administrators receive a message of the form:

The domain was suspended by a user on date-and-time. Reason: reason-message

--timeout

Specifies a time in seconds to wait for running commands to complete. If the running commands do not complete, the suspend-domain command fails.

The default value is 30.

Exit Status

0: subcommand executed successfully
1: error in executing the subcommand