• NAME
• SYNOPSIS
• DESCRIPTION
• OPTIONS
• OPERANDS
• EXAMPLES
• EXIT STATUS
• INTERFACE EQUIVALENT
• SEE ALSO

NAME

 stop-instance - stops a server instance

SYNOPSIS

 stop-instance --user admin_user [--passwordfile filename] [--host host_name] [--port port_number] [--secure|-s] [--terse=false] [--echo=false] [--interactive=true] [--help] instance_name

DESCRIPTION

Use the stop-instance to stop the instance with the instance name specified. The stop-instance can be run both locally and remotely. The named instance must already exist within the given domain; and the instance must be running.

OPTIONS

-u --user

The authorized domain application server administrative username.

-w --password

The --password option is deprecated. Use --passwordfile instead.

--passwordfile

This option replaces the -- password option. Using the --password option on the command line or through the environment is deprecated. The --passwordfile option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain application server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_SAVEDMASTERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.

-H --host

The machine name where the domain application server is running. The default value is localhost.

-p --port

The port number of the domain application server listening for administration requests. The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4849.

-s --secure

If set to true, uses SSL/TLS to communicate with the domain application server.

-t --terse

Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

-e --echo

Setting to true will echo the command line statement on the standard output. Default is false.

-I --interactive

If set to true (default), only the required password options are prompted.

-h --help

Displays the help text for the command.

OPERANDS

instance_name

This is the name of the server instance to stop.

EXAMPLES

Example 1. Using stop-instance in local mode

asadmin> stop-instance --user admin1 --passwordfile passwords.txt instance1
Command stop-instance executed successfully

Example 2. Using stop-instance in remote mode

asadmin> stop-instance --user admin1 --password passwords.txt 
--host pigeon --port 4849 instance2
Command stop-instance executed successfully

Where: the instance2 is associated with user, password, host and port of the remote machine.

EXIT STATUS

0

command executed successfully

1

error in executing the command

INTERFACE EQUIVALENT

Server Instance page

SEE ALSO

delete-instance(1), start-instance(1), create-instance(1), restart-instance(1)