
Administration Commands                     create-jvm-options(1)

NAME
     create-jvm-options - creates JVM options in the Java  confi-
     guration or profiler element of the domain.xml file.

SYNOPSIS
     create-jvm-options
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]
     [ --target  target]
     [--profiler={true|false}] (jvm_option_name=jvm_option_value)
     [:jvm_option_name=jvm_option_name*]

DESCRIPTION
     The create-jvm-options command creates JVM  options  in  the
     Java  configuration  or  profiler elements of the domain.xml
     file.  If JVM options are created for a profiler,  they  are
     used  to record the settings needed to get a particular pro-
     filer going.

     This command is supported in remote mode only.

     You must restart the server for newly created JVM options to
     take  effect.   Use the start/stop-domain command to restart
     the domain administration server.

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

Java EE 5           Last change: 11 Jul 2007                    1

Administration Commands                     create-jvm-options(1)

         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.

         If you have authenticated to a domain using the  asadmin

Java EE 5           Last change: 11 Jul 2007                    2

Administration Commands                     create-jvm-options(1)

         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.

     --target
         Specifies the target  on  which  you  are  creating  JVM
         options.   Valid  targets  are  name of a configuration,
         instance, cluster. The default is server, which  is  the
         name of the default server instance.

     --profiler

         Indicates whether the JVM options are for the  profiler.
         The  profiler  must  exist  for  this option to be true.
         Default is false.

OPERANDS
     jvm_option_name
         The left side of the equal sign (=) is  the  JVM  option
         name.   The  right side of the equal sign (=) is the JVM
         option value. A colon (:)  is a delimiter  for  multiple
         options.

EXAMPLES
     Example 1 Using the create-jvm-options command

     JVM options must start with a dash (-).  Use  the  backslash
     (\) to escape the dash delimiter.

       asadmin> create-jvm-options --interactive=true
       --secure=true --passwordfile passwords.txt --terse=false

Java EE 5           Last change: 11 Jul 2007                    3

Administration Commands                     create-jvm-options(1)

       --user admin --host localhost --port 4848 --target server
       \\-Dunixlocation=/root/example:
       -Dvariable=\$HOME:-Dwindowslocation=d\\:\\\sun\\\appserver:
       -Doption1=-value1
       Command create-jvm-options executed successfully

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     delete-jvm-options(1)

Java EE 5           Last change: 11 Jul 2007                    4

