shut-down-jbi-service-assembly(1) (Sun GlassFish Enterprise Server v2.1.1 Reference Manual)

Sun GlassFish Enterprise Server v2.1.1 Reference Manual

shut-down-jbi-service-assembly(1)

Name

shut-down-jbi-service-assembly– shuts down a JBI service assembly on the specified target

Synopsis

shut-down-jbi-service-assembly 
[--terse={true|false}][ --echo={true|false} ] 
[ --interactive={true|false} ] [ --host  host] 
[--port port] [--secure| -s ] [ --user  admin_user]
[--passwordfile filename] [--help]

 [ --force =false] [--target target]
 service_assembly_name

Description

The shut-down-jbi-service-assembly command shuts down a JBI service assembly on the specified target. If a target is not specified, the command will shut down the JBI service assembly on the server, which is the default target.

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.

-F --force

Setting to true forcibly shuts down the service assembly. Default is false.

--target

Specifies the target on which you want to shut down the service assembly. Specify this option only if the service assembly is deployed in a multiserver environment with a Domain Administration Server (DAS). If the service assembly is not deployed in a multiserver environment with a DAS, this option is ignored. Valid values are:

server- Specifies the default server instance as the target. server is the name of the default server instance and is the default value.
domain_name- Specifies a certain domain as the target.
cluster_name- Specifies a certain cluster as the target.
instance_name- Specifies a certain server instance as the target.

Operands

service_assembly_name: The name of the JBI service assembly you want to shut down.

Examples

Example 1 Using the shut-down-jbi-service-assembly command

The following command shuts down a JBI service assembly.

asadmin> shut-down-jbi-server-assembly --user admin2
--passwordfile passwords.txt --target server1 serviceassembly1
Command shut-down-jbi-service-assembly executed successfully.

Exit Status

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