1wcadmin(1M) System Administration Commands wcadmin(1M)
2
6 wcadmin - manage the configuration of the Sun Java Web Console
7
9 /usr/sbin/wcadmin subcommand options
10 /usr/sbin/wcadmin [-h| --help]
13 /usr/sbin/wcadmin [-V | --version]
16
19 wcadmin is a Command Line Interface (CLI) — based tool for managing the
20 configuration of the Sun Java Web Console.
21
23 The following subcommands are supported:
24 add The wcadmin add subcommand adds a new shared jar file, a
26 new JAAS login module, or a new shared service property to
27 the console configuration. An optional identifier may be
28 specified; if omitted, the identifier is derived from the
29 resource name. The resource is added when the console is
30 next started.
31 The format of the add subcommand is:
33 add -l -a appname [-n id] jarpath
35 add -m -a appname [-n id] -b behavior -s service [-o
37 name=value] classname
38 add -p -a appname name=value [... name=value]
40 deploy The wcadmin deploy subcommand deploys the specified web
43 application into the console's web server instance. Appli‐
44 cations are deployed directly from their installation
45 directories.
46 The format of the deploy subcommand is:
48 deploy [-D] -a appname -x context app_path
50 disable The wcadmin disable subcommand disables access to the spec‐
53 ified web application in the console's web server instance.
54 The format of the disable subcommand is:
56 disable -x context
58 enable The wcadmin enable subcommand enables access to the speci‐
61 fied web application in the console's web server instance.
62 The format of the enable subcommand is:
64 enable -x context
66 list The wcadmin list subcommand lists the resources currently
69 configured for the console; including deployed web applica‐
70 tions, shared jar files, login modules, and shared service
71 properties. If no option is specified, all resources are
72 listed.
73 The format of the list subcommand is:
75 list [-a] [-d] [-l] [-m] [-p]
77 password The wcadmin password subcommand manages the administrator
80 and security keystore passwords for the console. Keystore
81 passwords should not be changed while the console is run‐
82 ning.
83 The format of the password subcommand is:
85 password [-a] [-k] [-t]
87 password -f password_file
89 reload The wcadmin reload subcommand unloads the specified web
92 application from the console's web server instance and
93 reloads the application from its original installation
94 directory.
95 The format of the reload subcommand is:
97 reload -x context
99 remove The wcadmin remove subcommand removes a shared jar file, a
102 login module, or a shared service property from the console
103 configuration. The resource may be specified by its identi‐
104 fier or by its full jarpath or classname. The resource is
105 removed when the console is next started.
106 The format of the remove subcommand is:
108 remove -l -a appname [-n id] jarpath
110 remove -m -a appname [-n id] classname
112 remove -p -a appname property [...]
114 undeploy The wcadmin undeploy subcommand undeploys the specified web
117 application from the console's web server instance.
118 The format of the undeploy subcommand is:
120 undeploy [-D] -a appname -x context
122
125 The following options are supported:
126 -h | --help | -? Display runtime help.
128 -V | --version Display console version information.
131 -D | --defer When used with the deploy and undeploy subcom‐
134 mands, defers the deployment or undeployment
135 until the next console restart. The operation
136 is deferred by simply adding or removing the
137 corresponding resource registration notifica‐
138 tion file. If defer is not specified, a runtime
139 deployment or undeployment is performed, so
140 that the application becomes available or
141 unavailable in the running console. If the con‐
142 sole instance is not currently running, the
143 operation is automatically deferred.
144 -a | --adminpassword Specify that the administrator password should
147 be changed, when used with password subcommand.
148 You are prompted for a new password, which must
149 be 8 to 32 characters.
150 -a | --application Specify the application name, when used with
153 subcommands other than password subcommand.
154 -d | --detail Specify that configuration details of each
157 resource should be displayed.
158 -f Specify the fully qualified path name to a file
161 containing one or more password property val‐
162 ues. See the description of the password_file
163 argument.
164 -k | --keypassword Specify that the keystore password should be
167 changed. You are prompted for a new password,
168 which must be 8 to 32 characters.
169 -l | --library Specify that the resource is a shared jar file.
172 -m | --module Specify that the resource is a JAAS login mod‐
175 ule.
176 -n | --name Specify the short-hand identifier name for the
179 resource. If omitted, the identifier name is
180 derived from the full resource name.
181 -o | --option Specify the name and value of a login module
184 option property, separated by the equals char‐
185 acter.
186 -p | --property Specify that the resource is one or more shared
189 service properties.
190 -s | --service Specify the name of the JAAS login service def‐
193 inition. If omitted, the default console login
194 service definition is assumed.
195 -t | --trustpassword Specify that the truststore password should be
198 changed. You are prompted for a new password,
199 which must be 8 to 32 characters.
200 -x | --context Specify the web application context path name
203 under which the application is deployed.
204
207 app_path The fully qualified file system path to the web appli‐
208 cation installation directory.
209 appname The application name. The name must be unique among
212 all web applications registered with the console. It
213 is also used as the name of the subdirectory under the
214 console's pre-registration directory which contains
215 all the resource registration notification files for
216 that application. Typically, the application package
217 name, plugin identifier, or context path name is spec‐
218 ified for the application name.
219 behavior The JAAS login module control flag behavior. Must be
222 one of "optional", "required", "requisite", or "suffi‐
223 cient".
224 classname The fully qualified Java package class name of the
227 JAAS login module. The specified class must be
228 included in a shared jar file added to the console.
229 context The web application context path name under which the
232 application is deployed. With the .reg suffix, the
233 context forms the file name of the registration noti‐
234 fication file for that application.
235 id The short-hand identifier name for a jar file or login
238 module resource to be added or removed. The identifier
239 name must be unique among the resources shared for a
240 given application name. With the .reg suffix, it forms
241 the file name of the registration notfication file for
242 that resource.
243 jarpath The fully qualified file system path to the jar file
246 resource. When the resource is added to the console,
247 its path is included in the classpath of the console's
248 shared class loader.
249 option The JAAS login module option property name.
252 property The shared service property name.
255 password_file The fully qualified path to a password text file that
258 contains the new administrator, keystore, and trust‐
259 store passwords in property file format. The adminis‐
260 trator password is specified using the "adminpassword"
261 property. The keystore password is specified using the
262 "keypassword" property. The truststore password is
263 specified using the "trustpasswd" property. At least
264 one password property must be contained in the pass‐
265 word file.
266 value The login module option or shared service property
269 value. If the value contains white space, it must be
270 quoted.
271
274 The following command adds a jar file to be shared in the console:
275 wcadmin add -l -a myapp_1.0 -n wbem /usr/sadm/lib/wbem.jar
277 The following command deploys a new web application:
282 wcadmin deploy -a myapp_1.0 -x myapp /opt/SUNWmyapp/myapp
284 The following command reloads an existing web application:
289 wcadmin reload -x myapp
291 The following command undeploys a web application at the next server
296 restart:
297 wcadmin undeploy -D -a myapp_1.0 -x myapp
299 The following command lists all the deployed web applications in the
304 console. If the status field is "running", the web application is
305 available. If the status field is "stopped", the web application is
306 disabled and is not available. If all web applications are "stopped",
307 this typically indicates the console web server instance is not run‐
308 ning.
309 wcadmin list -a
311 The following command removes a shared jar file:
316 wcadmin remove -l -a myapp_1.0 -n wbem
318 The following command changes passwords that are specified in a file:
323 wcadmin password -f /home/mydir/console-passwords
325
329 The following exit values are returned:
330 0 Subcommand succeeded without error
332 1 Usage error: missing or malformed arguments
335 2 Fatal error: subcommand failed with one or more errors
338
341 See attributes(5) for descriptions of the following attributes:
342 ┌─────────────────────────────┬─────────────────────────────┐
347 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
348 ├─────────────────────────────┼─────────────────────────────┤
349 │Availability │SUNWmcon │
350 ├─────────────────────────────┼─────────────────────────────┤
351 │Interface Stability │Stable │
352 └─────────────────────────────┴─────────────────────────────┘
353
355 smcwebserver(1M), smreg(1M), attributes(5), environ(5)
356SunOS 5.11 22 Aug 2006 wcadmin(1M)