stop-instance

stop-instance

DRAFT

stop-instance

stops a running \{product---name} instance

Synopsis

asadmin [asadmin-options] stop-instance [--help]
[--force={false|true}] [--kill={false|true}]
instance-name

Description

The stop-instance subcommand stops a running \{product---name} instance.

The subcommand can stop any \{product---name} instance, regardless of how the instance was created. For example, this subcommand can stop an instance that was created by using the create-local-instance(1) subcommand.

This command is supported in remote mode only.

Options

asadmin-options

Options for the asadmin utility. For information about these options, see the asadmin(1M) help page.

--help

-?

Displays the help text for the subcommand.

--force

Specifies whether the instance is forcibly stopped immediately.
Possible values are as follows:

true: The instance is forcibly stopped immediately (default).
false: The subcommand waits until all threads that are associated with the instance are exited before stopping the instance.

--kill

Specifies whether the instance is killed by using functionality of the operating system to terminate the instance process.
Possible values are as follows:

false: The instance is not killed. The subcommand uses functionality of the Java platform to terminate the instance process (default).
true: The instance is killed. The subcommand uses functionality of the operating system to terminate the instance process.

Operands

instance-name: This is the name of the \{product---name} instance to stop.

Examples

This example stops the \{product---name} instance yml-i-sj01.

Example 1 Stopping a \{product---name} Instance

asadmin> stop-instance yml-i-sj01
The instance, yml-i-sj01, was stopped.

Command stop-instance executed successfully.

Exit Status

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