stop-instance(1)

NAME | Synopsis | Description | Options | Operands | Examples | Exit Status | INTERFACE EQUIVALENT | See Also

NAME

stop-instance – stops a server instance

Synopsis

[--terse={true|false}][ --echo={true|false} ] 
[ --interactive={true|false} ] [ --host  host] 
[--port port] [--secure| -s ] [ --user  admin_user]
[--passwordfile filename] [--help]
 instance_name

Description

---

Note –

This command is available only in domains that are configured to support clusters, such as domains that are created with the cluster profile or the enterprise profile. For information about profiles, see Usage Profiles in Sun Java System Application Server 9.1 Administration Guide.

---

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

-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 --host

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

-p --port

The HTTP/S port for administration. This is the port to which you should point your browser in order to manage the domain. For example, http://localhost:4848.

The default port number is 4848.

-s --secure

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

-u --user

The authorized domain administration server administrative username.

If you have authenticated to a domain using the asadmin login command, then you need not specify the --user option on subsequent operations to this particular domain.

--passwordfile

The --passwordfile option specifies the name, including the full path, of a file containing the password entries in a specific format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in uppercase letters.

For example, to specify the domain administration 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, and AS_ADMIN_ALIASPASSWORD.

All remote commands must specify the admin password to authenticate to the domain administration server, either through --passwordfile or asadmin login, or interactively on the command prompt. The asadmin login command can be used only to specify the admin password. For other passwords, that must be specified for remote commands, use the --passwordfile or enter them at the command prompt.

If you have authenticated to a domain using the asadmin login command, then you need not specify the admin password through the --passwordfile option on subsequent operations to this particular domain. However, this is applicable only to AS_ADMIN_PASSWORD option. You will still need to provide the other passwords, for example, AS_ADMIN_USERPASSWORD, as and when required by individual commands, such as update-file-user.

For security reasons, passwords specified as an environment variable will not be read by asadmin.

The default value for AS_ADMIN_MASTERPASSWORD is changeit.

--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 --local --domain domain1 server1 Instance server1 stopped

Where: the server1 instance associated with the domain1 domain is stopped locally.

---

---

Example 2 Using stop-instance in remote mode




asadmin> stop-instance --user admin --password bluestar --host localhost --port 4848 server1 Instance server1 stopped

Where: the server1 instance associated with the named user, password, host and port is deleted from 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), , start-appserv(1), stop-appserv(1), start-domain(1), stop-domain(1)

NAME | Synopsis | Description | Options | Operands | Examples | Exit Status | INTERFACE EQUIVALENT | See Also