Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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_value*]
The create-jvm-options command creates command-line options that are passed to the Java application launcher when Enterprise Server is started. These options are stored in the Java configuration element or profiler element of the domain.xml file. If options are created for a profiler, they are used to record the settings that are required to start a particular profiler.
In the syntax, there can be more than one option, separated by a colon.
This command is supported in remote mode only.
The create-jvm-options command creates the following options:
Java system properties. System properties are set through the -D option of the Java application launcher, for example:
-Djava.security.manager
-Denvironment=Production
Startup parameters for the Virtual Machine for the Java platform (Java Virtual Machine or JVMTM machine). [The terms "Java Virtual Machine" and "JVM" mean a Virtual Machine for the Java platform.] Startup parameters are preceded by the dash character (-) , for example:
--XX:PermSize=size
-Xmx1024m
-client
-d64
In the following situations, you must terminate the command with a double-dash (--) before the options:
You are specifying only one system property with just a name and no value, for example, -Djava.security.manager.
You are specifying a startup parameter for the JVM machine without a value, for example, -Xmx1024m
If the command specifies an option that already exists, the command does not re-create the option.
The addition of some options requires a restart of the domain administration server (DAS) to become effective. Other options are set immediately in the environment of the DAS and do not require a restart.
Whether a restart is required depends on the type of the option.
Restart is not required for Java system properties whose names do not start with -Djava. or -Djavax. (including the trailing period). For example, restart is not required for the Java system property -Denvironment=Production.
Restart is required for the following options:
System properties whose names start with -Djava. or -Djavax. (including the trailing period), for example, -Djava.security.manager
Startup parameters for the JVM machine, for example, -Xmx1024m, -client or -d64
To restart the DAS, use the following commands in this order:
For more information about the Java application launcher, see the reference page for the operating system that you are using:
SolarisTM Operating System (Solaris OS) and Linux: java - the Java application launcher
Windows: java - the Java application launcher
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.
If set to true, the command-line statement is echoed on the standard output. Default is false.
If set to true (default), only the required password options are prompted.
The machine name where the domain administration server is running. The default value is localhost.
The HTTP port or HTTPS port for administration. This port is the port in the URL that you specify in your web browser to manage the domain, for example, http://localhost:4848.
The default port number for administration is 4848.
If set to true, uses SSL/TLS to communicate with the domain administration server.
The default is false.
The user name of the authorized administrative user of the domain administration server.
If you have authenticated to a domain by using the asadmin login command, you need not specify the --user option for subsequent operations on the domain.
Specifies the name, including the full path, of a file that contains the password entries in a specific format.
The entry for a password must have the AS_ADMIN_ prefix followed by the password name in uppercase letters. For example, to specify the password for the domain administration server, use an entry with the following format:
AS_ADMIN_PASSWORD=password
In this example, password is the actual administrator password.
The following other passwords can also be specified:
AS_ADMIN_MAPPEDPASSWORD
AS_ADMIN_USERPASSWORD
AS_ADMIN_ALIASPASSWORD
All remote commands must specify the administration password to authenticate to the domain administration server. The password can be specified by one of the following means:
Through the --passwordfile option
Through the asadmin login command
Interactively at the command prompt
The asadmin login command can be used only to specify the administration password. For other passwords that remote commands require, use the --passwordfile option or specify them at the command prompt.
After authenticating to a domain by using the asadmin login command, you need not specify the administration password through the --passwordfile option for subsequent operations on the domain. However, only the AS_ADMIN_PASSWORD option is not required. You still must provide the other passwords, for example, AS_ADMIN_USERPASSWORD, when required by individual commands, such as update-file-user.
For security reasons, a password that is specified as an environment variable is not read by the asadmin command.
The default value for AS_ADMIN_MASTERPASSWORD is changeit.
Displays the help text for the command.
Do not specify this option. This option is retained for compatibility with other releases. If you specify this option, a syntax error does not occur. Instead, the command runs successfully and the option is silently ignored.
Indicates whether the JVM options are for the profiler. The profiler must exist for this option to be true. Default is false.
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.
If an option name or option value contains a colon, the backslash (\) must be used to escape the colon in the name or value. Other characters might also require an escape character. For more information about escape characters in command options, see the asadmin(1M) man page.
JVM machine options must start with a dash (–). Use the backslash (\) to escape the dash delimiter.
asadmin> create-jvm-options --interactive=true --passwordfile passwords.txt --terse=false --user admin --host localhost --port 4848 --target server \-Dunixlocation=/root/example: \-Dvariable=\$HOME: \-Dwindowslocation=d\:\\sun\\appserver: \-Doption1=-value1 created 4 option(s) Command create-jvm-options executed successfully |
This example shows the command for setting the maximum available heap size to 1024. Because this command is setting a startup parameter for the JVM machine without a value, the command is terminated by a double dash -- before the parameter.
asadmin> create-jvm-options -- -Xmx1024m created 1 option(s) Command create-jvm-options executed successfully. |
This example shows the command for setting startup parameters for the JVM machine as follows:
The maximum available heap size is set to 1024.
Information about garbage collection is to be provided.
asadmin> create-jvm-options "-Xmx1024m:-XX\:+PrintGCDetails" created 1 option(s) Command create-jvm-options executed successfully. |
In this example, one parameter already existed before the command was run. Therefore, the command reports that only one option was set.
delete-jvm-options(1), list-jvm-options(1), start-domain(1), stop-domain(1)
java - the Java application launcher reference page for the Solaris OS and Linux, java - the Java application launcher reference page for Windows
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also