
Administration Commands                        delete-instance(1)

NAME
     delete-instance  - deletes the instance that is not running

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

DESCRIPTION
     Use the delete-instance command to delete a server instance.
     If  a  standalone  instance  is deleted (i.e. the instance's
     configuration name is server-name--config and no other clus-
     ters  or unclustered instances refer to this configuration),
     its standalone configuration will be  automatically  deleted
     as well.

     The Node Agent need not be running  (or  even  installed  or
     created)  to  delete a server instance. However, if the Node
     Agent is running, the command will delete the  instance.  If
     the  Node  Agent is not running, it will delete the instance
     the next time it is started.  If a  standalone  instance  is
     deleted,  that  is,  the  instance's  configuration  name is
     server-name-config and  no  other  clusters  or  unclustered
     instances  refer  to this configuration, then its standalone
     configuration will be automatically deleted as well.

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.

Java EE 5           Last change: 13 Jul 2007                    1

Administration Commands                        delete-instance(1)

     -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  administra-
         tive 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  interac-
         tively  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 com-
         mands, use the --passwordfile or enter them at the  com-
         mand prompt.

Java EE 5           Last change: 13 Jul 2007                    2

Administration Commands                        delete-instance(1)

         If you have authenticated to a domain using the  asadmin
         login command, then you need not specify the admin pass-
         word 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  indivi-
         dual commands, such as update-file-user.

         For security reasons, passwords specified as an environ-
         ment 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                name  of  the  instance  to  be
                                 deleted.

EXAMPLES
     Example 1 Using delete-instance:

       asadmin> delete-instance --user admin
       --passwordfile passwords.txt --host pigeon
       --port 4848 instance2
       Command delete-instance executed successfully

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     create-instance(1), start-instance(1), stop-instance(1)

Java EE 5           Last change: 13 Jul 2007                    3

