2.8.21 unset-web-env-entry
Unsets an environment entry for a deployed Web application or module.
Synopsis
asadmin [asadmin-options] unset-web-env-entry [--help]
--name=env-entry-name application-name[/module]
Storage location
Application Server installation directory/javaee/glassfish/bin
Function
The unset-web-env-entry subcommand of asadmin unsets an environment entry for one of the following items:
-
A deployed Web application.
-
A Web module in a deployed Java Platform, Enterprise Edition (Java EE) application.
When an entry is unset, its value reverts to the value, if any, that is set in the application's DD. This subcommand enables you to change the configuration of a deployed application without the need to modify the application's DD and repackage and redeploy the application.
This subcommand is supported in remote mode only.
Precondition
-
The application must already be deployed.
-
The entry must have previously been set.
-
Domain Administration Server (DAS) is running.
Environment variable
The path to the module is specified in the module element of the application's application.xml file.
Arguments
- --help | -?
-
Displays the help text for the subcommand.
- --name=env-entry-name
-
Specifies the name of the environment entry that is to be unset. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a deployment component.
Type: String
The following values can be specified:
-
Name of the environment entry
Default value: N/A
-
- application-name
-
Specifies the name of the application.
Type: String
The following values can be specified:
-
Name of the application
Default value: N/A
-
- module
-
Specifies the relative path to the module within the application's enterprise archive (EAR) file. The path to the module is specified in the module element of the application's application.xml file. module is required only if the environment entry applies to a Web module of a Java EE application.
If specified, module must follow application-name, separated by a slash (/). The module would be specified as the operand of this command as myApp/myWebModule.war.
Type: String
The following values can be specified:
-
Name of the application module
Default value: N/A
-
Examples
The following example unsets the environment entry Hello User of the Web application hello. The entry reverts to the value, if any, that is defined in the application's DD.
asadmin unset-web-env-entry --name="Hello User" hello
Exit Status
|
Exit Status |
Explanation |
|---|---|
|
0 |
command executed successfully. |
|
1 |
error in executing the command. |