Sun Java System Web Server 7.0 Update 4 CLI Reference Manual

Previous: Preface

User Commands

add-documents(1)

Name

add-documents– adds search documents

Synopsis

add-documents <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--encoding|-g encoding] [--no-subdirs|-S] 
--pattern|-P pattern --config|-c config-name 
--vs|-s vs-name --collection|-O name

Description

Use this command to add search documents. Web Server includes a search feature that allows users to search documents on the server and display results on a Web page. You can create an index of documents against which users can run the search operations. You can also customize the search interface to meet the user requirements.

Web Server supports multiple document search. You can index documents with different formats such as HTML, ASCII, and PDF. Search is enabled for a virtual server by enabling the search application included in the server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--encoding|-g: Specify the character encoding for the documents to be indexed. The default is ISO-8859-1. The indexing engine tries to determine the encoding of HTML documents from the embedded meta tag.
--no-subdirs|-S: If you specify this option, sub directories of the document root will not be searched.
--pattern|-P: Specify the wild card pattern of the documents that have to be added.
--config|-c: Specify the name of the configuration for which you want to add the search documents.
--vs|-s: Specify the name of the virtual server.
--collection|-O: Specify the name of the collection.

Examples

wadm add-documents --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs --pattern=*.html --collection=searchcoll

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

add-webapp(1)

Name

add-webapp– adds a web application

Synopsis

add-webapp <connect_options>  [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--description|-D text] [--precompile-jsp|-j] 
[--file-on-server|-f] [--no-enabled|-n] [--directory|-d 
deploy_to_directory] --config|-c config-name --vs|-s vs-name
--uri|-r context-root warfile

Description

Use this command to add a web application. A web application is a collection of Java Servlets, JSPs, HTML pages, and other resources. All these resources are stored in a directory, and all requests to the directory run the application.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the new web application.
--precompile-jsp|-j: If you specify this option, JSPs will be precompiled into classes during deployment. This improves performance.
--file-on-server|-f: If you specify this option, path to the WAR (Web Application Archive) file must be the absolute path on the administration server.
--no-enabled|-n: Specify this option to disable the web application at runtime.
--directory|-d: Specify the name of the target directory for deploying the web application.
--config|-c: Specify the name of the configuration for which you want to add the web application.
--vs|-s: Specify the name of the virtual server where you want to deploy the web application.
--uri|-r: Specify the URI for your web application. This will be the application context root and is relative to the server host.

Operands

warfile: Specify the name of the WAR file.

Examples

wadm add-webapp --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--accept-cert --config=config1 --vs=vs --uri=/newapp webapps-simple.war

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

block-reverse-proxy-header(1)

Name

block-reverse-proxy-header– blocks a reverse proxy header

Synopsis

block-reverse-proxy-header <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name --uri-prefix|-r uri-prefix (param)

Description

Use this command to block a reverse proxy parameter. The parameters that you can block are jroute, ip, via, cipher, proxy-agent, proxy-auth, keysize, secret-keysize, ssl-id, issuer-dn, user-dn, and auth-cert.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix of the reverse proxy.

Operands

param: Specify the name of the header parameter that you want to block.

Examples

wadm block-reverse-proxy-header --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs1 --uri-prefix=/reverse jroute

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

copy-config(1)

Name

copy-config– creates a copy of an existing configuration

Synopsis

copy-config <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name copy-name

Description

Use this command to create a copy of an existing configuration. The newly copied configuration is identical to the existing configuration. However, the new configuration will not have any instances even though the configuration from which it has been copied has instances.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration that needs to be copied.

Operands

copy-name: Specify the name of the configuration that you want to create.

Examples

wadm copy-config --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 copyconfig1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

copy-virtual-server(1)

Name

copy-virtual-server– creates a copy of an existing virtual server

Synopsis

copy-virtual-server <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name
source-virtual-server-name  new-virtual-server-name

Description

Use this command to create a copy of an existing virtual server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the source virtual server.

Operands

new-virtual-server-name: Specify the name of the virtual server that you want to create.

Examples

wadm copy-virtual-server --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs copiedVs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-authdb(1)

Name

create-authdb– creates a new authentication database

Synopsis

create-authdb <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--no-enabled|-n] 
--config|-c config-name --url|-r url authdb-name

Description

Use this command to create a new authentication database. Authentication database enables you to select a database, which the server will use to authenticate users. Web Server supports the use of file, PAM, and LDAP based authentication databases.

file — This database stores user and group information in flat files.
PAM — This database is the native authentication database supported by Sun Java System Web Server 7.0. This authentication database is supported only on the Solaris platform.
LDAP — This database is any directory server including Sun Java System Directory Server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server. If you specify this option, the authentication database is created at the virtual server level instead of the configuration level.
--no-enabled|-n: If you specify this option, the authentication database is disabled at runtime.
--config|-c: Specify the name of the configuration for which you want to create the authentication database.
--url|-r: Specify the URL of the authentication database. The type of authentication database is specified in the URL scheme. For example, ldap://ds.example.com/dc=example,dc=com configures an LDAP directory server as an authentication database.

Operands

authdb-name: Specify the name of the authentication database that you want to create.

Examples

wadm create-authdb --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 
--url=ldap://ldapserver.com:20002/dc=xxx,dc=sun,dc=com LDAP1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-authdb-userprop(1)

Name

create-authdb-userprop– creates the authentication database user properties

Synopsis

create-authdb-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--description|-D text] [--vs|-s vs-name]
[--encode|-d boolean] --config|-c config-name 
--authdb|-a name  (propertyname=value)+

Description

Use this command to create the authentication database user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the authentication database user property.
--encode|-d: If you set this option to true, the property value is encoded and stored in the configuration files.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which you want to create the authentication database properties.
--authdb|-a: Specify the name of the authentication database.

Operands

propertyname=value: Specify the name and value of the database user property that you want to create.

Examples

wadm create-authdb-userprop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --authdb=LDAP1 info=authdbusrprop

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-auth-realm(1)

Name

create-auth-realm– creates a new authentication realm

Synopsis

create-auth-realm <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (--class|-C=name|
--type|-t file/ldap/pam/native/certificate) realm-name

Description

Use this command to create a new authentication realm. The J2EE based security model provides for security realms that identify and authenticate users. The authentication process verifies users through an underlying realm, also known as a security domain. A realm consists of a set of users, optional group mappings, and authentication logic that validates the requests.

Once an authentication request is validated by a configured realm and the security context established, the identity is applied to all subsequent authorization decisions, unless overruled by a run-as condition. A server instance may have any number of configured realms.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.

--verbose|-v

Specify this option to display a verbose output.

--type|-t

Specify the name of a built-in authentication realm type. The type can be file, ldap, pam, native or certificate.

--class|-C

Specify the class for custom realm.

Note –

The type and class options are mutually exclusive.

--config|-c

Specify the name of the configuration for which you want to create the authentication realm.

Operands

realm-name: Specify the name of the authentication realm that you want to create.

Examples

wadm create-auth-realm --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --class=javax.security.auth.realm basic

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-auth-realm-userprop(1)

Name

create-auth-realm-userprop– creates authentication realm user properties

Synopsis

create-auth-realm-userprop <connect_options> [--echo|-e]  
[--no-prompt|-Q] [--verbose|-v] [--description|-D text] 
--config|-c config-name --realm|-L name (propertyname=value)+

Description

Use this command to create the authentication realm user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the authentication realm user property.
--config|-c: Specify the name of the configuration for which you want to create the authentication realm user property.
--realm|-L: Specify the name of the authentication realm.

Operands

propertyname=value: Specify the name and value of the authentication realm user property that you want to create.

Examples

wadm create-auth-realm-userprop --user=admin 
--password-file=../admin.passwd--host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--realm=basic info=authrealm

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-cert-request(1)

Name

create-cert-request– creates a certificate request

Synopsis

create-cert-request <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--org-unit|-o unit] [--locality|-l place] 
[--state|-a name] [--org|-g org] 
[--country|-y name] [--token-pin|-P name] 
[--key-type|-k (rsa|ecc)] [--key-size|-z size] 
[--curve|-r curvename] [--alt-server-name|-A dns-name]  
--config|-c config-name --token|-t name 
--server-name|-s name

Description

Use this command to create a new certificate request. A certificate consists of digital data that specifies the name of an individual, company, or other entity and certifies that the public key included in the certificate belongs to that entity. Both clients and servers can have certificates.

A certificate is issued and digitally signed by a Certificate Authority (CA). The CA can be a company that sells certificates over the Internet, or it can be a department responsible for issuing certificates for your company's intranet or extranet. You decide which CAs you trust enough to serve as verifiers of other user's identities. In Sun Java System Web Server, Administration Server and each server instance can have its own trust database.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--key-type|-k

Specify the type of the certificate key. The key types can be rsa or ecc, where

rsa is an internet encryption and authentication system using public and private keys.
ecc (Elliptic Curve Cryptography) is a public key encryption technique. It is based on the elliptic curve theory that enables security with smaller key sizes. This results in faster computations, lower power consumption, as well as memory and bandwidth savings.

--key-size|-z

Specify the size of the certificate key. This option is applicable if you choose the key-type as rsa. The key size can be 1024, 2048 or 4098.

--curve|-r

Specify the name of the curve. This option is applicable if you choose the key-type as ecc.

--token-pin|-P

Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.

--org|-g

Specify the name of your organization, company, or educational institution.

--org-unit|-o

Enter a description of an organizational unit within your company.

--locality|-l

Enter a description of the city, principality, or country of the organization.

--state|-a

Specify the state or province where your organization is located.

--country|-y

Specify a two-character abbreviation of your country's name (in ISO format). For example, the country code for the United States is US.

--config|-c

Specify the name of the configuration for which you want create the certificate.

--token|-t

Specify the token (cryptographic device) name, which contains the encrypted public key.

--server-name|-s

Specify the host name of the server for which you are requesting a certificate from the Certificate Authority (CA).

--alt-server-name|-A

(This option is deprecated. A list of domain names can be added in the server name, separated by commas.) Specify the domain names of the host provided in the server-name option.

Examples

wadm create-cert-request --user=admin --host=serverhost 
--port=8989 --ssl=true --prompt=false --rcfile=null 
--password-file=certdb.newpasswd --org=sun --country=IN
--locality=abc certreq --config=config1 --token=internal 
--server-name=config1.org --alt-server-name=config2.org

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-cgi-dir(1)

Name

create-cgi-dir– creates a CGI directory

Synopsis

create-cgi-dir <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--shell-cgi|-S boolean] --config|-c config-name

--vs|-s vs-name --uri-prefix|-r uri-prefix 
--directory|-d dir

Description

Use this command to create a common gateway interface (CGI) directory that will contain the CGI programs. CGI programs are in file type .cgi, .exe, or .bat.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--shell-cgi|-S: Specify this option if the CGI directory will have shell CGI programs.
--uri-prefix|-r: Specify the URI prefix to use for the CGI directory. This prefix appears as the directory for the CGI programs in the URL.
--directory|-d: Specify the path of the directory that contains the CGI programs.
--config|-c: Specify the name of the configuration for which you want to create the CGI directory.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.

Examples

wadm create-cgi-dir --user=admin --password-file=../admin.pwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs1 --uri-prefix=/config1_urlprefix 
--directory=../cgi-dir

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-cgi-envvar(1)

Name

create-cgi-envvar– creates CGI environment variables

Synopsis

create-cgi-envvar <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --description|-D text --config|-c config-name 
(varname=value)+

Description

Use this command to create a common gateway interface (CGI) environment variable.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the new CGI environment variable.
--config|-c: Specify the name of the configuration for which you want to create the CGI environment variables.

Operands

varname=value: Specify the name and value of the CGI environment variable that you want to create.

Examples

wadm create-cgi-envvar --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 timeout=10 idle-timeout=10 
cgistub-path=../../lib/Cgistub cgistub-idle-timeout=10 
min-cgistubs=10 max-cgistubs=20 nice=1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-config(1)

Name

create-config– creates a new configuration

Synopsis

create-config <connect_options>[--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--document-root|-d serverdocroot] 
[--jdk-home|-j JAVA_HOME] [--server-user|-r userid] 
[--ip|-I ip] [--platform|-m 32|64]
 --http-port|-t port --server-name|-s servername 
config-name

Description

Use this command to create a new configuration. A configuration is a set of files and virtual servers that determine the data that Web Server serves. This command creates the new server configuration at install_dir/admin-server/config-store.

Do not edit any file under the config-store directory. The files under this directory are created by Sun Java System Web Server for internal use.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--document-root|-d: Specify the path where all content such as HTML pages, images, and web applications are available. The default value is ../docs.
--jdk-home|-j: Specify the path of the Java Development Kit (JDK) home.
--ip|-I: Specify the IP for the default listener.
--platform|-m: Specify the platform type that you want to install. The value can be 32 or 64. The default value is 32.
--server-user|-r: Specify the user ID of a server user. For example, root. This option is mandatory if the administration server is on UNIX.
--http-port|-t: Specify the port for the default listener.
--server-name|-s: Specify the host name of the server.

Operands

config-name: Specify the name of the configuration you want to create.

Examples

wadm create-config --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--platform=32 --http-port=18022 --document-root=../docs 
--jdk-home=jdk_home --server-user=user 
--server-name=config1.com config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-custom-resource(1)

Name

create-custom-resource– creates a custom resource

Synopsis

create-custom-resource <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--no-enabled|-n] --res-type|-r type 
--factory-class|-f name --config|-c config-name jndi-name

Description

Use this command to create a custom resource. A custom resource accesses a local Java Naming and Directory Interface (JNDI) repository. The custom-resource element defined in server.xml enables you to specify a custom server-wide resource object factory. Such object factories implement the javax.naming.spi.ObjectFactory interface. The custom-resource element associates a JNDI name (specified through the jndi-name subelement) to be used in the server-wide namespace, its type, name of the resource factory class and a set of standard properties used to instantiate the same.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option to disable the custom resource at runtime.
--res-type|-r: Specify the type of custom resource you want create.
--factory-class|-f: Specify the class that instantiates the custom resource you create. The value of this option is the name of a user-written factory class that implements javax.naming.spi.ObjectFactory.
--config|-c: Specify the name of the configuration for which you want to create a custom resource.

Operands

jndi-name: Specify the JNDI name of the custom resource you want to create.

Examples

wadm create-custom-resource --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --res-type=samples.jndi.customResource.MyBean 
--factory-class=samples.jndi.cus-res.MyCustomConnectionFactory custom

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-custom-resource-userprop(1)

Name

create-custom-resource-userprop– creates a custom resource user property

Synopsis

create-custom-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--description|-D text] 
--config|-c config-name --jndi-name|-j resourcename 
(propertyname=value)+

Description

Use this command to create custom resource user properties. A custom resource accesses a local Java Naming and Directory Interface (JNDI) repository.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the custom resource user property.
--config|-c: Specify the name of the configuration for which you want to create the custom resource user property.
--jndi-name|-j: Specify the JNDI name of the custom resource.

Operands

propertyname=value: Specify the name and value of the custom resource user property that you want to create.

Examples

wadm create-custom-resource-userprop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=custom info=cust_res

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-dav-collection(1)

Name

create-dav-collection– creates DAV collections

Synopsis

create-dav-collection <connect_options>  [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--provider|-o type] [--lock-db-path|-l name] 
[--lock-db-update-interval|-k interval] 
[--property-db-update-interval|-T time] [--property-db-max-size|-d
 size] [--min-lock-timeout|-m time] [--max-xml-request-body-size|-x
 time] [--max-propfind-depth|-D depth] 
[--max-report-response-elements|-a size] 
[--max-expand-property-depth|-E depth] [--auth-auth-db-name|-A name]
[--auth-method|-M basic/digest/ssl] 
[--auth-prompt|-P text] --acl-db-max-entries|-b max-aces]
[--acl-db-update-interval|-L seconds]
[--acl-db-max-size|-z size] [--no-enabled|-n] 
[--source-uri|-S uri]--vs|-s vs-name --uri|-r uri
--config|c config-name

Description

Use this command to create a DAV (Distributed Authoring and Versioning) collection. A DAV collection is a resource or set of resources that are enabled for WebDAV operation. WebDAV operation includes web publishing and collaborative authoring, namespace management, and metadata management.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--source-uri|-S: Specify the URI that DAV clients can use to access the source code of the content.
--no-enabled|-n: If you specify this option, this DAV collection is disabled at runtime.
--provider|-o: Specify the name of the provider that manages this collection.
--lock-db-path|-l: Specify the directory where the DAV lock database is stored.
--lock-db-update-interval|-k: Specify the interval (in seconds) at which the DAV lock information is written to the disk.
--min-lock-timeout|-m: Specify the minimum expiration time (in seconds) for DAV locks.
--property-db-update-interval|-T: Specify the interval (in seconds) at which the WebDAV file properties are written to the disk.
--property-db-max-size|-d: Specify the maximum size (in bytes) of the WebDAV file property database files.
--max-xml-request-body-size|-x: Specify the maximum size (in bytes) allowed for WebDAV XML request bodies.
--max-propfind-depth|-D: Specify the maximum depth of the PROPFIND requests sent to collections.
--max-report-response-elements|-a: Specify the maximum size (in bytes) allowed for the WebDAV report response.
--max-expand-property-depth|-E: Specify the maximum depth allowed for WebDAV expand property report responses.
--auth-auth-db-name|-A: Specify the name of the authentication database.
--auth-prompt|-P: Specify an authentication prompt.
--auth-method|-M: Specify an authentication method. The method can be basic, digest, or ssl.
--acl-db-max-entries|-b: Specify the maximum entries that can exist in the access control list (ACL) database.
--acl-db-update-interval|-L: Specify the interval (in seconds) at which the Access Control List (ACL) database will be updated.
--acl-db-max-size|-z: Specify the maximum size of the Access Control List (ACL) database.
--config|-c: Specify the name of the configuration for which you want to create a DAV collection.
--vs|-s: Specify the name of the virtual server.
--uri|-r: Specify the URI through which the content is accessed.

Examples

wadm create-dav-collection --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt
--rcfile=null --config=config1 --vs=vs --uri=/dav_config1 
--source-uri=/dav_config1 --enabled=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-document-dir(1)

Name

create-document-dir– creates a document directory

Synopsis

create-document-dir <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --uri-prefix|-r uri-prefix --directory|-d path
--vs|-s vs-name --config|-c config-name

Description

Use this command to create a document directory. The primary document directory, also called the document root, is the central directory where you store all the files you want to make available to remote clients. You can create a document directory, which is in addition to the primary document directory. By doing this, you can let others manage a group of documents without giving them access to your primary document root.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-prefix|-r: Specify the URI prefix that has to be mapped to a directory.
--directory|-d: Specify the path to the directory that will store the documents.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration for which you want to create the document directory.

Examples

wadm create-document-dir --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs --uri-prefix=/config1_uri --directory=../docs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-event(1)

Name

create-event– creates a new event

Synopsis

create-event <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--time|-t hh:mm] 
[--month|-m 1-12][--day-of-week|-k sun/mon/tue/wed/thu/fri/sat] 
[--day-of-month|-d 1-31][--interval|-r 60-86400(seconds)] 
[--no-enabled|-n] --config|-c config-name
--command|-C restart|reconfig|rotate-log|rotate-access-log|update-crl|
commandline

Description

Use this command to create a new event. You can set a specific time and interval for scheduling automatic instance reconfiguration. You can create an event to restart and reconfigure all runnings instances, rotate access and error logs, update the certificate revocation list, and provide the absolute path to a file that will be executed.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option to disable the event at runtime.
--time|-t: Specify the time you want this event start. The format of the time is hh:mm, for example, 12:30.
--month|-m: Specify the month you want this event to occur. The range of values is 1–12.
--day-of-week|-k: Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--day-of-month|-d: Specify the day of the month you want this event to occur. The range of values is 1–31.
--interval|-r: Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
--command|-C: Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.
--config|-c: Specify the name of the configuration for which you want to create the event.

Examples

wadm create-event --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --time=12:00 --enabled=true --month=11 
--day-of-week=sun --day-of-month=23 --interval=120 
--command=rotate-log

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-external-jndi-resource(1)

Name

create-external-jndi-resource– creates an external JNDI resource

Synopsis

create-external-jndi-resource <connect_options>  [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--no-enabled|-n] 
[--description|-D text] --external-jndi-name|-j name 
--res-type|-r type --factory-class|-f name 
--config|-c config-name jndi-name

Description

Use this command to create an external Java Naming and Directory Interface (JNDI) resource. Applications running on Sun Java System Web Server require access to resources stored in an external JNDI repository. For example, generic Java objects could be stored in an LDAP server as per the Java schema. While a custom resource allows you to access a local JNDI repository, you must use an external JNDI resource to access an external JNDI repository. An external JNDI factory must implement the javax.naming.spi.InitialContextFactory interface.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option to disable the external JNDI resource at runtime.
--description|-D: Enter a description of the external JNDI resource.
--external-jndi-name|-j: Specify the external JNDI lookup name.
--res-type|-r: Specify the type of the external JNDI resource.
--factory-class|-f: Specify the name of the user-written factory class that implements javax.naming.spi.InitialContextFactory.
--config|-c: Specify the name of the configuration for which you want to create an external JNDI resource.

Operands

jndi-name: Specify the name of the external JNDI resource that you want to create.

Examples

wadm create-external-jndi-resource --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--res-type=org.apache.naming.res--factory-class=samples.jndi.external
-res.MyExternalConnectionFactory --external-jndi-name=index.html 
external-jndi

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-external-jndi-resource-userprop(1)

Name

create-external-jndi-resource-userprop– creates external JNDI resource user properties

Synopsis

create-external-jndi-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--description|-D text] 
--config|-c config-name --jndi-name|-j resourcename 
(propertyname=value)+

Description

Use this command to create an external Java Naming and Directory Interface (JNDI) resource user property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the external JNDI resource user property.
--config|-c: Specify the name of the configuration for which you want to create the external JNDI resource user property.
--jndi-name|-j: Specify the name of the external JNDI resource.

Operands

propertyname=value: Specify the name and value of the external JNDI resource user property that you want to create.

Examples

wadm create-external-jndi-resource-userprop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=external-jndi info=ext_jndiresource

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-fastcgi-handler(1)

Name

create-fastcgi-handler– creates a FastCGI handler

Synopsis

create-fastcgi-handler <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--mime-type|-m type] [--uri-pattern|-t pattern]
[--role|-o authorizer|responder|filter|error] [--app-path|-a path]
[--app-args|-A arg1,arg2...] [--bind-path|-b path] 
[--min-procs|-n count] [--max-procs|-x count] 
[--chroot|-H directory] [--server-user|-r user-id] 
[--group|-g group-id] [--nice|-i value] 
[--listen-queue-size|-l size] 
[--app-env|-E 'name=value','name=value'...] [--reuse-connection|-U] 
[--connection-timeout|-C time-in-seconds] 
[--response-timeout|-T time-in-seconds] [--restart-interval|-I minutes] 
[--request-retry|-q retry-count] [--error-url|-L url] 
[--error-reason|-O string] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to create a FastCGI handler. FastCGI is an open extension to CGI (Common Gateway Interface), which is a standard for interfacing external applications with web servers. FastCGI applications run in separate, isolated processes. As FastCGI processes can be reused to handle multiple requests, it improves performance. FastCGI provides the ability to run applications remotely, which is useful for load distributing. FastCGI application does not crash or corrupt the core server or other applications. For more information on FastCGI, see http://www.fastcgi.com.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--mime-type|-m

Specify the MIME type.

--uri-pattern|-t

Specify the URI pattern.

--role|-o

Specify the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.

Note: Under a named or default object, the administration interface does not support having multiple directives for a particular role. This can be enabled by manual modification of the appropriate obj.conf file.

In the responder role, the FastCGI application receives all information associated with an HTTP request and generates a response.
In the authorizer role, the FastCGI application receives all information associated with an HTTP request and generates an authorized or unauthorized decision.
In the filter role, the FastCGI application receives all information associated with an HTTP request and additional data from a file stored on the web server, and generates a filtered version of the data stream as an HTTP response.
In the error role, the FastCGI application terminates if an error occurs. You can configure the application to display a specific page or redirect the request to a URL if an error occurs.

--app-path|-a

Specify the FastCGI application path that processes the request. The functionality is dependent on the value of the bind-path option as follows

If you specify only app-path, the plug-in creates FastCGI applications that listens to UNIX Domain Sockets created by the plug-in. This parameter, however, is accepted only on UNIX platform. On Windows, an error message is logged.
If you specify both app-path and bind-path, the plug-in starts the specified FastCGI application process and binds them to the specified bind-path.
If you specify only bind-path, the FastCGI application is considered to be running remotely. So, the plug-in will not start the FastCGI application process.
If you do not specify both app-path and bind-path, the plug-in logs an error message.

--app-args|-A

Specify the values that are passed as arguments to the FastCGI application process. You can define multiple arguments. The format to define multiple arguments is arg1,arg2....

--bind-path|-b

See the app-path description. The value can be a UNIX domain socket name on the UNIX platform. On the Windows platform, bind-path must be specified as host:port. The value can also be a named pipe on both UNIX and Windows platforms.

--min-procs|-n

Specify the minimum number of FastCGI application processes that can be created. The default value is 1.

--max-procs|-x

Specify the maximum number of FastCGI application processes that can be created at any time. The value must be equal to or greater than the min-procs value. The default value is 1.

--chroot|-H

Specify the additional root directory that you create where the FastCGI server application runs in. The default value is the web server's root directory.

--server-user|-r

Specify the user ID of a server user. For example, root. This option is mandatory if the administration server is on UNIX. The default value is the web server's user ID.

--group|-g

Specify the name of the group to execute the FastCGI programs.

--nice|-i

Specify the nice value of FastCGI server application processes. Typically, the server is run with a nice value of 0 and the nice increment would be between 0 (the FastCGI program runs at same priority as server) and 19 (the FastCGI program runs at much lower priority than server). Do not increase the priority of the FastCGI program above that of the server by specifying a nice increment of -1.

--listen-queue-size|-l

Specify the size, in bytes, of the operating system listen queue back log. The default value is 256 bytes.

--app-env|-E

Specify the name-value pairs. that are passed as environment variables to the FastCGI application process. You can define multiple environment variables. The format to define multiple arguments is "name=value","name=value"....

--reuse-connection|-U

Specify whether the connections to the FastCGI applications are reused. The value false indicates that the connections to FastCGI applications are closed after each request and true indicates that existing connections are reused for new requests. The default value is false.

--connection-timeout|-C

If the reuse-connection option is set to true, this value specifies the time-out value, in seconds, for the pooled connections. If a connection is idle for the specified amount period of time, then the plug-in closes the connection. The default value is 5 seconds.

--response-timeout|-T

Specify the FastCGI server response time-out in seconds. If there is no response from the FastCGI application within the specified period of time, the request is discarded. The default value is 5 seconds.

--restart-interval|-l

Specify the time interval, in minutes, after which the FastCGI application restarts. If the value for this option is 0 (zero), the FastCGI application is not forced to restart. The default value is 60 minutes.

--request-retry|-q

Specify the number of times the request should be re-send when the FastCGI application rejects the request. The default value is 0 (zero).

--error-url|-L

Specify the web page, URI, or URL that FastCGI should display if an error occurs. The value of this parameter can be an absolute path, a path relative to document root, an URL, or a URI.

--error-reason|-O

Specify the FastCGI protocol error. Use this option to differentiate the error URLs to be displayed in case of any plug-in errors.

--config|-c

Specify the name of the configuration for which you want to create the FastCGI handler.

--vs|-s

Specify the name of the virtual server where you want to add the FastCGI handler.

Examples

wadm create-fastcgi-handler --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --mime-type=magnus-internal/fastcgi 
--uri-pattern=/fcgi/* --role=filter --app-path=/app-path 
--app-args=arg1,arg2,arg3 --bind-path=localhost:1111 --min-procs=2 
--max-procs=10 --chroot=/space/fastcgi --server-user=webservd 
--group=group1 --nice=1 --listen-queue-size=512 
--app-env=name1=value1,name2=value2, --reuse-connection=true
--connection-timeout=10 --response-timeout=10 --restart-interval=100 
--request-retry=1 --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-file-authdb(1)

Name

file

Synopsis

create-file-authdb <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--syntax|-t keyfile|digestfile] 
[--no-enabled|-n] --path|-P filepath --config|-c config-name 
authdb-name

Description

Use this command to create a new authentication database of type file. The authentication database of type file stores user and group information in flat files.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--vs|-s

Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.

--no-enabled|-n

Specify this option to disable the authentication database at runtime.

--syntax|-t

Specify the syntax of the file. The value can be keyfile or digestfile. The default value is keyfile.

keyfile — text file that contains the user password. It also contains the name of the group to which the user belongs.

digestfile — stores the user and group information based on the encrypted username and password. The digestfile format supports both digest and basic authentication methods.

--path|-P

Specify the location of the authentication database file.

--config|-c

Specify the name of the configuration for which you want to create the authentication database.

Operands

authdb-name: Specify the name of the authentication database that you want to create.

Examples

wadm create-file-authdb --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --path=keyfile1 KEYFILE1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-group(1)

Name

create-group– creates a new user group

Synopsis

create-group <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uid|-U user1, user2...] [--vs|-s vs-name] 
[--org-unit|-o orgunit] [--description|-D text] 
--config|-c config-name --authdb|-a name group-id

Description

Use this command to create a new user group. A user group entry contains information such as user accounts, access privileges, organization units, and other user group specific details.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uid|-U: Enter the ID of the user.
--description|-D: Enter a description for the group.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Enter a description of an organizational unit within your company to which this group belongs.
--config|-c: Specify the name of the configuration for which you want to create the user group.
--authdb|-a: Specify the name of the authentication database that will store the group information.

Operands

group-id: Specify the ID of the user group you want to create.

Examples

wadm create-group --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --authdb=LDAP1 serverhost-8989-ldap-group1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-group-member(1)

Name

create-group-member– creates a new group member

Synopsis

create-group-member <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--org-unit|-o orgunit] [--vs|-s vs-name] 
--authdb|-a name --group|-g group-id 
--config|-c config-name (uid)+

Description

Use this command to create a new group member.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--org-unit|-o: Enter a description of an organizational unit within your company to which this group member belongs.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--authdb|-a: Specify the authentication database that stores the group information.
--group|-g: Specify the ID of the group.
--config|-c: Specify the name of the configuration for which you want create group member.

Operands

uid: Specify the ID of the group member.

Examples

wadm create-group-member --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --authdb=LDAP1 --group=group1 user1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-http-listener(1)

Name

create-http-listener– creates HTTP listener socket

Synopsis

create-http-listener <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--no-enabled|-n] [--ip|-I address] 
[--acceptor-threads|-a count] [--blocking-io|-b] [--family|-f name] 
[--listen-queue-size|-l size] [--receive-buffer-size|-r size] 
[--send-buffer-size|-B size] [--description|-D text] 
[--handle-protocol-mismatch|-m] --listener-port|-P number 
--config|-c config-name --server-name|-s name 
--default-virtual-server-name|-d name listener-name

Description

Use this command to create a new HTTP listener socket. All virtual servers have an HTTP listener specified. When a new request comes in, Web Server determines which virtual server to send it to based on the configured HTTP listener.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option if you want to disable the HTTP listener at runtime.
--ip|-I: Specify the IP address of the host machine. Type `*' to set all available IP addresses.
--acceptor-threads|-a: Specify the number of threads dedicated to accept the connections received by this listener. The range of values is 1–128.
--blocking-io|-b: If you specify this option, the HTTP listener socket is in the blocking mode.
--family|-f: Specify the HTTP protocol family.
--listen-queue-size|-l: Specify the size (in bytes) of the operating system listen queue back log. The range of values is 1 - 65536.
--receive-buffer-size|-r: Specify the size (in bytes) of the operating system socket receive buffer. The range of values is 1 - 1048576.
--send-buffer-size|-B: Specify the size (in bytes) of the operating system socket send buffer. The range of values is 1 - 1048576.
--description|-D: Enter a description of the HTTP listener.
--handle-protocol-mismatch -m: If you specify this option, the server responds to SSL or non-SSL protocol mismatches in client requests with an HTTP redirect or SSL alert. The default is true, meaning the server will attempt to detect SSL or non-SSL protocol mismatches and send an HTTP redirect or SSL alert when a mismatch is detected.
--listener-port|-P: Specify the port number where the configuration binds to and listens for requests. The range of values is 1–65535.
--config|-c: Specify the name of the configuration for which you want to create the new HTTP listener socket.
--server-name|-s: Specify the name of the default server.
--default-virtual-server-name -d: Specify the name of the default virtual server that processes requests which do not match a host-pattern.

Operands

listener-name: Specify the name of the HTTP listener that you want to create.

Examples

wadm create-http-listener --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --listener-port=18033 --config=config1 
--server-name=config1.com --default-virtual-server-name=config1 
--enabled=true --ip=* --acceptor-threads=10 --blocking-io=false 
--listen-queue-size=10 --receive-buffer-size=10 --send-buffer-size=10
--description=HTTP_Listener config1_ls

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-instance(1)

Name

create-instance– creates Web Server instances

Synopsis

create-instance <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--force|-f] --config|-c config-name (nodehost)+

Description

Use this command to create Web Server instances. An instance is created for a given configuration, that is, the created instance will have all the configuration files, web applications and other characteristics of the specified configuration.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--force|-f: Specify this option to enable a forced creation of an instance. Providing this option deletes any existing instance for the specified configuration on the specified node before creating the instance.
--config|-c: Specify the name of the configuration for which you want to create the instance.

Operands

nodehost: Specify the name of the node.

Examples

wadm create-instance --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-jdbc-resource(1)

Name

create-jdbc-resource– creates a JDBC resource with the specified JNDI name

Synopsis

create-jdbc-resource <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--min-connections|-m count] 
[--max-connections|-x count] [--idle-timeout|-l time-in-seconds] 
[--wait-timeout|-o time-in-seconds] [--no-enabled|-n] 
[--isolation-level|-L level] [--isolation-level-guaranteed|-g boolean]
 [--connection-validation|-r false/auto-commit/meta-data/table]
 [--connection-validation-table-name|-t name] 
[--fail-all-connections|-f boolean] --config|-c config-name 
--datasource-class|-d name  jndi-name

Description

Use this command to create a new JDBC resource. A JDBC data source is an implementation of a data source in the Java programming language. A data source can be a complex database for a large corporation or as simple as a file with rows and columns.

You can create and manage a JDBC data source through Sun Java System Web Server. The JDBC API provides a set of classes for Java with a standard SQL database access interface to ensure uniform access to a wide range of relational databases. Using JDBC, SQL statements can be sent to virtually any database management system (DBMS). It is used as an interface for both relational and object DBMSs.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--min-connections|-m: Specify the minimum number of concurrent connections to be maintained by the database server. The range of values is 1–4096. The default value is 8.
--max-connections|-x: Specify the maximum number of concurrent connections to be maintained by the database server. The range of values is 1–4096. The default value is 32.
--idle-timeout|-l: Specify the timeout (in seconds) after which an idle connection to the database server closes. The range of values is 0–3600 and –1 for no timeout.
--wait-timeout|-o: Specify the timeout (in seconds) after which a caller waiting for an available connection to the database server will receive an error. The range of values is 0.001–3600 and –1 for no timeout.
--no-enabled|-n: Specify this option if you want to disable the JDBC resource at runtime.
--isolation-level|-L: Specify the transaction isolation level. The accepted values are read-uncommitted, read-committed, repeatable-read, or serializable.
--isolation-level-guaranteed -g: If you specify this option, the server sets the isolation level each time a connection is leased to an application. The default value is false.
--connection-validation|-r: Specify this option to indicate whether the server validates a connection before leasing it to an application. The value can be false, auto-commit, meta-data or table.
--connection-validation-table-name -t: Specify the table used when connection-validation-method is table.
--fail-all-connections|-f: If you specify this option, all connections are closed and re-established if there is an error while validating an individual connection. The default value is false.
--config|-c: Specify the name of the configuration for which you want to create the JDBC resource.
--datasource-class|-d: Specify the name of the JDBC drive class.

Operands

jndi-name: Specify the JNDI name of the JDBC resource.

Examples

wadm create-jdbc-resource --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --datasource-class=com.pointbase.jdbc.
jdbcDataSource jdbc

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-jdbc-resource-userprop(1)

Name

create-jdbc-resource-userprop– creates JDBC resource user properties

Synopsis

create-jdbc-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--description|-D text] 
[--property-type|-t type] --config|-c config-name 
--jndi-name|-j resourcename (propertyname=value)+

Description

Use this command to create JDBC resource user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the JDBC resource user property.
--config|-c: Specify the name of the configuration for which you want to create a JDBC resource user property.
--jndi-name|-j: Specify the JNDI name of the JDBC resource.
--property-type|-t: Specify the type of the JDBC resource property that you want to create. The type can be property, connection-lease-property, or connection-creation-property. The default type is property.

Operands

propertyname=value: Specify the name and value of the JDBC resource user property that you want to create.

Examples

wadm create-jdbc-resource-userprop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=jdbc info=jdbc_resource

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-jvm-options(1)

Name

create-jvm-options– creates JVM options

Synopsis

create-jvm-options <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--profiler|-rprofiler-name] [--debug-options|-d] 
--config|-c config-name (jvm_option_name=jvm_option_value)
[:jvm_option_name=jvm_option_value]*

Description

Use this command to create Java Virtual Machine (JVM) options. You must restart the server for newly created JVM options to take affect.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration for which you want to create the JVM options.
--profiler|-r: Specify the name of the JVM profiler to which these JVM options apply.
--debug-options|-d: If you specify this option, the command creates a JVM option of type debug.

Operands

jvm_option_name=jvm_option_value

Specify the name and value of the JVM option that you want to create. The left side of the equal sign (=) is the JVM option name. The right side of the equal sign (=) is the JVM option value. Use a colon (:) as a delimiter for multiple options.

Note –

While specifying the JVM options, use hyphens (--) as a delimiter. Else, the JVM options that you define will be interpreted as a CLI option.

Examples

wadm create-jvm-options --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 -Dhttp.proxyHost=proxy.bay.com 
-Dhttp.proxyPort=8080

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-jvm-profiler(1)

Name

create-jvm-profiler– creates JVM profilers

Synopsis

create-jvm-profiler <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--class-path|-l path] [--native-library-path|-t path]
 [--no-enabled|-n] --config|-c config-name

Description

Use this command to create a Java Virtual Machine (JVM) profiler. A JVM profiler helps you diagnose and resolve performance problems, memory leaks, multi-threading problems and system resource usage problems in Java applications.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--class-path|-l: Provide a valid class path for the profiler.
--native-library-path|-t: Specify the path of the native library for the profiler.
--no-enabled|-n: Specify this option to disable the JVM profiler at runtime.
--config|-c: Specify the name of the configuration for which you want to create the JVM profiler.

Operands

name: Specify the name of the JVM profiler.

Examples

wadm create-jvm-profiler --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 JVMProfiler1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-ldap-authdb(1)

Name

create-ldap-authdb– creates LDAP authentication databases

Synopsis

create-ldap-authdb <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--auth-expiring-url|-a url] [--vs|-s vs-name]
[--bind-dn|-d binddn] [--bind-password|-b bindpw] 
[--group-search-filter|-o filter] [--search-filter|-f filter]
[--group-search-attr|-t attr] [--dc-suffix|-x suffix] 
[--no-enabled|-n] --ldap-url|-l ldap://server:port/dc=acme,dc=com 
--config|-c config-name  authdb-name

Description

Use this command to create a new authentication database for a LDAP (Lightweight Directory Access Protocol) server. The LDAP database stores the user and group information.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--auth-expiring-url|-a

Specify the URL to which the server redirects the request to in case the password is about to expire soon.

--vs|-s

Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.

--bind-dn|-d

Specify the name that the Administration Server will use to initially bind (or log in) to the directory server, for example, cn=Directory Manager. Binding determines the permission level you are granted for the duration of a connection. The DN supplied in a bind request can be the DN of an alias entry.

--bind-password|-b

Specify the password for authentication. You can also define the bind-password in the password file.

--group-search-filter|-o

Specify the search filter to find group memberships for the user. The default value is uniquemember.

--search-filter|-f

Specify the search filter to use to find the user. The default value is uid.

You can use the search options to interoperate with Microsoft Active Directory (MSAD). By default, MSAD does not store the user ids in the usual uid attribute. Instead, it stores the user ids in an attribute called samAccountName. Hence, when LDAP searches a MSAD directory to find a user, it will not be able to find a match as it attempts to match on the uid attribute. In Web server 7.0 or higher, you can set the search-filter option to override the MSAD default attribute. See example.

--group-search-attr|-t

Specify the LDAP attribute name that contains group name entries. The default value is CN.

--dc-suffix|-x

Specify a suffix for the LDAP database.

--no-enabled|-n

Specify this option to disable the authentication database at runtime.

--ldap-url|-l

Specify the URL of the LDAP authentication database. The type of authentication database is specified in the URL scheme.

--config|-c

Specify the name of the configuration for which you want to create the LDAP authentication database.

Operands

authdb-name: Specify the name of the authentication database you want to create.

Examples

wadm create-ldap-authdb --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 
--ldap-url=ldap://serverhost.com:3950/dc=xyz,dc=xyz,dc=xyz 
--bind-dn=cn="Directory Manager" LDAP1

wadm create-ldap-authdb --user admin --host=serverhost 
--password-file=./admin.passwd --port=8989 --ssl=true 
--ldap-url=ldap://serverhost:port/dc=acme,dc=com 
--bind-dn=cn="Directory Manager" --group-search-filter=member 
--search-filter=samAccountName --group-search-attr=cn 
--config=config1 authdb-name

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-lifecycle-module(1)

Name

create-lifecycle-module– creates lifecycle modules

Synopsis

create-lifecycle-module <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  [--no-enabled|-n] 
[--load-order|-d order] [--no-failure-fatal|-f] 
[--class-path|-l path] [--description|-D
 text] --config|-c config-name 
--class|-C class  name

Description

Use this command to create a lifecycle module. Java Server Lifecycle Modules are Java classes that listen for server lifecycle events to perform certain tasks whenever the server reaches its various life cycle stages.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option to disable the lifecycle module at runtime.
--no-failure-fatal|-f: If you specify this option, the server will not treat exceptions thrown during lifecycle module initialization as fatal.
--class-path|-l: Specify the class path for the lifecycle module.
--load-order|-d: Specify the order in which the lifecycle module is loaded. You can choose a load-order value that is greater than or equal to 100 to avoid conflicts with internal lifecycle modules.
--description|-D: Enter a description of the lifecycle module.
--config|-c: Specify the name of the configuration for which you want to create the lifecycle module.
--class|-C: Specify the name of the class that implements the lifecycle module.

Operands

name: Specify the name of the life cycle module that you want to create.

Examples

wadm create-lifecycle-module --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --class=LifeCycleModuleImpl 
lifecycle_module1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-lifecycle-module-userprop(1)

Name

create-lifecycle-module-userprop– creates the lifecycle module user properties

Synopsis

create-lifecycle-module-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--description|-D text] 
--config|-c config-name --module|-m name 
(propertyname=value)+

Description

Use this command to create a lifecycle module user property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the lifecycle module user property.
--config|-c: Specify the name of the configuration for which you want to create the lifecycle module user properties.
--module|-m: Specify the name of the lifecycle module.

Operands

propertyname=value: Specify the name and value of the lifecycle module property that you want to create.

Examples

wadm create-lifecycle-module-userprop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--module=Lifecycle1 info=creating

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-mail-resource(1)

Name

create-mail-resource– creates a mail resource

Synopsis

create-mail-resource <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--no-enabled|-n] [--description|-D text] 
--config|-c config-name  jndi-name

Description

Use this command to create a mail resource. Java mail sessions are J2EE resources that can be created and managed through Sun Java System Web Server. Many internet applications require the ability to send email notifications. J2EE platform includes the JavaMail API along with a JavaMail service provider that allows an application component to send emails.

The JavaMail API has two parts:

An application-level interface used by the application components to send mail.
A service provider interface used at the J2EE API level.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify the option to disable the mail resource at runtime.
--description|-D: Enter a description for the mail resource being created.
--config|-c: Specify the name of the configuration for which you want to create the mail resource.

Operands

jndi-name: Specify the JNDI name of the mail resource.

Examples

wadm create-mail-resource --user=admin --host=serverhost
--password-file=../admin.passwd--port=8989 --ssl=true --no-prompt
--rcfile=null --config=config1 MailResource1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-mail-resource-userprop(1)

Name

create-mail-resource-userprop– creates the mail resource user properties

Synopsis

create-mail-resource-userprop <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] [--description|-D text]
--config|-c config-name--jndi-name|-j resourcename
(propertyname=value)+

Description

Use this command to create the mail resource user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the mail resource user property.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the mail resource.

Operands

propertyname=value: Specify the name and value of mail resource user property that you want to create.

Examples

wadm create-mail-resource-userprop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=MailReso mail host=mail-host.com mail
from=root@localhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-mime-type(1)

Name

create-mime-type– creates MIME types

Synopsis

create-mime-type <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--vs|-s vs-name] [--category|-y type|enc|lang] 
--config|-c config-name --extensions|-x [fileSuffix,...]
 content-type

Description

Use this command to create a MIME (Multi-purpose Internet Mail Extension) type. MIME types determine the various types of multimedia files that your mail system supports.

You need not create a separate MIME types file for each virtual server. Instead, you can create as many MIME types files as you require and associate them with a virtual server. By default, one MIME types file (mime.types) exists on the server and cannot be deleted.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--category|-y: Specify the category of the MIME types. The value can be type, enc, or lang.
--config|-c: Specify the name of the configuration for which you want to create the MIME type.
--extensions|-x: Specify the file extension for the MIME value. To define multiple file extensions, separate them by a comma (,). For example, for text and HTML MIME value, the file extension is txt,html.

Operands

content-type: Specify the content type of the MIME types.

Examples

wadm create-mime-type --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 application/sxc

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-pam-authdb(1)

Name

create-pam-authdb– creates a new authentication database of type PAM.

Synopsis

create-pam-authdb <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--no-enabled|-n] 
--config|-c config-name  authdb-name

Description

Use this command to create a new authentication database of type PAM. PAM is the native authentication database supported by Sun Java System Web Server 7.0. This authentication database is supported only on the Solaris platform.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--no-enabled|-n: Specify this option to disable this authentication database at runtime.
--config|-c: Specify the name of the configuration for which you want to create the authentication database.

Operands

authdb-name: Specify the name of the authentication database that you want to create.

Examples

wadm create-pam-authdb --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 PAM1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-reverse-proxy(1)

Name

create-reverse-proxy– creates a reverse proxy

Synopsis

create-reverse-proxy <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name  --uri-prefix|-r uri-prefix 
--server|-S remote-server-url

Description

Use this command to create a reverse proxy. A reverse proxy is a proxy that appears to be a Web Server (origin server) to clients but in reality forwards the requests it receives to one or more origin servers. Because a reverse proxy presents itself as an origin server, clients do not need to be configured to use a reverse proxy.

By configuring a reverse proxy to forward requests to multiple similarly configured origin servers, a reverse proxy can operate as an application level software load balancer. In a typical deployment, one or more reverse proxies will be deployed between the browsers and the origin servers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration for which you want to create the reverse proxy.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix for the reverse proxy that you create.
--server|-S: Specify the remote server URLs. Use comma (,) to define multiple URLs. If you define multiple URLs, the server will distribute the load among the specified servers.

Examples

wadm create-reverse-proxy --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-prefix=/simple/ 
--server=http://sun.com:8080

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-search-collection(1)

Name

create-search-collection– creates search collections

Synopsis

create-search-collection <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--path|-P path] [--display-name|-y name] 
[--no-enabled|-n] [--index-meta-tag|-m key1, key2, ...] 
[--include-extensions|-t ext1,ext2,..] [--description|-D text] 
--vs|-s vs-name --config|-c config-name
 --document-root|-d path collection-name

Description

Use this command to create a search collection. Searches require a database of searchable data against which users will search. You can create a collection, which indexes and stores information about documents on the server. Once you index all or some of the documents, information such as title, creation date, and author is available for search.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option to disable this search collection at runtime.
--display-name|-y: Enter a name of the search collection that is displayed to users.
--path|-P: Specify the path to the directory system where the search collection metadata is stored.
--description|-D: Enter a description of the search collection.
--index-meta-tags|-m: Specify document fields that are used for indexing. Use comma (,) to specify multiple fields. For example, subject.
--include-extensions|-t: Specify the file extensions of document type to be indexed. The values can be html, htm, txt, and pdf. Use comma (,) to specify multiple extensions.
--document-root|-d: Specify the file system documents root directory for the searchable documents.
--config|-c: Specify the name of the configuration for which you want to create the search collection.
--vs|-s: Specify the name of the virtual server.

Operands

collection-name: Specify the name of the collection that you want create.

Examples

wadm create-search-collection --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs 
--document-root=../docs searchcoll

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-search-event(1)

Name

create-search-event– creates a new search event

Synopsis

create-search-event <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--pattern|-P pattern] 
[--encoding|-g encoding] [--no-subdirs|-S] ((--time|-t hh:mm 
[--month|-m 1-12] 
[--day-of-week|-k sun/mon/tue/wed/thu/fri/sat] 
[--day-of-month|-d 1-31]) |
--interval|-r 60-86400(seconds)) [--no-enabled|-n] 
--config|-c config-name --vs|-s vs-name 
--collection|-O name --command|-C add-documents|reindex

Description

Use this command to create a new search event. You can schedule tasks to be performed on collections at regular intervals.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--time|-t: Specify a time when this search event is scheduled.
--day-of-month|-d: Specify the day of the month when this search event is scheduled. The range of values is 1–31.
--day-of-week|-k: Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--interval|-r: Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
--month|-m: Specify the month when this search event is scheduled. The range of values is 1 to 12.
--no-enabled|-n: Specify this option to disable the search event at runtime.
--encoding|-g: Specify the character encoding for the documents to be re-indexed. The default is ISO-8859-1. The indexing engine tries to determine the encoding of HTML documents from the embedded meta tag.
--no-subdirs|-S: If you specify this option, sub directories of the document root will not be searched.
--pattern|-P: Specify the wild card pattern of the documents.
--command|-C: Specify the task the search event should execute. The value can be add-documents or reindex. The value add-documents adds files to an existing collection and reindex re-indexes the specified collection.
--config|-c: Specify the name of the configuration for which you want to create the event.
--vs|-s: Specify the name of the virtual server.
--collection|-O: Specify the name of the collection for which you need to schedule an event.

Examples

wadm create-search-event --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --time=10:10 
--command=add-documents --collection=collection1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-selfsigned-cert(1)

Name

create-selfsigned-cert– creates self-signed certificates

Synopsis

create-selfsigned-cert <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--org-unit|-o unit] [--state|-a name]
[--locality|-l place] [--token|-t name]
[--token-pin|-P pin] [-validity|-d num of months]
[--org|-g org] [--country|-y name]
[--key-type|-k (rsa|ecc)] [--key-size|-z size]
[--curve|-r curvename] [--alt-server-name| -A dns-name] --config|-c config-name --server-name|-s name 
--nickname|-n nickname

Description

Use this command to create a new self-signed certificate.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--token|-t: Specify the token (cryptographic device) name, which contains the encrypted public key.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--org-unit|-o: Enter a description of an organizational unit within your company.
--locality|-l: Enter a description of the city, principality, or country of the organization.
--state|-a: Specify the state or province where the business is located.
--validity|-d: Specify the validity of the certificate.
--org|-g: Enter the official name of your company, educational institution, or organization.
--country|-y: Enter a two-character abbreviation of your country's name (in ISO format). For example, the country code for the United States is US.
--key-type|-k: Specify the type of the certificate key. The key types can be rsa or ecc.
--key-size|-z: Specify the size of certificate key. This option is applicable only if the key-type is rsa. The key size can be 1024, 2048 or 4098.
--curve|-r: Specify the name of key curve. This option is applicable if you specify the key-type as ecc. The key curves can be prime256v1, secp256r1, nistp256, secp256k1, secp384r1, nistp384, secp521r1, nistp521, sect163k1, nistk163, sect163r1, sect163r2, nistb163, sect193r1, sect193r2, sect233k1, nistk233k1, nistk233, sect233r1, nistb233, sect239k1, sect283k1, nistk283, sect283r1, nistb283, sect409k1, nistk409, sect571k1, nistk571, sect571r1, nistb571, secp160k1, secp160r1, secp160r2, secp192k1, secp192r1, nistp192, secp224k1, secp224r1, nistp224 or prime192v1.
--config|-c: Specify the name of the configuration for which you want to create the certificate.
--server-name|-s: Specify the host name of the server for which you are creating a self-signed certificate.
--alt-server-name|-A: (This option is deprecated. A list of domain names can be added in the server name, separated by commas.) Specify the domain names of the host provided in the server-name option.
--nickname|-n: Enter a nick name for the certificate that you want to create.

Examples

wadm create-selfsigned-cert --user=admin --port=8989 
--password-file=../admin.pwd --config=config1 --token=internal 
--org-unit=org1 --locality=XYZ --state=DEF --validity=10 
--org=sun --country=ABC --server-name=serverhost --nickname=cert1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-soap-auth-provider(1)

Name

create-soap-auth-provider– creates SOAP authentication provider

Synopsis

create-soap-auth-provider <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--request-policy-auth-source|-r auth_src] 
[--request-policy-auth-recipient|-q auth_recipient]
 [--response-policy-auth-source|-S auth_source] 
[--response-policy-auth-recipient|-o auth_recipient]
 --class|-C provider_class --config|-c config-name 
provider_name

Description

Use this command to create a SOAP (Simple Object Access Protocol) authentication provider.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--request-policy-auth-source -r: Specify the type of source authentication. This option defines a requirement for the message layer sender authentication. The type of authentication can be sender authentication such as username/password or content authentication such as digital signature. If you do not specify this option, source authentication of the request is not required.
--request-policy-auth-recipient -q: Specify the type of recipient authentication. This option defines a requirement for message layer authentication for the receiver of a message, for example, by XML encryption. The value can be before-content or after-content.
--response-policy-auth-source -S: This option defines a requirement for message layer sender authentication such as username/password or content authentication such as digital signature to be applied to response messages.The type of authentication can be sender or content. If you do not specify this option, source authentication of the response is not required.
--response-policy-auth-recipient -o: This option defines a requirement for message layer authentication of the receiver of the response message to its sender, for example, by XML encryption.
--config|-c: Specify the name of the configuration for which you want to create the SOAP authentication provider.
--class|-C: Specify the class that implements the provider. The value of this option is a class name that implements javax.security.auth.XXX.

Operands

provider_name: Specify the name of the SOAP authentication provider.

Examples

wadm create-soap-auth-provider --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --class=javax.security.auth
.soapauthprovider soap-auth

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-soap-auth-provider-userprop(1)

Name

create-soap-auth-provider-userprop– creates SOAP authentication provider user properties

Synopsis

create-soap-auth-provider-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--description|-D text] 
--config|-c config-name --provider|-o name 
(propertyname=value)+

Description

Use this command to create the SOAP (Simple Object Access Protocol) authentication provider user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Enter a description of the SOAP authentication user property.
--config|-c: Specify the name of the configuration for which you want to create the SOAP authentication user properties.
--provider|-o: Specify the name of the SOAP authentication provider.

Operands

propertyname=value: Specify the name and value of the SOAP authentication provider user property that you want to create.

Examples

wadm create-soap-auth-provider-userprop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--provider=soap-auth info=soapauthproperty

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-url-redirect(1)

Name

create-url-redirect– creates a forwarding URL

Synopsis

create-url-redirect <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--fixed-url|-f] [--uri-prefix|-r uri-prefix| 
--condition|-C regex] --vs|-s vs-name 
--target-url|-t url --config|-c config-name

Description

Use this command to create a forwarding URL. URL redirection allows you to redirect document requests for one HTTP URL to another. Web Server uses the URL redirection method to inform users that a URL has changed (for example, if you have moved files to another directory or server).

Sometimes you may want to redirect requests for all documents in a sub directory to a new URL. For example, if you remove a directory because it was causing too much traffic or because the documents will no no longer be served, you can redirect a request for any one the documents to a page explaining why the documents were no longer available. For example, a prefix on ../info/products could be redirected to http://www.new.com/explain.html.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--uri-prefix|-r

Specify the URI prefix you want to redirect.

--condition|-C

Specify the URL redirect condition, whereby you can configure the server to redirect the URL based on the <If> condition. For example,

<If $path =~ "/foo(.*)bar(.*)">

NameTrans fn="redirect" url="/baz$2qux$1"

</If>

Note –

The uri-prefix and condition options are mutually exclusive.

--target-url|-t

Specify the target URL to which the requests should be redirected.

--fixed-url|-f

Specify this option if the destination URL is a fixed URL. Fixed URLs are static URLs like a link to a HTML page. Non-fixed URLs are dynamic URLs with request parameters or URLs with prefixes. By default, this option is set to false.

--config|-c

Specify the name of the configuration for which you want to create a forwarding URL.

--vs|-s

Specify the name of the virtual server.

Examples

wadm create-url-redirect --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-prefix=/redirect 
--target-url=http://www.cnet.com --fixed-url=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-user(1)

Name

create-user– creates new users

Synopsis

create-user <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--org-unit|-o orgunit] 
[--first-name|-f name] [--full-name|-F name] 
[--last-name|-n name] [--user-password|-W] 
[--email|-m address] [--phone|-t usercontact] 
[--title|-i title] [--realm|-L realm] 
--config|-c config-name --authdb|-a name userid

Description

Use this command to create a new Web Server user. A user entry contains information about an individual user such as, user accounts, access privileges, organization units, and other user specific information.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--first-name|-f: Specify the first name of the user.
--full-name|-F: Specify the full name of the user.
--last-name|-n: Specify the surname or last name of the user.
--user-password|-W: Specify the password for the user being created. You can also define the user-password in the password file.
--email|-m: Specify the email address of the user.
--phone|-t: Specify the contact number of the user.
--title|-i: Specify the title of the user.
--org-unit|-o: Enter a description of an organizational unit within your company to which this user belongs.
--realm|-L: Specify the realm that authenticates this user.
--config|-c: Specify the name of the configuration for which you want to create the user.
--authdb|-a: Specify the authentication database that will store the user information.

Operands

userid: Specify a unique ID of the user being created.

Examples

wadm create-user --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --full-name=ldap-config1-u1 --authdb=LDAP1 
serverhost-8989-ldap-config1-u1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-variable(1)

Name

server.xml

Synopsis

create-variable <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--description|-D text]
--config|-c config-name (var-name=value)+

Description

Use this command to create a server.xml variable. You can create a variable at the server as well as the virtual server levels.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--description|-D: Type a description of the server.xml variable that you want to create.
--vs|-s: Specify the name of the virtual server for which you want to create a variable.
--config|-c: Specify the name of the configuration for which you want to create a variable.

Operands

var-name=value: Specify the name and value of the variable you want to create.

Examples

wadm create-variable --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs 
--description=variable1 user=user1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

create-virtual-server(1)

Name

create-virtual-server– creates a new virtual server

Synopsis

create-virtual-server <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--http-listener-name|-l lsid] [--host-pattern|-t
 pattern1, pattern2 ...] [--canonical-server-name|-n hostname] 
[--log-file|-f path] [--document-root|-d path] 
--config|-c config-name virtual-server-name

Description

Use this command to create a new virtual server. The settings for virtual servers are stored in the server.xml file in the server_root/server_ID/config directory. All virtual servers have an HTTP listener specified. When a new request comes in, the Web Server determines which virtual server to send it to based on the configured HTTP listener.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--http-listener-name|-l: Specify the name of an HTTP listener associated with one or more of the virtual server's host names.
--host-pattern|-t: Define a list of hosts to be added to the new virtual server. To specify multiple URLs, separate them by a comma (,).
--canonical-server-name|-n: Specify a canonical host name of the virtual server. Requests that use a different host name will be redirected to this host name.
--log-file|-f: Specify a log file for the ACL file that controls access to the virtual server.
--document-root|-d: Specify the document root for the virtual server.
--config|-c: Specify the configuration where you want to create a new virtual server.

Operands

virtual-server-name: Specify the name of the virtual server.

Examples

wadm create-virtual-server --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --host-pattern=eas157,eas156 
--canonical-server-name=oldiws --log-file=log-file 
--document-root=../docs vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-acl(1)

Name

delete-acl– deletes access control lists

Synopsis

delete-acl <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
(aclname)+

Description

Use this command to delete access control list (ACL).

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which the stored access control lists are to be deleted.

Operands

aclname: Specify the name of the ACL that you want to delete.

Examples

wadm delete-acl --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs acl_vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-authdb(1)

Name

delete-authdb– deletes an authentication database

Synopsis

delete-authdb <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
 authdb-name

Description

Use this command to delete an authentication database.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the fully functioning virtual Web Server that resides within the same physical location of the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which the authentication database is being deleted.

Operands

authdb-name: Specify the name of the authentication database.

Examples

wadm delete-authdb --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 DIGESTFILE1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-authdb-userprop(1)

Name

delete-authdb-userprop– deletes the authentication database user properties

Synopsis

delete-authdb-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] 
--config|-c config-name --authdb|-a dbname 
(propertyname)+

Description

Use this command to delete the authentication database user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration.
--authdb|-a: Specify the name of the authentication database.

Operands

propertyname: Specify the name of the authentication database user property that you want to delete.

Examples

wadm delete-authdb-userprop --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --authdb=LDAP1 info

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-auth-realm(1)

Name

delete-auth-realm– deletes an authentication realm

Synopsis

delete-auth-realm <connect_options>[--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  realm-name

Description

Use this command to delete an authentication realm.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

realm-name: Specify the name of the authentication realm that you want to delete.

Examples

wadm delete-auth-realm --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 basic

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-auth-realm-userprop(1)

Name

delete-auth-realm-userprop– deletes the authentication realm user properties

Synopsis

delete-auth-realm-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--realm|-L name (propertyname)

Description

Use this command to delete an authentication realm user property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--realm|-L: Specify the name of the authentication realm.

Operands

propertyname: Specify the name of the authentication realm user property that you want to delete.

Examples

wadm delete-auth-realm-userprop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --realm=basic info

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-cert(1)

Name

delete-cert– deletes a certificate

Synopsis

delete-cert <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--force|-f] [--token|-t name] 
[--token-pin|-P name] --config|-c config-name 
nickname

Description

Use this command to delete a certificate.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--force|-f: Specify this option to enable a forced deletion of a certificate.
--token|-t: Specify the token (cryptographic device) name, which contains the encrypted public key.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--config|-c: Specify the name of the configuration for which you are deleting the certificate.

Operands

nickname: Specify the short name or the nick name of the certificate you want to delete.

Examples

wadm delete-cert --user=admin --host=serverhost --port=8989 
--ssl=true --prompt=false --rcfile=null --password-file=certdb.newpasswd
--config=config1 --token=internal cert2

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-cgi-dir(1)

Name

delete-cgi-dir– deletes a CGI directory

Synopsis

delete-cgi-dir <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name  
--uri-prefix|-r uri-prefix

Description

Use this command to delete a common gateway interface (CGI) directory.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration for which the CGI directory is being deleted.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--uri-prefix|-r: Specify the name of the URI prefix to use for the CGI directory. This prefix appears as the directory for the CGI programs in URLs.

Examples

wadm delete-cgi-dir --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs --uri-prefix=/config1_urlprefix

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-cgi-envvar(1)

Name

delete-cgi-envvar– deletes a CGI environment variable

Synopsis

delete-cgi-envvar <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name  (varname)+

Description

Use this command to delete a common gateway interface (CGI) environment variable.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration for which the CGI environment variable that is being deleted.

Operands

varname: Specify the name of the CGI environment variable being deleted.

Examples

wadm delete-cgi-envvar --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 timeout idle-timeout cgistub-path cgistub-idle-timeout
min-cgistubs max-cgistubs nice

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-config(1)

Name

delete-config– deletes an existing configuration

Synopsis

delete-config <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] config-name

Description

Use this command to delete a configuration. Configuration with the specified name will be deleted from install-dir/admin-server/config-store. You can delete a configuration only if the configuration has no server instances referring to it.

Do not edit any file under the config-store directory. The files under this directory are created by Sun Java System Web Server for internal use.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

config-name: Specify the name of the configuration you want to delete.

Examples

wadm delete-config --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-crl(1)

Name

delete-crl– deletes a CRL

Synopsis

delete-crl <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name issuername

Description

Use this command to delete a CRL (certificate revocation list).

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration from which the CRL is being deleted.

Operands

issuername: Specify the name of the CRL issuer.

Examples

wadm delete-crl --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 "GlobalSign ServerSign CA"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-custom-resource(1)

Name

delete-custom-resource– deletes a custom resource

Synopsis

delete-custom-resource <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
resource-name

Description

Use this command to delete a custom resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

resource-name: Specify the name of the custom resource that you want to delete.

Examples

wadm delete-custom-resource --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 custom

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-custom-resource-userprop(1)

Name

delete-custom-resource-userprop– deletes a custom resource property

Synopsis

delete-custom-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--jndi-name|-j resourcename  (propertyname)+

Description

Use this command to delete a custom resource property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the custom resource.

Operands

propertyname: Specify the name of the custom resource property that you want to delete.

Examples

wadm delete-custom-resource-userprop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=custom custresourceprop1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-dav-collection(1)

Name

delete-dav-collection– deletes DAV collections

Synopsis

delete-dav-collection <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  --config|-c config-name 
--uri|-r uri-prefix --vs|-s vs-name

Description

Use this command to delete a DAV collection.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--uri|-r: Specify the URI through which the content is accessed.
--vs|-s: Specify the name of the virtual server where the WebDAV collection exists.

Examples

wadm delete-dav-collection --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri=/dav_config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-document-dir(1)

Name

delete-document-dir– deletes a document directory

Synopsis

delete-document-dir <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name --vs|-s vs-name 
--uri-prefix|-r uri-prefix

Description

Use this command to delete a document directory.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration where the document directory exists.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix that has to be mapped to a directory.

Examples

wadm delete-document-dir --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-prefix=/config1_uri

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-error-page(1)

Name

delete-error-page– deletes error pages

Synopsis

delete-error-page <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name --code|-d errorcode

Description

Use this command to delete an error page.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--code|-d: Specify the error code.

Examples

wadm delete-error-page --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs --code=500

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-event(1)

Name

delete-event– deletes an existing event

Synopsis

delete-event <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--time|-t hh:mm] [--month|-m 1-12] 
[--day-of-month|-d 1-31] [--day-of-week|-k sun/mon/tue/wed/thu/fri/sat]
[--interval|-r 60-86400(seconds)] --config|-c config-name 
--command|-C restart|reconfig|rotate-log|rotate-access-log
|update-crl|commandline

Description

Use this command to delete a scheduled event.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--time|-t: Specify the time you want this event start. The time format is hh:mm, for example, 12:30.
--month|-m: Specify the month you want this event to occur. The range of values is 1–12.
--day-of-week|-k: Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--day-of-month|-d: Specify the day of the month you want this event to occur. The range of values is 1–31.
--interval|-r: Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
--config|-c: Specify the name of the configuration.
--command|-C: Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.

Examples

wadm delete-event --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--time=20:30 --month=11 --day-of-week=mon --day-of-month=15 
--interval=3600 --config=config1 --time=10:10 --command=restart

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-external-jndi-resource(1)

Name

delete-external-jndi-resource– deletes an external JNDI resource

Synopsis

delete-external-jndi-resource <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name jndi-name

Description

Use this command to delete an external Java Naming and Directory Interface (JNDI) resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

jndi-name: Specify the name of the enternal JNDI resource that you want to delete.

Examples

wadm delete-external-jndi-resource --user=admin 
--host=serverhost --password-file=../admin.passwd --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 jndi1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-external-jndi-resource-userprop(1)

Name

delete-external-jndi-resource-userprop– deletes an external JNDI resource property

Synopsis

delete-external-jndi-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--jndi-name|-j resourcename (propertyname)+

Description

Use this command to delete an external Java Naming and Directory Interface (JNDI) resource property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the name of the external JNDI resource.

Operands

propertyname: Specify the name of the external JNDI resource property that you want to delete.

Examples

wadm delete-external-jndi-resource-userprop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=external-jndi info

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-fastcgi-handler(1)

Name

delete-fastcgi-handler– deletes a FastCGI handler

Synopsis

delete-fastcgi-handler <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--mime-type|-m type] [--uri-pattern|-t pattern] 
[--role|-o authorizer|responder|filter|error] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to delete a FastCGI handler.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--mime-type|-m

Specify the MIME type.

--uri-pattern|-t

Specify the URI pattern.

--role|-o

Specify the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.

In the responder role, the FastCGI application receives all information associated with an HTTP request and generates a response.
In the authorizer role, the FastCGI application receives all information associated with an HTTP request and generates an authorized or unauthorized decision.
In the filter role, the FastCGI application receives all information associated with an HTTP request and additional data from a file stored on the web server, and generates a filtered version of the data stream as an HTTP response.
In the error role, the FastCGI application terminates if an error occurs. You can configure the application to display a specific page or redirect the request to a URL if an error occurs.

--config|-c

Specify the name of the configuration for which you want to delete the FastCGI handler.

--vs|-s

Specify the name of the virtual server.

Examples

wadm delete-fastcgi-handler --user=admin --host=serverhost 
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --mime-type=magnus-internal/fcgi 
--uri-pattern=/fcgi/* --role=filter --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-group(1)

Name

delete-group– deletes user groups

Synopsis

delete-group <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--org-unit|-o ou] 
--config|-c config-name --authdb|-a name group-id

Description

Use this command to delete a user group.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Give a description of an organizational unit within your company to which this user belongs.
--authdb|-a: Specify the authentication database where the group information is stored.

Operands

group-id: Specify the ID of the user group that you want to delete.

Examples

wadm delete-group --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --authdb=LDAP1 serverhost-8989-ldap-config1-g1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-group-member(1)

Name

delete-group-member– deletes group members

Synopsis

delete-group-member <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--vs|-s vs-name] [--org-unit|-o orgunit] 
--config|-c config-name --authdb|-a name 
--group|-g group-id  (uid)+

Description

Use this command to delete an existing group member.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the fully functioning virtual Web server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Give a description of an organizational unit within your company to which this group member belongs.
--authdb|-a: Specify the authentication database in which the group information is stored.
--group|-g: Specify the ID of the group.

Operands

uid: Specify the ID of the group member.

Examples

wadm delete-group-member --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --authdb=keyfile 
--group=group1 user1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-home-page(1)

Name

delete-home-page– deletes the home page

Synopsis

delete-home-page <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name

Description

Use this command to delete the home page.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm delete-home-page --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-http-listener(1)

Name

delete-http-listener– deletes HTTP listener socket

Synopsis

delete-http-listener <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--force|-f] --config|-c config-name  listener-name

Description

Use this command to delete a HTTP listener socket.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--force|-f: Specify this option to enable a forced deletion of the HTTP listener.
--config|-c: Specify the name of the configuration where the HTTP listener socket exists.

Operands

listener-name: Specify the name of the HTTP listener that you want to delete.

Examples

wadm delete-http-listener --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --force http_ls1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-instance(1)

Name

delete-instance– deletes instance(s)

Synopsis

delete-instance <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--save-logs|-S] [--force|-f] 
--config|-c config-name (nodehost)+

Description

Use this command to delete instances of the specified configuration and nodes.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--force|-f: Specify this option to enable a forced deletion of an instance.
--save-logs|-S: Specify this option to save the logs while deleting an instance.
--config|-c: Specify the name of the configuration that the instance points to.

Operands

nodehost: Specify the name of the node.

Examples

wadm delete-instance --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-jdbc-resource(1)

Name

delete-jdbc-resource– deletes JDBC resources

Synopsis

delete-jdbc-resource <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  jndi-name

Description

Use this command to delete a JDBC resource from the named configuration.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

jndi-name: Specify the JNDI name of the JDBC resource.

Examples

wadm delete-jdbc-resource --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 jdbc

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-jdbc-resource-userprop(1)

Name

delete-jdbc-resource-userprop– deletes the JDBC resource properties

Synopsis

delete-jdbc-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--property-type|-t type] 
--config|-c config-name--jndi-name|-j resourcename 
(propertyname)+

Description

Use this command to delete a JDBC resource property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--property-type|-t: Specify the type of the JDBC resource property. The types of property can be property, connection-lease-property, or connection-creation-property. The default type is property.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the JDBC resource.

Operands

propertyname: Specify the name of the JDBC resource property that you want to delete.

Examples

wadm delete-jdbc-resource-userprop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=jdbc info

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-jvm-options(1)

Name

delete-jvm-options– deletes JVM options

Synopsis

delete-jvm-options <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--profiler|-r profiler-name] [--debug-options|-d]
--config|-c config-name (jvm_option_name=jvm_option_value)
[:jvm_option_name=jvm_option_value]*

Description

Use this command to delete the Java Virtual Machine (JVM) options.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--profiler|-r: Specify the name of the JVM profiler to which these JVM options apply to.
--debug-options|-d: If you specify this option, the JVM options of type debug is deleted.

Operands

jvm_option_name=jvm_option_value

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.

Note –

While specifying the JVM options, use hyphens (--) as a delimiter. Else, the JVM options that you define will be interpreted as a CLI option.

Examples

wadm delete-jvm-options --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 -Dhttp.proxyHost
=proxyHost.com -Dhttp.proxyPort=8080

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-jvm-profiler(1)

Name

delete-jvm-profiler– deletes JVM profilers

Synopsis

delete-jvm-profiler <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name name

Description

Use this command to delete a Java Virtual Machine (JVM) profiler.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

name: Specify the name of the JVM profiler that you want to delete.

Examples

wadm delete-jvm-profiler --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 jvmprofiler1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-lifecycle-module(1)

Name

delete-lifecycle-module– deletes lifecycle modules

Synopsis

delete-lifecycle-module <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name name

Description

Use this command to delete a lifecycle module.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

name: Specify the name of the life cycle module that you want to delete.

Examples

wadm delete-lifecycle-module --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true
--no-prompt --rcfile=null --config=config1 LifecycleMod

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-lifecycle-module-userprop(1)

Name

delete-lifecycle-module-userprop– deletes the lifecycle module properties

Synopsis

delete-lifecycle-module-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--module|-m name  (propertyname)+

Description

Use this command to delete a lifecycle module property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--module|-m: Specify the name of the life cycle module.

Operands

propertyname: Specify the name of the lifecycle module property that you want to delete.

Examples

wadm delete-lifecycle-module-userprop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true
--no-prompt --rcfile=null --config=config1 --module=LifecycleMod info

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-mail-resource(1)

Name

delete-mail-resource– deletes mail resources

Synopsis

delete-mail-resource <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name jndi-name

Description

Use this command to delete a mail resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

jndi-name: Specify the JNDI name of the mail resource.

Examples

wadm delete-mail-resource --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 MailReso

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-mail-resource-userprop(1)

Name

delete-mail-resource-userprop– deletes the mail resource user properties

Synopsis

delete-mail-resource-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  --config|-c config-name 
--jndi-name|-j resourcename  (propertyname)+

Description

Use this command to delete the mail resource user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the mail resource.

Operands

propertyname: Specify the name of mail resource user property that you want to delete.

Examples

wadm delete-mail-resource-userprop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=MailReso mail.user

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-mime-type(1)

Name

delete-mime-type– deletes MIME types

Synopsis

delete-mime-type <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--vs|-s vs-name] [--category|-y type|enc|lang]
--config|-c config-name  content-type

Description

Use this command to delete a MIME (Multi-purpose Internet Mail Extension) type.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of a virtual server.
--category|-y: Specify the category of the MIME types. The value can be type, enc, or lang.
--config|-c: Specify the name of the configuration.

Operands

content-type: Specify the content type to be deleted.

Examples

wadm delete-mime-type --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 appl/sxc

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-reverse-proxy(1)

Name

delete-reverse-proxy– deletes a reverse proxy

Synopsis

delete-reverse-proxy <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name --vs|-s vs-name 
--uri-prefix|-r uri-prefix

Description

Use this command to delete a reverse proxy.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix of the reverse proxy that you want to delete.

Examples

wadm delete-reverse-proxy --user=admin --host=serverhost 
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-prefix=/simple/

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-search-collection(1)

Name

delete-search-collection– deletes search collections

Synopsis

delete-search-collection <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name collection-name

Description

Use this command to delete a search collection.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

collection-name: Specify the name of the search collection that you want to delete.

Examples

wadm delete-search-collection --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs searchcoll2

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-search-event(1)

Name

delete-search-event– deletes a search event

Synopsis

delete-search-event <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--no-enabled|-n] [--encoding|-g encoding]
[--no-subdirs|-S] [--pattern|-P pattern] 
((--time|-t hh:mm] [--month|-m 1-12]
[--day-of-week|-k sun/mon/tue/wed/thu/fri/sat] 
[--day-of-month|-d 1-31])|
--interval|-r 60-86400(seconds)) --config|-c config-name 
--vs|-s vs-name --collection|-O name 
--command|-C add-documents|reindex

Description

Use this command to delete a search event.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-enabled|-n: Specify this option to disable the search event at runtime.
--time|-t: Specify a time when this search event is scheduled.
--day-of-month|-d: Specify the day of the month when this search event is scheduled. The range of values is 1–31.
--day-of-week|-k: Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--interval|-r: Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
--month|-m: Specify the month when this search event is scheduled. The range of values is 1 to 12.
--command|-C: Specify the task the search event executes. The value can be add-documents or reindex.
--encoding|-g: Specify the character encoding for the documents to be re-indexed. The default is ISO-8859-1. The indexing engine tries to determine the encoding of HTML documents from the embedded meta tag.
--no-subdirs|-S: If you specify this option, sub directories of the document root will not be searched.
--pattern|-P: Specify the wild card pattern of the documents.
--config|-c: Specify the name of the configuration for which you want to delete the search event.
--vs|-s: Specify the name of the virtual server.
--collection|-O: Specify the name of the collection.

Examples

wadm delete-search-event --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --time=20:30 
--month=11 --day-of-week=mon --day-of-month=15 --interval=3600
--command=reindex --collection=collection1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-soap-auth-provider(1)

Name

delete-soap-auth-provider– deletes SOAP authentication provider

Synopsis

delete-soap-auth-provider <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
provider_name

Description

Use this command to delete a SOAP authentication provider.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

provider_name: Specify the name of the SOAP authentication provider that you want to delete.

Examples

wadm delete-soap-auth-provider --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 soap-auth

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-soap-auth-provider-userprop(1)

Name

delete-soap-auth-provider-userprop– deletes the SOAP authentication provider properties

Synopsis

delete-soap-auth-provider-userprop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--provider|-o name  (propertyname)*

Description

Use this command to delete a SOAP authentication provider property.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--provider|-o: Specify the name of the SOAP authentication provider.

Operands

propertyname: Specify the name of the SOAP authentication provider property that you want to delete.

Examples

wadm delete-soap-auth-provider-userprop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--provider=soap-auth info

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-url-redirect(1)

Name

delete-url-redirect– deletes a forwarding URL

Synopsis

delete-url-redirect <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-prefix|-r uri-prefix
|--condition|-C regex] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to delete a forwarding URL.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix you want to redirect. The uri-prefix and condition options are mutually exclusive.
--condition|-C: Specify the URL redirect condition. The condition and uri-prefix options are mutually exclusive.

Examples

wadm delete-url-redirect --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-prefix=/redirect

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-user(1)

Name

delete-user– deletes users

Synopsis

delete-user <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--org-unit|-o ou] 
[--realm|-L realm] --config|-c config-name 
--authdb|-a name userid

Description

Use this command to delete an existing user.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Give a description of an organizational unit within your company to which this user belongs.
--config|-c: Specify the name of the configuration.
--authdb|-a: Specify the name of the authentication database that stores the user information.
--realm|-L: Specify the name of the realm that authenticates this user.

Operands

userid: Specify the ID of the user to be deleted.

Examples

wadm delete-user --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --authdb=keyfile1 user1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-variable(1)

Name

server.xml

Synopsis

delete-variable <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
(varname)+

Description

Use this command to delete a server.xml variable.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

varname: Specify the name and value of the variable you want to delete.

Examples

wadm delete-variable --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs foo

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

delete-virtual-server(1)

Name

delete-virtual-server– deletes virtual servers

Synopsis

delete-virtual-server <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
virtual-server-name

Description

Use this command to delete a virtual server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

virtual-server-name: Specify the name of the virtual server that you want to delete.

Examples

wadm delete-virtual-server --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

deploy-config(1)

Name

deploy-config– deploys a configuration

Synopsis

deploy-config <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--force|-f] [--restart|-r] [--no-reconfig|-o] 
config-name

Description

Use this command to deploy a configuration to the nodes. Whenever you create a new configuration or make changes to an existing configuration, you have to deploy the configuration for the changes to take effect. The configuration is deployed to all the instances of a configuration.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--force|-f

Specify this option for the command to overwrite any manual changes done to the configuration files in the instance. If you use this option,

The instance will be overwritten with the latest version of all the files in the config-store.
Any non-directory deployed web application, that is, any web application deployed with a .war file will lose all its session information, if any. If the --reconfig=false option is given, the session information is not lost but the server instance will not serve the deployed configuration.

--restart|-r

Specify this option for the command to restart the instances running in this configuration.

--no-reconfig|-o

If you specify this option, the command will not reconfigure a configuration.

Operands

config-name: Specify the name of the configuration you want to deploy.

Examples

wadm deploy-config --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt 
--rcfile=null config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-access-log(1)

Name

disable-access-log– disables the access log

Synopsis

disable-access-log <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--uri-pattern|-t pattern] 
--config|-c config-name

Description

Use this command to disable the access log.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-access-log --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-pattern="*.html"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-admin-ldap-auth(1)

Name

disable-admin-ldap-auth– disables LDAP authentication for the administration server.

Synopsis

disable-admin-ldap-auth <connect_options>  [--echo|-e] [--no-prompt|-Q] [--verbose|-v]

Description

Use this command to disable the administration server from authenticating against a Lightweight Directory Access Protocol (LDAP) server. The administration server uses the default keyfile for authentication instead of LDAP.

Options

For a description of connect_options, see help(1).

--echo|-e: Specify this option to print this command on the standard output before running it. This option also prints the default value for all the optional options for which you did not provide values.
--no-prompt|-Q: If you specify this option, wadm does not prompt for passwords while running this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Examples

wadm disable-admin-ldap-auth --user=admin --host=serverhost 
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-cgi-file-type(1)

Name

disable-cgi-file-type– disables the CGI support

Synopsis

disable-cgi-file-type <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] 
[--uri-pattern|-t pattern] --config|-c config-name

Description

Use this command to disable the common gateway interface (CGI) support for certain files types registered in the mime-types file.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which the stored CGI properties are displayed.

Examples

wadm disable-cgi-file-type --user=admin --host=serverhost 
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null--config=config1 --vs=vs --uri-pattern=/foo*

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-ciphers(1)

Name

disable-ciphers– disables ciphers

Synopsis

disable-ciphers <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--cipher-type |-t ssl2/ssl3tls ] 
--config|-c config-name --http-listener|-l name (cipher-name)+

Description

Use this command to disable SSL ciphers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--cipher-type|-t: Specify the type of supported ciphers. The type can be ssl2 or ssl3tls.
--config|-c: Specify the name of the configuration file that contains the metadata to configure the runtime services of the Web Server.
--http-listener|-l: Specify the name of the HTTP listener.

Operands

cipher-name: Specify the name of the SSL cipher that you want to disable.

Examples

wadm disable-ciphers --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --http-listener=config1_ls 
--cipher-type=ssl3tls SSL_RSA_WITH_RC4_128_SHA

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-dav-collection(1)

Name

disable-dav-collection– disables WebDAV collections

Synopsis

disable-dav-collection <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name --uri|-r uri

Description

Use this command to disable a WebDAV collection.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server where this WebDAV collection exists.
--uri|-r: Specify a URI through which the content is accessed.

Examples

wadm disable-dav-collection --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri=/dav_config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-directory-listing(1)

Name

disable-directory-listing– disables directory listing

Synopsis

disable-directory-listing <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  [--error-page|-g filepath] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to disable directory listing and set an error response file.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--error-page|-g: Specify the file to be displayed as a customized error response page.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-directory-listing --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null 
--error-page=data/disable-directory-listing/errorfile.html
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-document-footer(1)

Name

disable-document-footer– disables document footers

Synopsis

disable-document-footer <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to disable the document footer.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-document-footer --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-event(1)

Name

disable-event– disables events

Synopsis

disable-event <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [(--time=hh:mm [--month=1-12] 
[--day-of-week=sun|mon|tue|wed|thu|fri|sat] [--day-of-month=1-31]) | 
--interval=60-86400(seconds)] --config|-c config-name 
--command|-C restart|reconfig|rotate-log|rotate-access-log|update-crl|commandline

Description

Use this command to disable a scheduled event.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--time|-t: Specify the time you want this event start. The time format is hh:mm, for example, 12:30.
--month|-m: Specify the month you want this event to occur. The range of values is 1–12.
--day-of-week|-k: Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--day-of-month|-d: Specify the day of the month you want this event to occur. The range of values is 1–31.
--interval|-r: Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
--config|-c: Specify the name of the configuration.
--command|-C: Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.

Examples

wadm disable-event --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --time=20:30 --month=11 
--day-of-week=mon --day-of-month=2 --interval=3600
--config=config1 --command=restart

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-htaccess(1)

Name

.htaccess

Synopsis

disable-htaccess <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to disable the .htaccess file.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-htaccess --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-java(1)

Name

disable-java– disables Java

Synopsis

disable-java <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name

Description

Use this command to disable Java for a particular configuration. By default, Java is enabled for Sun Java System Web Server 7.0.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-java --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-on-demand-compression(1)

Name

disable-on-demand-compression– disables on-demand compression

Synopsis

disable-on-demand-compression <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--vs|-s vs-name --config|-c config-name

Description

Use this command to disable on-demand compression.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-on-demand-compression --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-p3p(1)

Name

disable-p3p– disables P3P

Synopsis

disable-p3p <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-cconfig-name --vs|-s vs-name

Description

Use this command to disable P3P (platform for privacy preferences), which is a protocol that specifies a way to enable web security policies.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-p3p --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-parsed-html(1)

Name

disable-parsed-html– disables parsed HTML content

Synopsis

disable-parsed-html <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  [--uri-pattern|-t pattern] 
--vs|-s vs-name --config|-c config-name

Description

Use this command to disable the parsed HTML content.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-parsed-html --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-perfdump(1)

Name

perfdump

Synopsis

disable-perfdump <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name

Description

Use this command to disable the perfdump utility.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-perfdump --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-precompressed-content(1)

Name

disable-precompressed-content– disables precompressed content

Synopsis

disable-precompressed-content <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--vs|-s vs-name --config|-c config-name

Description

Use this command to disable precompressed content.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-precompressed-content --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-request-limits(1)

Name

disable-request-limits– disables request limits

Synopsis

disable-request-limits <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to disable the request limits.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-request-limits --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs --uri-pattern=/foo*

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-search-event(1)

Name

disable-search-event– disables search events

Synopsis

disable-search-event <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--pattern|-P pattern] 
((--time|-t hh:mm] [--month|-m 1-12]
[--day-of-week|-k sun/mon/tue/wed/thu/fri/sat] 
[--day-of-month|-d 1-31])|--interval|-r 60-86400(seconds))
--config|-c config-name --vs|-s vs-name 
--collection|-O name --command|-C 
add-documents|reindex

Description

Use this command to disable a search event.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--time|-t: Specify a time when this search event is scheduled.
--day-of-month|-d: Specify the day of the month when this search event is scheduled. The range of values is 1–31.
--day-of-week|-k: Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--interval|-r: Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
--month|-m: Specify the month when this search event is scheduled. The range of values is 1 to 12.
--pattern|-P: Specify the wild card pattern of the documents that have to be added.
--command|-C: Specify the command the search event executes. The values can be add-documents or reindex.
--config|-c: Specify the name of the configuration for which you want to disable the search event.
--vs|-s: Specify the name of the virtual server.
--collection|-O: Specify the name of the collection.

Examples

wadm disable-search-event --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --time=20:30 --month=11 
--day-of-week=mon --day-of-month=15 --interval=3600 --vs=vs1
--config=config1 --command=reindex --collection=collection1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-secretkey-restriction(1)

Name

disable-secretkey-restriction– disables secret key restriction

Synopsis

disable-secretkey-restriction <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--vs|-s vs-name --config|-c config-name

Description

Use this command to disable the secret key restriction.

Options

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration for which you want to disable the secret key restrictions.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.

Examples

wadm disable-secretkey-restriction --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-single-signon(1)

Name

disable-single-signon– disables single sign-on

Synopsis

disable-single-signon <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to disable single sign-on.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-single-signon --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-snmp(1)

Name

disable-snmp– disables SNMP

Synopsis

disable-snmp <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name

Description

Use this command to disable SNMP.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-snmp --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-stats-xml(1)

Name

disable-stats-xml– disables the server instance statistics

Synopsis

disable-stats-xml <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --vs|-s vs-name --config|-c config-name

Description

Use this command to disable the server instance statistics.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-stats-xml --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs

Exit Status

0: command executed successfully
>0: error in executing the command

disable-unix-homedir(1)

Name

disable-unix-homedir– disables the UNIX home directory

Synopsis

disable-unix-homedir <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name --vs|-s vs-name

Description

Use this command to disable the UNIX home directory.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the configuration where the user document directory exists.
--vs|-s: Specify the name of the virtual server.

Examples

wadm disable-unix-homedir --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-webapp(1)

Name

disable-webapp– disables web applications

Synopsis

disable-webapp <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --vs|-s vs-name --uri|-r context-root 
--config|-c config-name

Description

Use this command to disable a web application.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--uri|-r: Specify the root URI for the web application.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-webapp --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs --uri=/simpleapp

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

disable-webdav(1)

Name

disable-webdav– disables WebDAV

Synopsis

disable-webdav <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name

Description

Use this command to disable WebDAV (Web-based Distributed Authoring and Versioning).

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Examples

wadm disable-webdav --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-access-log(1)

Name

enable-access-log– enables the access log

Synopsis

enable-access-log <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--format|-f log-format] [--log-ip|-o] 
[--vs|-s vs-name] [--uri-pattern|-t pattern] 
--config|-c config-name --file|-l log-file

Description

Use this command to enable the access log.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--format|-f: Specify the log format string for an access log.
--log-ip|-o: Set this option to true to log the IP of the client into the access log.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.
--file|-l: Specify the file name for access log.

Examples

wadm enable-access-log --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-pattern="*.html" 
--file=../logs/access.new --log-ip=true--format="%Req->reqpb.
protocol% %Req->headers.authorization% %vsid% %Ses->client.dns%"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-admin-ldap-auth(1)

Name

enable-admin-ldap-auth– enables LDAP authentication for the administration server.

Synopsis

enable-admin-ldap-auth <connect_options>  [--echo|-e] [--no-prompt|-Q]
 [--verbose|-v] [--auth-expiring-url|-a url]  [--bind-dn|-b binddn]
  [--bind-password|-b bindpw] [--group-search-filter|-o filter]
 [--search-filter|-f filter] [--group-search-attr|-t attr]
 [--dc-suffix|-x suffix] [--allow-group|-g group names]
 --ldap-url|-l ldap://server:port/dc=acme,dc=com

Description

Use this command to enable the administration server to authenticate against a Lightweight Directory Access Protocol (LDAP) server.

Options

For a description of connect_options, see help(1).

--echo|-e: Specify this option to print this command on the standard output before running it. This option also prints the default value for all the optional options for which you did not provide values.
--no-prompt|-Q: If you specify this option, wadm does not prompt for passwords while running this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--auth-expiring-url|-a: Specify the URL to which the server redirects the request if the password is going to expire soon.
--bind-dn|-d: Specify the name that the administration server uses to initially bind (or log in) to the directory server, for example, cn=Directory Manager. Binding determines the permission level you are granted for the duration of a connection. The DN supplied in a bind request can be the DN of an alias entry.
--bind-password|-b: Specify the password for authentication. You can define the --bind-password|-b in a password file.
--group-search-filter|-o: Specify the search filter to find group memberships for the user. The default value is uniquemember.
--search-filter|-f: Specify the search filter to find a user. The default value is uid. You can use the search options to interoperate with Microsoft Active Directory (MSAD). By default, MSAD does not store the user ids in the usual uid attribute. Instead, it stores the user ids in an attribute called samAccountName. Therefore, when LDAP searches a MSAD directory to find a user, it does not find a match because it attempts to match on the uid attribute. In Web server 7.0 or higher, you can set the --search-filter option to override the MSAD default attribute.
--group-search-attr|-t: Specify the LDAP attribute name that contains group name entries. The default value is CN.
--dc-suffix|-x: Specify a suffix for the LDAP database.
--allow-group|-g: Specify a comma separated list of groups. Users belonging to these groups are allowed to login.
--ldap-url|-l: Specify the URL of the LDAP authentication database. The type of authentication database is specified in the URL scheme.

Examples

wadm enable-admin-ldap-auth --user=admin --host=serverhost 
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt rcfile=null 
--ldap-url=ldap://serverhost.com:3950/dc=xyz,dc=xyz,dc=xyz 
--bind-dn=cn="Directory Manager"

wadm enable-admin-ldap-auth --user=admin --host=serverhost 
--password-file=../admin.passwd --port=8989 --ssl=true 
--ldap-url=ldap://serverhost:port/dc=acme,dc=com 
--allow-group="group1,group2,group3"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-cgi-file-type(1)

Name

enable-cgi-file-type– enables the CGI support

Synopsis

enable-cgi-file-type <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
[--server-user|-r user-id] [--group|g  group-id] 
[--directory|-d path] [--chroot|-H path] 
[--nice|-i value] [--vs|-s vs-name] 
--config|-c config-name

Description

Use this command to enable the common gateway interface (CGI) support for certain files types registered in the mime-types file. If a URI pattern is specified, then this support is limited to files that match the given pattern and whose extension is a registered CGI mime-type.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--server-user|r: The name of the user to execute the CGI programs.
--group|-g: The name of the group to execute the CGI programs.
--chroot|H: The additional root directory that you create to limit the server to specific directories.
--directory|-d: The directory to change to after chroot but before the execution of the CGI program
--nice|-i: The nice value is an increment that determines the priority of the CGI program's relative to the server. Typically, the server runs with a nice value of 0 and the nice increment would be between 0 (the CGI program runs at the same priority as the server) and 19 (the CGI program runs at a much lower priority than the server). You can increase the priority of the CGI program above that of the server by specifying a nice increment of -1.
--config|-c: Specify the name of the configuration for which the stored CGI properties are displayed.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.

Examples

wadm enable-cgi-file-type --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs --group=group1 
--nice=0 --directory=/foo --server-user=admin_user --chroot=/foo 
--uri-pattern=/foo*

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-ciphers(1)

Name

enable-ciphers– enables SSL ciphers

Synopsis

enable-ciphers <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--cipher-type|-t ssl2/ssl3tls] 
--config|-c config-name--http-listener|-l name 
(cipher-name)+

Description

Use this command to enable the SSL ciphers. A cipher is a cryptographic algorithm that is used for encryption or decryption.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--cipher-type|-t: Specify the type of cipher. The type can be ssl2 or ssl3tls.
--config|-c: Specify the name of the configuration file that contains the metadata to configure the runtime services of the Web Server.
--http-listener|-l: Specify the name of the HTTP listener.

Operands

cipher-name: Specify the name of the SSL cipher. For a list of ciphers, see the list-ciphers help page.

Examples

wadm enable-ciphers --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --http-listener=config1_ls --cipher-type=ssl3tls 
SSL_RSA_EXPORT_WITH_RC4_40_MD5

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-dav-collection(1)

Name

enable-dav-collection– enables the dav collection

Synopsis

enable-dav-collection <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
--uri|-r uri

Description

Use this command to enable the WebDAV collection.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server in which this WebDAV collection is present.
--config|-c: Specify the name of the configuration.
--uri|-r: Specify the URI through which the content is accessed.

Examples

wadm enable-dav-collection --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri=/dav_config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-directory-listing(1)

Name

enable-directory-listing– enables directory listing

Synopsis

enable-directory-listing <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  [--index-style|-y fancy/simple] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to enable directory listing.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--index-style|-y

Specify the type of directory index to generate if the server cannot find the index file. If your server is outside the firewall, turn off the directory indexing. The index style can be simple or fancy. The default value is fancy.

fancy - Lists all files in the directories in a special format providing all relevant information about the sub directories and files.
simple - Lists all files and sub directories in a simple list format.

--config|-c

Specify the name of the configuration.

--vs|-s

Specify the name of the virtual server.

Examples

wadm enable-directory-listing --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --index-style=simple --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-document-footer(1)

Name

enable-document-footer– enables document footer

Synopsis

enable-document-footer <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v][--uri-pattern|-t pattern] 
[--mime-type|-m type] --vs|-s vs-name 
--date-format|-d format --footer|-o text 
--config|-c config-name

Description

Use this command to enable the document footer. You can specify a document footer, which includes the last-modified time for all the documents. You can create a document footer for the entire virtual server or a specific URI pattern. This footer works for all files except the output of CGI scripts or parsed HTML (.shtml) files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--mime-type|-m: Specify the type of files to be included in the footer. The default value is text or html.
--vs|-s: Specify the name of the virtual server.
--date-format|-d: Specify the date format to be displayed for the timestamp information. The custom format can be of type %B, %d, and %y.
--footer|-o: Specify the text that will appear in the document footer. The maximum number of characters for a document footer is 765. If you want to include the date on which the document was last modified, type the string :LASTMOD:. Any entities, for example, © are contracted after you save your changes.
--config|-c: Specify the name of the configuration.

Examples

wadm enable-document-footer --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --date-format=%B 
--footer="config1 footer"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-event(1)

Name

enable-event– enables an event

Synopsis

enable-event <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [(--time=hh:mm [--month=1-12] 
[--day-of-week=sun|mon|tue|wed|thu|fri|sat] [--day-of-month=1-31]) 
| --interval=60-86400(seconds)] --config|-c config-name 
--command|-C restart|reconfig|rotate-log|rotate-access-log|
update-crl|commandline

Description

Use this command to enable an event that you have created.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--time|-t: Specify the time you want this event start. The time format is hh:mm, for example, 12:30.
--month|-m: Specify the month you want this event to occur. The range of values is 1–12.
--day-of-week|-k: Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--day-of-month|-d: Specify the day of the month you want this event to occur. The range of values is 1–31.
--interval|-r: Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
--config|-c: Specify the name of the configuration.
--command|-C: Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.

Examples

wadm enable-event --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--time=20:30 --month=11 --day-of-week=mon --day-of-month=15 
--interval=3600 --config=config1 --command=restart

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-htaccess(1)

Name

.htaccess

Synopsis

enable-htaccess <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] [--config-file|-f name]
 --config|-c config-name --vs|-s vs-name

Description

Use this command to enable the .htaccess file. Web Server supports the .htaccess dynamic configuration files. You can enable the .htaccess files either through the user interface or by manually changing the configuration files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config-file|-f: Specify the name of the .htaccess configuration file.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm enable-htaccess --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-java(1)

Name

enable-java– enables Java for a configuration

Synopsis

enable-java <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name

Description

Use this command to enable Java for a particular configuration. By default, Java is enabled for Sun Java System Web Server 7.0. Enabling Java enables the Web container and its associated functionalities.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Examples

wadm enable-java --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-on-demand-compression(1)

Name

enable-on-demand-compression– enables on-demand compression

Synopsis

enable-on-demand-compression <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
[--no-vary-header|-r] [--fragment-size|-f size] 
[--compression-level|-l [1-9]/NONE] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to enable on-demand compression. A dynamically generated HTML page does not exist until a user asks for it. This is particularly useful for e-commerce based web applications and database-driven sites.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--no-vary-header|-r: If you specify this option, the Vary: Accept-encoding header is not inserted when a compressed version of a file is selected.
--fragment-size|-f: Specify the memory fragment size (in bytes) that has to be used by the compression library to control the rate of compression.
--compression-level|-l: Specify the the level of compression. The range of values is 1–9. The value 1 yields the best speed; the value 9 the best compression. A middle value provides a compromise between speed and compression.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm enable-on-demand-compression --user=admin --host=serverhost 
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --fragment-size=100 
--compression-level=5

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-p3p(1)

Name

enable-p3p– enables P3P

Synopsis

enable-p3p <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--policy-url|-l url] [--compact-policy|-m policy]
 --config|-c config-name --vs|-s vs-name

Description

Use this command to enable P3P (platform for privacy preferences). P3P is a protocol that specifies the method to enable web security policies.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--policy-url|-l: Specify the URL of the site's policy reference file.
--compact-policy|- m: Specify the P3P compact policy.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm enable-p3p --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs --policy-url=data/enable-p3p/sample.policy

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-parsed-html(1)

Name

enable-parsed-html– enables the parsed HTML content

Synopsis

enable-parsed-html <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--uri-pattern|-t pattern] [--no-exec-tag|-x] 
[--file-to-parse|-f shtml/exec-html/html] --vs|-s vs-name 
--config|-c config-name

Description

Use this command to enable the parsed HTML content. HTML content is normally sent to the client exactly as it exists on disk without any server intervention. However, the server can search HTML files for special commands (that is, it can parse the HTML) before sending the documents. If you want the server to parse these files and insert request-specific information or files into documents, you must first enable HTML parsing.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--files-to-parse|-f

Specify the files the server will parse.

shtml - If you specify this type, the server will parse only files with the extension .shtml. This is the most common (and default) choice.
exec-html - If you specify this type, the server will parse files with the execute bit and the extension .shtml (UNIX/Linux only). Using the execute permissions can be unreliable because in some cases the bit is set on files that are not executable.
html - If you specify this type, the server will parse all HTML files. Choosing this option can slow server performance.

--no-exec-tag|-x

If you specify this option, the server parses HTML but does not allow HTML files to execute arbitrary programs on the server.

--vs|-s

Specify the name of the virtual server.

--config|-c

Specify the name of the configuration.

Examples

wadm enable-parsed-html --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null  
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-perfdump(1)

Name

perfdump

Synopsis

enable-perfdump <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri|-r uri] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to enable the perfdump utility.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri|-r: Specify the URI of the perfdump utility.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm enable-perfdump --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--uri=/.perf --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-precompressed-content(1)

Name

enable-precompressed-content– enables precompressed content

Synopsis

enable-precompressed-content <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--no-vary-header|-r] 
[--no-age-check|-a] [--uri-pattern|-t pattern]
[--compress-file|-m] [--sub-dir|-b subdirectory] 
[--compression-level|-l 1-9] [--min-size|-i 
size-in-bytes] [--max-size|-x size-in-bytes] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to enable precompressed content. You can configure Sun Java System Web Server to generate and store precompressed versions of files in a specified directory. When configured, and only if an Accept-encoding: gzip header is received, all requests for files from a directory configured to serve the precompressed content are redirected to requests for an equivalent compressed file from that directory if such a file exists.

For example, if the Web Server receives a request for myfile.html, and both myfile.html and myfile.html.gz exist, then those requests with an appropriate Accept-encoding header receive the compressed file.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--no-vary-header|-r: If you specify this option, a Vary: Accept-encoding header is not inserted when a compressed version of a file is selected.
--no-age-check|-a: If you specify this option, the compressed version is always selected even if it is older than the non-compressed version.
--uri-pattern|-t: Specify the URI wildcard pattern.
--compress-file|-m: Specify whether the static files should be compressed or not. The default value is false.
--sub-dir|-b: Specify the directory name in which the original non-compressed file is located.
--compression-level|-l: Specify the level of compression. The range of values is 1–9. The value 1 yields the best speed; the value 9 the best compression. A middle value provides a compromise between speed and compression.
--min-size|-i: Specify the minimum size of the file. The default value is 256 kilobytes.
--max-size|-x: Specify the maximum size of the file. The default value is 1048576 kilobytes.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm enable-precompressed-content --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --no-vary-header 
--uri-pattern=/compression/* --compress-file 
--sub-dir=.compressedfiles --config=config1 --vs=vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-request-limits(1)

Name

enable-request-limits– enables the request limits

Synopsis

enable-request-limits <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--rps-compute-interval|-a i] 
[--continue-condition|-o {silence|threshold}] [--error-code|-d n] 
[--monitor-attribute|-m attr] [--max-rps|-r x|--max-connections|-x
 c] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to enable the request limits.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

-rps-compute-interval|-a

Specify the time interval (in seconds) in which the average (request per second) RPS is computed. Note that max-rps limit will not be applied until the next request rate recomputation has occurred. This means that a potential attacker can have unlimited requests serviced until the initial interval runs out.

You can balance the length of this window of attack to the cost of frequent recomputations by adjusting the interval parameter. The default value is 30 seconds.

-continue-condition|-o

Specify the condition that must be met for a blocked request type to be available again for servicing. The values can be:

silence - refused requests must fall to zero (over a subsequent interval) for the service to resume.
threshold - refused request rate must fall below the RPS threshold for the service to resume.

The default value is threshold.

-error-code|-d

Specify the HTTP status code to use for blocked requests. The default is 503, "Service Unavailable".

-monitor-attribute|-m

Specify an optional request attribute that has to be monitored. Request rates are tracked in a "bucket" named by the value of this parameter. If the monitor parameter is not given, the matching requests are tracked in an unnamed (anonymous) bucket.

While the value of the monitor parameter can be a fixed string, it is most useful when given in terms of obj.conf variables.

For example, monitor="$ip". Note that you can also specify multiple variables.

-max-rps|-r

Specify the threshold value for RPS. If this value is exceeded, subsequent connections will not serviced. There is no default value because an acceptable RPS threshold can vary widely between sites.

-max-connections|-x

Specify the maximum number of concurrent connections. If a matching request is received while there are at least this many requests being processed, the request is rejected. As soon as concurrent requests fall below this limit, new ones will be processed.

--uri-pattern|-t

Specify the URI pattern.

--config|-c

Specify the name of the configuration.

--vs|-s

Specify the name of the virtual server.

Examples

wadm enable-request-limits --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --max-connections=100 
--continue-condition=silence --error-code=500 --uri-pattern=/foo*

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-search-event(1)

Name

enable-search-event– enables search events

Synopsis

enable-search-event <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--pattern|-P pattern]
((--time|-t hh:mm] [--month|-m 1-12]
[--day-of-week|-k sun/mon/tue/wed/thu/fri/sat] 
[--day-of-month|-d 1-31])|--interval|-r 60-86400(seconds))
--config|-c config-name --vs|-s vs-name 
--collection|-O name --command|-C 
add-documents|reindex

Description

Use this command to enable a search event.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--pattern|-P: Specify the wild card pattern of the documents that have to be added.
--time|-t: Specify a time when this search event is scheduled.
--day-of-month|-d: Specify the day of the month when this search event is scheduled. The range of values is 1–31.
--day-of-week|-k: Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
--interval|-r: Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
--month|-m: Specify the month when this search event is scheduled. The range of values is 1 to 12.
--command|-C: Specify the task the search event executes. The value can be add-documents or reindex.
--config|-c: Specify the name of the configuration for which you want to enable the search event.
--vs|-s: Specify the name of the virtual server.
--collection|-O: Specify the name of the collection.

Examples

wadm enable-search-event --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --time=20:30 --month=11 
--day-of-week=mon --day-of-month=15 --interval=3600
--config=config1 --collection=collection1 
--command=reindex --vs=vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-secretkey-restriction(1)

Name

enable-secretkey-restriction– enables secret key restrictions

Synopsis

enable-secretkey-restriction <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--reject-message-file|-r name] 
[--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name --min-key-size|-k 56/128/168

Description

Use this command to enable the secret key restrictions.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--reject-message-file|-r: Define the location of the file that contains the “reject access” message.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration for which the secret key restriction are to be enabled.
--vs|-s: Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
--min-key-size|-k: Define the minimum size of the secret key.

Examples

wadm enable-secretkey-restriction --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null--config=config1 --vs=vs --min-key-size=128

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-single-signon(1)

Name

enable-single-signon– enables single sign-on

Synopsis

enable-single-signon <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--idle-timeout|-l timeout] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to enable single sign-on.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--idle-timeout|-l: Specify the timeout (in seconds) after which the user's single-sign-on records will be purged. The range of values is 0.001 - 3600 or -1 for no timeout.

Examples

wadm enable-single-signon --user=admin -host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-snmp(1)

Name

enable-snmp– enables SNMP

Synopsis

enable-snmp <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--master-host|-m host] --config|-c config-name
--decription|-D text --organization|-o org 
--location|-l location --contact|-t number

Description

Use this command to enable SNMP.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--master-host|-m: Specify the name of the master host.
--config|-c: Specify the name of the configuration.
--description|-D: Enter a description.
--organization|-o: Specify the name of the organization.
--location|-l: Specify the location.
--contact|-t: Enter the contact details.

Examples

wadm enable-snmp --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --loconfig1ion=india --master-host=hostname 
--description=cli-snmp --organization=sun --contact=internal

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-stats-xml(1)

Name

enable-stats-xml– enables the server instance statistics

Synopsis

enable-stats-xml <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-prefix|-r uri-prefix] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to enable the server instance statistics which can be obtained in an XML format using get-stats-xml.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix of the instance for which you want to get the XML statistics.

Examples

wadm enable-stats-xml --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null  
--uri-prefix=/stats-xml --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-unix-homedir(1)

Name

enable-unix-homedir– enables the UNIX home directory

Synopsis

enable-unix-homedir <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-prefix|-r uri-prefix] 
[--sub-dir|-b users-subdirectory] [--user-pwfile|-l password-file] 
[--system-pwfile|-y] [--load-db-on-startup|-o] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to enable the UNIX home directory.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-prefix|-r: Specify the URI prefix for the user directory.
--sub-dir|-b: Specify the name of the sub directory.
--load-db-on-startup|-o: If you specify this option, the password file will be loaded at server startup.
--user-pwfile|-l: Specify the file that contains the user password. Specify this option if you do not want to use the system password file.
--system-pwfile|-y: If you specify this option, users are looked up from the system password file. Else, users are looked up from the password file specified in user-pwfile option.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm enable-unix-homedir --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-webapp(1)

Name

enable-webapp– enables a web application

Synopsis

enable-webapp <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name --vs|-s vs-name 
--uri|-r context-root

Description

Use this command to enable a web application. A web application is a collection of Java Servlets, JSPs, HTML pages, classes, and other resources. All these resources are stored in a directory, and all requests to that directory run the application.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of a virtual server.
--uri|-r: Specify the root URI for the web application.

Examples

wadm enable-webapp --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs --uri=/sampleapp

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

enable-webdav(1)

Name

enable-webdav– enables WebDAV

Synopsis

enable-webdav <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --config|-c config-name

Description

Use this command to enable WebDAV (Web-based Distributed Authoring and Versioning). WebDAV is an extension to HTTP/1.1 protocol to allow clients to perform remote web content authoring operations. This protocol allows clients to remotely administer access control lists (ACL), thereby affecting who can perform operations on WebDAV resources.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Examples

wadm enable-webdav --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

expire-lock(1)

Name

expire-lock– expires a lock

Synopsis

expire-lock <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --vs|-s vs-name --lock-uri|-l uri 
--opaque-token|-o token --collection-uri|-d uri 
--config|-c config-name

Description

Use this command to expire a lock.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the configuration where the locks exist.
--vs|-s: Specify the name of the virtual server.
--lock-uri|-l: Specify the URI on which the lock exists.
--collection-uri|- d: Specify the name of the collection URI.
--opaque-token|-o: Specify the ID of the lock that you want to expire. Lock IDs are displayed when you run the list-lock command.

Examples

wadm expire-lock --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=config1 --collection-uri=/dav1 
--lock-uri=/dav1/file.html --opaque-token=opaquelocktoken

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

forward-reverse-proxy-header(1)

Name

forward-reverse-proxy-header– forwards a reverse proxy header

Synopsis

forward-reverse-proxy-header <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--header|-H header] 
--config|-c config-name --vs|-s vs-name --uri-prefix|-r
 uri-prefix (param)

Description

Use this command to forward a reverse proxy parameter. Following are the parameters that can be forwarded:

jroute — The route ID that enables the reverse proxy to direct subsequent requests back to the server from where the request originated.
ip — The client's IP address to remote servers. The header is the name of the HTTP request header used to communicate the IP address of the client. The default header is Client-ip.
proxy-agent — The value of the Proxy-agent HTTP request header. The default is a string that contains the proxy server product name and version.
via — The intermediate protocol between a node and the server.
proxy-auth — The client's proxy authentication credentials, that is, the client's proxy-authorization HTTP request header to remote servers.
cipher — The name of the client's SSL/TLS cipher suite to remote servers. The header is the name of the HTTP request header used to communicate the name of the client's SSL/TLS cipher suite. The default header is Proxy-cipher.
keysize — The size of the client's SSL/TLS key to remote servers. The header is the name of the HTTP request header used to communicate the size of the client's SSL/TLS key. The default header is Proxy-keysize.
secret-keysize — The size of the client's SSL/TLS secret key to remote servers. The header is the name of the HTTP request header used to communicate the size of the client's SSL/TLS secret key. The default header is Proxy-secret-keysize.
ssl-id — The client's SSL/TLS session ID to remote servers. The header is the name of the HTTP request header used to communicate the client's SSL/TLS session ID. The default header is Proxy-ssl-id.
issuer-dn — The distinguished name of the issuer of the client's SSL/TLS certificate to remote servers. The header is the name of the HTTP request header used to communicate the distinguished name of the issuer of the client's SSL/TLS certificate. The default header is Proxy-issuer-dn.
user-dn — The name of the subject of the client's SSL/TLS certificate to remote servers. The header is the name of the HTTP request header used to communicate the distinguished name of the subject of the client's SSL/TLS certificate. The default header is Proxy-user-dn.
auth-cert — The client's SSL/TLS certificate to remote servers. The header is the name of the HTTP request header used to communicate the client's DER-encoded SSL/TLS certificate in Base64 encoding. The default header is Proxy-auth-cert.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix of the reverse proxy.
--header|-H: Specify the name of the HTTP request header that is used to forward the reverse proxy parameter.

Operands

param: Specify the name of the header parameter that you want to forward.

Examples

wadm forward-reverse-proxy-header --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs1 
--uri-prefix=/ --header=client-cert-data auth-cert

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-access-log(1)

Name

get-access-log– gets the access log information

Synopsis

get-access-log  <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--start-date|-S dd/MMM/yyyy:HH:mm:ss] 
[--end-date|-E dd/MMM/yyyy:HH:mm:ss] [--status-code|-o status-code] 
[--num-records|-n number-of-records] [--vs|-s vs-name] 
--config|-c config-name  nodehost

Description

Use this command to view the Web Server access log entries. The access log records information about requests to and responses from the server. If no optional options are chosen, this command will show the last 100 entries of the default access-log file for the selected configuration and node.

Options

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--start-date|-S: Specify the starting date and time from which the log messages must be shown. The start date should be in the dd/MM/yyyy:HH:mm:ss format.
--end-date|-E: Specify the ending date and time until which the log messages must be shown. The end date should be in the dd/MM/yyyy:HH:mm:ss format.
--status-code|-o: Specify the status code of HTTP response code, for example, 200, 300, or 400.
--num-records|-n: Specify the number of log messages to be shown.
--vs|-s: Specify the name of the virtual server. Use this option if you want to view the access file entries of a particular virtual server.
--config|-c: Specify the name of the configuration.

Operands

nodehost: Specify the name of the node.

Examples

wadm get-access-log --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-access-log-buffer-prop(1)

Name

get-access-log-buffer-prop– gets the access log buffer properties

Synopsis

get-access-log-buffer-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name  (property-name)*

Description

Use this command to view the access log buffer properties. The properties that you can view are as follows:

enabled - Indicates whether the system buffers access log updates. The default value is true.
buffer-size - The size (in bytes) of individual access log buffers. The range of values is 4096–1048576.
max-buffers - The maximum number of access log buffers per server. The range of values is 1–65536.
max-buffers-per-file - The maximum number of access log buffers per access log file. The range of values is 1–128. The default value is default.
max-age - The maximum amount of time to buffer a given access log entry. The range of values is 0.001–3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the access log property that you want to view.

Examples

wadm get-access-log-buffer-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-access-log-prop(1)

Name

get-access-log-prop– gets the access log properties

Synopsis

get-access-log-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--uri-pattern|-t pattern] 
--config|-c config-name  (property-name)*

Description

Use this command to view the access log properties. The properties that you can view are as follows:

enabled - Indicates whether the server writes to this access log. The default value is true.
name - The name that uniquely identifies the access log. If a name is specified, the server will not automatically log access to this access log. Instead, the access log must be explicitly mentioned by name in an obj.conf AddLog directive.
file - The filename of the access log file (absolute path or path relative to the server's config directory). For example, ../logs/access.
format - The format of access log entries flex-log format string. The default value is CLF.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of property that you want to view.

Examples

wadm get-access-log-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-pattern="*.html"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-acl(1)

Name

get-acl– gets the access control list

Synopsis

get-acl <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]
 [--vs|-s vs-name] --config|-c config-name  (aclname)*

Description

Use this command to view the access control list (ACL). Web Server supports authentication and authorization through the use of locally stored ACLs, which describe the access rights that a user has for a resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration.

Operands

aclname: Specify the name of the specified ACL that you want to view.

Examples

wadm get-acl --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt 
--rcfile=null --vs=vs --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-acl-cache-prop(1)

Name

get-acl-cache-prop– displays the ACL cache properties

Synopsis

get-acl-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (propertyname)*

Description

Use this command to view the access control list (ACL) cache properties. The properties that you can view are as follows:

enabled - Indicates whether the server caches the file content and meta information. The default value is true.
max-users - The maximum number of users for which the server will cache authentication information. The range of values is 1 - 1048576.
max-groups-per-user — The maximum number of groups per user for which the server will cache the membership information. The range of values is 1 - 1024.
max-age — The maximum amount of time (in seconds) to cache the authentication information. The range of values is 0.001 - 3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the ACL property that you want to view.

Examples

wadm get-acl-cache-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-admin-ldap-auth-prop(1)

Name

get-admin-ldap-auth-prop– retrieves the LDAP authentication database properties used the administration server to connect to the LDAP server.

Synopsis

get-admin-ldap-auth-prop <connect_options>  [--echo|-e]
 [--no-prompt|-Q] [--verbose|-v]

Description

Use this command to view the Lightweight Directory Access Protocol (LDAP) authentication database properties.

You can view the following properties:

enabled - Indicates whether the authentication database is enabled at runtime. The default value is true.
url - The URL of the authentication database.
auth-expiring-url - The URL to which the server redirects the request, if the password is about to expire soon.
bind-dn - The name that the administration server uses to initially bind (or log in) to the directory server, for example, cn=Directory Manager.
bind-pw - The password used for authentication.
dc-suffix - The suffix of the LDAP database.
search-filter - The search filter to find the user.
group-search-filter - The search filter to find group memberships for the user.
group-search-attr - The LDAP attribute name that contains the group name entries.
allow-group - A comma separated list of groups. Users belonging to these groups will be allowed to login.

Options

For a description of connect_options, see help(1).

--echo|-e: Specify this option to print this command on the standard output before running it. This option also prints the default value for all the optional options for which you did not provide values.
--no-prompt|-Q: If you specify this option, wadm does not prompt for passwords while running this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

propertyname: Specify the name of the authentication database property that you want to view.

Examples

wadm get-admin-ldap-auth-prop --user=admin --host=serverhost 
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt rcfile=null

wadm get-admin-ldap-auth-prop --user=admin 
--host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt rcfile=null allow-group

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-admin-prop(1)

Name

get-admin-prop– gets the administration node properties

Synopsis

get-admin-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--node|-n node-name] [--set-password|-r]
(propertyname)*

Description

Use this command to view the administration node properties. The properties that you can view are as follows:

install-root - The path of the installation directory.
instance-root - The directory that contains all instances. Usually same as the install-root.
server-version - The version of the Web Server installed.
is-admin-server - Flag that identifies the specified node as the administration server.
host - The host name of the administration server.
description - The description of the node.
server-user - The user ID of the server user, for example, root.
ssl-port - The SSL port if the server uses SSL connection to communicate.
non-ssl-port - The non-SSL port if the server uses non-SSL connection to communicate.
java-home - The location of the JDK directory. The JDK must have permission for the account the server runs as.
log-level - The log verbosity for the server. The values can be finest (most verbose), finer, fine, info, warning, failure, config, security, or catastrophe (least verbose).
log-file - The path of the server's log file.
admin-user - The user name of the authorized Web Server administrator.
access-log-file - The path of the server's access log file.

Note: If you edit the properties, restart the administration server on the specified node. If you edit the java-home property, stop and start the administration server on the specified node.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--set-password|-r: Specify this option to change the administration server user password.

Operands

propertyname: Specify the name of the administration property that you want to view.

Examples

wadm get-admin-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-authdb-prop(1)

Name

get-authdb-prop– gets the authentication database properties

Synopsis

get-authdb-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
--authdb|-a name (propertyname)*

Description

Use this command to view the authentication database properties. The properties that you can view are as follows:

enabled — Indicates whether the authentication database is enabled at runtime. The default value is true.
path — The path of the authentication database.
url — The URL of the authentication database.
auth-expiring-url — The URL to which the server redirects the request to in case the password is about to expire soon.
bind-dn — The name that the Administration Server uses to initially bind (or log in) to the directory server, for example, cn=Directory Manager.
bind-pw — (Applicable only for databases of type LDAP.) The password used for authentication.
dc-suffix — The dcsufix of the LDAP database.
search-filter — The search filter to find the user.
group-search-filter — The search filter to find group memberships for the user.
group-search-attr — The LDAP attribute name that contains the group name entries.
digestauthstate — Indicates whether the LDAP server is capable of handling HTTP digest authentication.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration.
--authdb|-a: Specify the name of the authentication database.

Operands

propertyname: Specify the name of the authentication database property that you want to view.

Examples

wadm get-authdb-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --authdb=KEYFILE1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-auth-realm-prop(1)

Name

get-auth-realm-prop– gets the authentication realm properties

Synopsis

get-auth-realm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --realm|-L name (propertyname)*

Description

Use this command to view the authentication realm properties. The properties that you can view are as follows:

type — The name of a built-in authentication realm type. (Applicable only when class is omitted.)
class — The class that implements a pluggable Servlet container authentication realm. (Applicable only when class is omitted.)

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--realm|-L: Specify the name of the authentication realm.

Operands

propertyname: Specify the name of the authentication realm property that you want to view.

Examples

wadm get-auth-realm-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --realm=basic

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-cache-control-directives(1)

Name

get-cache-control-directives– gets cache control directives information

Synopsis

get-cache-control-directives <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--config|-c config-name --vs|-s vs-name 
(propertyname)*

Description

Use this command to view cache control directives details. The properties that you can view are as follows:

public — Indicates that the response is cachable by any cache. This is the default behavior.
private — Indicates that the response is only cachable by a private (non-shared) cache.
no-cache — Indicates that the response is not cached.
no-store — Indicates that the cache does not store the request or response anywhere in nonvolatile storage.
must-revalidate — Indicates that the cache entry is revalidated from the originating server.
max-age — The maximum age (in seconds) the client accepts a response.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the cache control directive property that you want to view.

Examples

wadm get-cache-control-directives --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-cert-prop(1)

Name

get-cert-prop– gets the certificate properties

Synopsis

get-cert-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--token|-t name] [--token-pin|-P name] 
--config|-c config-name --nickname|-n nickname (propertyname)*

Description

Use this command to view the certificate properties. The properties that you can view are as follows:

nickname — The nickname or identifier used to refer the certificate.
subject — The subject DN or the identity of the entity to which this certificate belongs.
issuer — The subject DN of the issuing authority of this certificate.
serial-number – The serial number of the certificate.
fingerprint — A MD5 digest of this certificate.
key-type — The type of this certificate. The key types can be rsa or ecc
key-size — The size of certificate key. Applicable only if the key-type is rsa. The key size can be 1024, 2048 or 4098.
token — The token in which this certificate is stored.
issuername — The CN or the first component of the issuer.
issue-date — The issue date of the certicate.
expiry-date — The expiry date of the certificate.
is-expired — Indicates whether this certificate has expired.
is-read-only — Indicates if this certificate is read only.
is-self-signed — Indicates if this certificate has signed itself or has been signed by another authority.
has-crl — Indicates whether a CRL has been installed for this certificate.
client-ca — Indicates if this certificate is trusted to sign client certificates.
server-ca — Indicates if this certificate is trusted to sign server certificates.
is-ca — Indicates if this certificate is a CA certificate.
is-user-cert — Indicating if this certificate is a non-CA certificate owned by this entity. The entity referred here is the server instance.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--token|-t: Specify the token (cryptographic device), which contains the encrypted public key.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--config|-c: Specify the name of the configuration for which the certificate properties will be displayed.
--nickname|-n: Specify the short name or nick name of the certificate.

Operands

propertyname: Specify the name of the certificate property that you want to view.

Examples

wadm get-cert-prop --user=admin --host=serverhost 
--port=8989 --ssl=true --prompt=false --rcfile=null 
--password-file=certdb.newpasswd --config=config1 --token=internal 
--nickname="Certificonfig1e Manager - Sun"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-cgi-file-type-prop(1)

Name

get-cgi-file-type-prop– gets the CGI properties

Synopsis

get-cgi-file-type-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--uri-pattern|-t pattern] --vs|-s vs-name
--config|-c config-name  (propertyname)*

Description

Use this command to view the common gateway interface (CGI) properties. The property that you can view is as follows:

enabled - Indicates whether the CGI support based on URI pattern is enabled at runtime. The default value is false.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which the stored CGI properties are displayed.

Operands

propertyname: Specify the name of the CGI property that you want to view.

Examples

wadm get-cgi-file-type-prop --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-pattern=/foo*

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-cgi-prop(1)

Name

get-cgi-prop– gets the CGI properties

Synopsis

get-cgi-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--uri-pattern|-t pattern] 
--config|-c config-name (propertyname)*

Description

Use this command to view the common gateway interface (CGI) properties. The properties that you can view are as follows:

If you specify the --config option, you can view the following properties:

timeout - The timeout (in seconds) after which the server will terminate a long-running CGI program. The range of values is 0.001-3600, or -1 for no timeout.
idle-timeout - The timeout (in seconds) after which the server will terminate a nonresponsive CGI program. The range of values is 0.001-3600.
cgistub-path - The path to the Cgistub binary. The default value is default.
cgistub-idle-timeout - The timeout (in seconds) after which an unused Cgistub process will be terminated. The range of values is 0.001-3600.
min-cgistubs - The minimum number of Cgistub processes the server will keep while waiting to run the CGI programs. The range of values is 1-4096.
max-cgistubs - The maximum number of Cgistub processes the server will keep on hand, waiting to run CGI programs. The range of values is 1-4096.

If you specify the --vs option, you can view the following properties:

user – The name of the user to execute the CGI programs.
group – The name of the group to execute the CGI programs.
chroot – The additional root directory that you create to limit the server to specific directories.
directory – The directory to change to after chroot but before the execution of the CGI program.
nice – The nice value is an increment that determines the priority of the CGI program's relative to the server. Typically, the server runs with a nice value of 0 and the nice increment would be between 0 (the CGI program runs at the same priority as the server) and 19 (the CGI program runs at a much lower priority than the server).

You can increase the priority of the CGI program above that of the server by specifying a nice increment of -1. Sun, however, does not recommended you to do so.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: (This option is deprecated.) Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration for which the stored CGI properties are displayed.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.

Operands

propertyname: Specify the name of the CGI property that you want to view.

Examples

wadm get-cgi-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-config-file(1)

Name

get-config-file– gets the configuration file details

Synopsis

get-config-file <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]--config|-c config-name 
(filename)

Description

Use this command to view any configuration file present in the config directory under server-root.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing it.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

filename: Specify the name of the configuration file that you want to view.

Examples

wadm get-config-file --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 magnus.conf

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-config-prop(1)

Name

get-config-prop– gets the configuration properties

Synopsis

get-config-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to view the configuration properties. The properties that you can view are as follows:

default-auth-db-name — The name of the default authentication database.
user — The name of the Web Server user.
audit-accesses — Indicates whether the authentication and authorization events are logged. The default value is false.
acl-file (read-only) — The name of the ACL file that controls access to the server.
mime-file (read-only) — The name of the mime.types file that configures the MIME mappings for the server.
platform — Indicates whether the server runs as a 32-bit or 64-bit process. The value can be 32 or 64.
temp-path — The path where the server stores its temporary files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the configuration property that you want to view.

Examples

wadm get-config-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-config-stats(1)

Name

get-config-stats– gets the configuration statistics

Synopsis

get-config-stats <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--node|-n node-name] --config|-c config-name

Description

Use this command to view the configuration statistics at the instance or configuration level.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the node.
--config|-c: Specify the name of the configuration.

Examples

wadm get-config-stats --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-crl-prop(1)

Name

get-crl-prop– displays the CRL properties

Synopsis

get-crl-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --issuer-name|-r CA's name 
(propertyname)*

Description

Use this command to display the Certificate Revocation List (CRL) properties. The properties that you can view are as follows:

crlname — The name of issuer who has released this CRL.
issuer — The subject DN of the issuing authority of this certificate.
previssued — The issue date of the current update of the CRL that is currently installed.
nextissued — The expected date when a new update of this CRL would be issued by the corresponding CA.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--issuer-name|-r: Specify the name of the certificate authority (CA) issuer. The value can be the name of a company, organization, or department.

Operands

propertyname: Specify the name of the CRL property that you want to view.

Examples

wadm get-crl-prop --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --issuer-name="GlobalSign ServerSign CA"

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-custom-resource-prop(1)

Name

get-custom-resource-prop– gets the custom resource properties

Synopsis

get-custom-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --jndi-name|-j name 
(propertyname)*

Description

Use this command to view the custom resource properties. The properties that you can view are as follows:

enabled - Indicates whether the custom resource is enabled at runtime. The default value is true.
jndi-name - The Java Naming and Directory Interface (JNDI) name of the resource.
res-type - The type of custom resource.
factory-class - The class that instantiates a naming context which is used to look up the external resource. The value is a fully qualified class name that implements javax.naming.spi.ObjectFactory.
description - The description of the resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the custom resource.

Operands

property: Specify the name of the custom resource property that you want to view.

Examples

wadm get-custom-resource-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --jndi-name=custom

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-dav-collection-prop(1)

Name

get-dav-collection-prop– displays the DAV collection properties

Synopsis

get-dav-collection-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
--uri|-r uri (propertyname)*

Description

Use this command to view the DAV collection properties. You can view the following properties:

enabled - Indicates whether WebDAV is enabled for the collection at runtime. The default value is true.
provider — The name of the provider that manages this collection.
default-owner - The name of the default owner of the resources.
uri - The existing root URI on which WebDAV should be enabled.
source-uri - The new URI that the clients can use to access the source code of content.
min-lock-timeout - The minimum time (in seconds) for WebDAV locks to expire. The range of values is 0.001 - 3600, or -1 to not enforce a minimum.
max-xml-request-body-size - The maximum size (in bytes) allowed for WebDAV XML request bodies. The range of values is 0 - 2147483647, or -1 for no limit.
max-propfind-depth - The maximum depth of PROPFIND requests sent to the collections. The values can be 0, 1, or infinity.
max-expand-property-depth - The maximum depth allowed for WebDAV expand-property REPORT responses. The range of values is 0 - 100.
max-report-response-elements - The upper limit of the number of response elements a REPORT response body can have. The range of values is 0 - 2147483647. The default value is 1000.
auth-auth-db-name - The ACL authentication database to use. The default value is default.
auth-method - The authentication method to use. The values can be basic, digest, or ssl. The default value is basic.
auth-prompt - The prompt that will be displayed to clients during authentication. The default value is Sun Java System Web Server WebDAV.
acl-db-max-size - The maximum size (in bytes) of the memory representation of the WebDAV ACL database for a collection. If this memory limit is exceeded, the server will not cache the WebDAV ACL lists. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-max-entries - The maximum number of ACEs to allow on a single resource. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-update-interval - The interval (in seconds) at which WebDAV ACL databases are synchronized to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV ACL lists.
property-db-max-size - The maximum size (in bytes) of WebDAV property database files. The range of values is 0 - 2147483647, or -1 for no limit.
property-db-update-interval - The interval (in seconds) at which WebDAV property databases are synchronized to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV properties.
lock-db-path - The path of the WebDAV lock database.
lock-db-update-interval - The interval (in seconds) at which the WebDAV lock databases are synchronized to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV lock information.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server where this WebDAV collection exists.
--uri|-r: Specify the name of the URI through which the content is accessed.

Operands

propertyname: Specify the name of the WebDAV collection property that you want to view.

Examples

wadm get-dav-collection-prop --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri=/dav_config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-default-content-type(1)

Name

get-default-content-type– gets the default content details

Synopsis

get-default-content-type <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to view the default content details.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm get-default-content-type --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-directory-listing-prop(1)

Name

get-directory-listing-prop– gets directory listing properties

Synopsis

get-directory-listing-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name (propertyname)*

Description

Use this command to view the directory listing properties. The properties that you can view are as follows:

error-file — The file that is displayed as a customized error response page.
index-style — The type of directory index to generate if the server cannot find one of the index file name. The index style can be simple or fancy.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the directory listing property that you want to view.

Examples

wadm get-directory-listing-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null  --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-dns-cache-prop(1)

Name

get-dns-cache-prop– gets the DNS cache properties

Synopsis

get-dns-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to view the Domain Name Server (DNS) cache properties. The properties that you can view are as follows:

enabled - Indicates whether the server caches the DNS lookup results. The default value is true.
max-age - The maximum amount of time (in seconds) to cache a DNS lookup result. The range of values is 1–31536000.
max-entries - The maximum number of DNS lookup results to cache. The range of values is 32–32768.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the DNS cache property that you want to view.

Examples

wadm get-dns-cache-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-dns-prop(1)

Name

get-dns-prop– gets the DNS properties

Synopsis

get-dns-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (property-name)*

Description

Use this command to view the Domain Name Server (DNS) properties. DNS associates a standard IP addresses (such as 198.93.93.10) with hostnames (such as www.sun.com). The properties that you can view are as follows:

enabled - Indicates whether the server does the DNS lookups. The default value is false.
async - Indicates whether the server uses its own asynchronous DNS resolver instead of the operating system's synchronous resolver. The default value is true.
timeout - The timeout (in seconds) for asynchronous DNS lookups. The range of values is 0.001–3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the DNS property that you want to view.

Examples

wadm get-dns-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-document-footer-prop(1)

Name

get-document-footer-prop– gets the document footer properties

Synopsis

get-document-footer-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name  (propertyname)*

Description

Use this command to view the document footer properties. The properties that you can view are as follows:

mime-type - The type of files to be included in the footer.
date-format - The format of date displayed in the document footer.
footer - The text that appears in the document footer. The maximum number of characters for a document footer is 765.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the document footer property that you want to view.

Examples

wadm get-document-footer-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=config1_vs1 footer

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-error-page(1)

Name

get-error-page– gets the error page details

Synopsis

get-error-page <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name --code|-d errorcode  (propertyname)*

Description

Use this command to view the error page details.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--code|-d: Specify the error code.

Examples

wadm get-error-page --user=admin --host=serverhost --port=8989
--password-file=../admin.passwd --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --code=500

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-external-jndi-resource-prop(1)

Name

get-external-jndi-resource-prop– gets the external JNDI resources properties

Synopsis

get-external-jndi-resource-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--jndi-name|-j name (propertyname)*

Description

Use this command to view the external Java Naming and Directory Interface (JNDI) resource properties. The properties that you can view are as follows:

enabled - Indicates whether the JNDI resource is enabled at runtime.
jndi-name - The name of the JNDI resource.
jndi-lookup-name — The JNDI lookup name of the resource.
res-type - The resource type.
factory-class - The class that instantiates resources.
description - The description of the resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the name of the external JNDI resource.

Operands

propertyname: Specify the name of the external JNDI resource property that you want to view.

Examples

wadm get-external-jndi-resource-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=external-jndi

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-fastcgi-handler-prop(1)

Name

get-fastcgi-handler-prop– gets the FastCGI handler properties

Synopsis

get-fastcgi-handler-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--mime-type|-m type] [--uri-pattern|-t pattern] 
[--role|-o authorizer|responder|filter|error] --config|-c config-name 
--vs|-s vs-name (propertyname)*

Description

Use this command to view the FastCGI handler properties. The properties that you can view are as follows:

role — Indicates the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.
mime-type — Indicates the MIME type of FastCGI handler.
app-path — Indicates the FastCGI application path that processes the request.
bind-path — Indicates the name of the UNIX domain socket on the UNIX platform. On the Windows platform, bind-path must be specified as host:port. The value can also be a named pipe on both UNIX and Windows platforms
app-args — The name-value pairs that are passed as arguments to the FastCGI application process.
app-env — The environment variables of the FastCGI application process.
max-procs — The maximum number of FastCGI application processes that can be created. The default value is 1.
min-procs — The minimum number of FastCGI application processes that can be created. The default value is 1.
listen-queue-size — Indicates the size, in bytes, of the operating system listen queue back log. The default value is 256 bytes.
connection-timeout — Applicable if the reuse-connection option is set to true. Indicates the time-out value, in seconds, for the pooled connections. If a connection is idle for the specified amount period of time, then the connection is closed. The default value is 5 seconds.
reuse-connection — Indicates whether the connections to the FastCGI applications are reused. The value false indicates that the connections to FastCGI applications are closed after each request and true indicates that existing connections are reused for new requests. The default value is false.
response-timeout — Indicate the FastCGI server response time-out in seconds. If there is no response from the FastCGI application within the specified period of time, the request is discarded. The default value is 5 seconds.
request-retry — Indicates the number of times the request should be re-send when the FastCGI application rejects the request. The default value is 0 (zero).
restart-interval — The time interval, in minutes, after which the FastCGI application restarts. If the value for this option is 0 (zero), the FastCGI application is not forced to restart. The default value is 60 minutes.
chroot — (UNIX only). The additional root directory that you create where the FastCGI server application runs in. The default value is the web server's root directory. This property is displayed only if the value of the role option is authorizer, responder, or filter. .
server-user — (UNIX only). Indicates the user ID of a server user, for example, root. The default value is the web server's user ID. This property is displayed only if the value of the role option is authorizer, responder, or filter.
nice — (UNIX only). The nice value of FastCGI server application processes. Typically, the server is run with a nice value of 0 and the nice increment would be between 0 (the FastCGI program runs at same priority as server) and 19 (the FastCGI program runs at much lower priority than server). Do not increase the priority of the FastCGI program above that of the server by specifying a nice increment of -1. This property is displayed only if the value of the role option is authorizer, responder, or filter.
group — (UNIX only). Indicates the name of the group that execute the FastCGI programs. This property is displayed only if the value of the role option is authorizer, responder, or filter.
error-url — The web page, URI, or URL that FastCGI should display if an error occurs. The value of this parameter is an absolute path, a path relative to document root, an URL, or a URI. This property is displayed only if the value of the role option is error.
error-reason — Indicates any FastCGI protocol error. This property is displayed only if the value of the role option is error.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--mime-type|-m

Specify the MIME type of the FastCGI handler.

--uri-pattern|-t

Specify the URI pattern.

--role|-o

Specify the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.

In the responder role, the FastCGI application receives all information associated with an HTTP request and generates a response.
In the authorizer role, the FastCGI application receives all information associated with an HTTP request and generates an authorized or unauthorized decision.
In the filter role, the FastCGI application receives all information associated with an HTTP request and additional data from a file stored on the web server, and generates a filtered version of the data stream as an HTTP response.
In the error role, the FastCGI application terminates if an error occurs. You can configure the application to display a specific page or redirect the request to a URL if an error occurs.

--config|-c

Specify the name of the configuration.

--vs|-s

Specify the name of the virtual server.

Operands

propertyname: Specify the name of the FastCGI property that you want to view.

Examples

wadm get-fastcgi-handler-prop --user=admin --host=serverhost 
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --mime-type=magnus-internal/fastcgi 
--uri-pattern=/fcgi/* --role=filter --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-file-cache-prop(1)

Name

get-file-cache-prop– gets file cache properties

Synopsis

get-file-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name (property-name)*

Description

Use this command to view the file cache properties. Sun Java System Web Server 7.0 uses a file cache to serve static information faster. The properties that you can view are as follows:

enabled - Indicates whether the server caches the file content and meta information. The default value is true.
max-age - The maximum amount of time (in seconds) to cache the file content and/or meta information. The range of values is 0.001–3600.
max-entries - The maximum number of paths for which the file content and/or meta information should be cached. The range of values is 1–1048576.
max-open-files - The maximum number of file descriptors the file cache will keep open. The range of values is 1–1048576. The default value is default.
sendfile - Indicates whether the server will attempt to use the operating system's sendfile, sendfilev, send_file, or TransmitFile system call. The default value is true on Windows and false on other platforms.
copy-files - Indicates whether the server copies the cached files to a temporary directory. The default value is true on Windows and false on other platforms.
copy-path - The name of the temporary directory that the server uses when copy-files is true.
replacement - The cache entry replacement algorithm. The values can be false,lru, or lfu.
cache-content - Indicates whether the server caches the file content. The default value is true.
max-heap-file-size - The maximum size (in bytes) of files to cache on the heap. The range of values is 0–2147483647.
max-heap-space - The maximum amount (in bytes) of heap to use for caching files. The range of values is between 0– 9223372036854775807.
max-mmap-file-size - The maximum size (in bytes) of files to mmap. The range of values is 0-2147483647.
max-mmap-space - The maximum amount (in bytes) of mmap address space to use for caching files. The range of value is 0– 9223372036854775807.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the file cache property that you want to view.

Examples

wadm get-file-cache-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-home-page(1)

Name

get-home-page– gets the server home page

Synopsis

get-home-page <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name

Description

Use this command to view the home page. Home page is a document that exists on the server and acts as a catalog or entry point for the server's contents. The location of this document is defined in the server's configuration files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm get-home-page --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs

Exit Status

0: command executed successfully
>0: error in executing the command

get-htaccess-prop(1)

Name

.htaccess

Synopsis

get-htaccess-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name  (propertyname)*

Description

Use this command to view the .htaccess file property. The property that you can view is as follows:

enabled — Indicates whether .htaccess is a enabled at runtime.
config-file — The file name that contains the .htaccess configuration.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.

Operands

propertyname: Specify the name of the .htaccess file property that you want to view.

Examples

wadm get-htaccess-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-http-listener-prop(1)

Name

get-http-listener-prop– gets the HTTP listener socket properties

Synopsis

get-http-listener-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --http-listener|-l name 
(propertyname)*

Description

Use this command to view the HTTP listener socket properties. The properties that you can view are as follows:

enabled - Indicates whether the listener is enabled at runtime.
name - The name that uniquely identifies the HTTP listener.
ip - The IP address on which to listen.
port - The port on which to listen.
acceptor-threads - The number of threads dedicated to accept connections received by this listener. The range of values is 1–128. The default value is default.
server-name - The name of the default server. Can include a scheme (for example, http://) as prefix and port (for example, 80) as suffix.
blocking-io - Indicates whether the server uses blocking IO.
family - The name of the protocol family.
listen-queue-size - The maximum size of the operating system listen queue.
receive-buffer-size - The size (in bytes) of the operating system socket receive buffer.
send-buffer-size - The size (in bytes) of the operating system socket send buffer.
default-virtual-server-name - The name of the virtual server that processes requests which did not match a host.
description - The description of the HTTP listener.
handle-protocol-mismatch - Indicates whether the server responds to SSL or non-SSL protocol mismatches in client requests. The default is true, meaning the server will attempt to detect SSL or non-SSL protocol mismatches and send an HTTP redirect or SSL alert when a mismatch is detected.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the configuration on which the HTTP listener socket exists.
--http-listener|-l: Specify the name of the HTTP listener.

Operands

propertyname: Specify the name of the HTTP listener property that you want to view.

Examples

wadm get-http-listener-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --http-listener=config1_ls

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-http-prop(1)

Name

get-http-prop– gets the HTTP properties

Synopsis

get-http-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (property-name)*

Description

Use this command to view the HTTP properties. The properties that you can view are as follows:

version - The highest HTTP protocol version that the server supports.
server-header - The server header that contains the name of the server software and version. The default value is Sun Java System Web Server 7.0.
request-header-buffer-size - The size (in bytes) of the buffer that is used to read HTTP request header. The range of values is 0-2147483647.
strict-request-headers - Indicates whether the server rejects certain malformed HTTP request headers. The default value is false.
max-request-headers - The maximum number of header fields that can be allowed in an HTTP request header. The range of values is 1-512.
output-buffer-size - The size (in bytes) of buffer used to read the HTTP responses. The range of values is 0-2147483647.
max-unchunk-size - The maximum size (in bytes) of a chunked HTTP request body the server will unchunk. The range of values is 0-2147483647.
unchunk-timeout - The maximum time (in seconds) that the server will spend waiting for a chunked HTTP request body to arrive. The range of values can be between 0 - 3600 or -1 for no timeout.
io-timeout - The maximum time (in seconds) that the server will wait for an individual packet. The range of values is 0-3600 or -1 for no timeout.
request-header-timeout - The maximum time (in seconds) that the server will wait for the complete HTTP request header. The range of values is 0-604800 or -1 for no timeout.
request-body-timeout - The maximum time (in seconds) that the server will wait for the complete HTTP request body. The range of values is 0-604800 or -1 for no timeout.
favicon - Indicates whether the server replies to requests for favicon.ico with its own built-in icon file. The default value is true.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the HTTP property that you want to view.

Examples

wadm get-http-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-index-files(1)

Name

get-index-files– gets the index files

Synopsis

get-index-files <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name

Description

Use this command to view the index files. Index files are a list of welcome files or startup pages for the virtual server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm get-index-files --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-jdbc-resource-prop(1)

Name

get-jdbc-resource-prop– gets the JDBC resource properties

Synopsis

get-jdbc-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --jndi-name|-jname  
(propertyname)*

Description

Use this command to view the JDBC resource properties. The properties that you can view are as follows:

enabled - Indicates whether the JDBC resource is enabled at runtime.
jndi-name - The JNDI name of the resource.
datasource-class - The JDBC driver class.
min-connections - The minimum number of concurrent connections to maintain to the database server.
max-connections - The maximum number of concurrent connections to maintain to the database server.
idle-timeout- The timeout (in seconds) after which an idle connection to the database server will close.
wait-timeout - The timeout (in seconds) after which a caller waiting for an available connection to the database server will receive an error.
isolation-level - The level of transaction isolation.
isolation-level-guaranteed - Indicates whether the server sets the isolation level each time a connection is leased to an application.
connection-validation - Specifies how the server validates a connection before "leasing" it to an application.
connection-validation-table-name - The name of the table if the connection-validation is a database table.
fail-all-connections - Indicates whether all connections are immediately closed and reestablished when there is an error while validating a connection.
description - The description of JDBC resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the JDBC resource.

Operands

propertyname: Specify the name of the JDBC resource property you want to view.

Examples

wadm get-jdbc-resource-prop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=jdbc

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-jvm-profiler-prop(1)

Name

get-jvm-profiler-prop– gets the JVM profiler properties

Synopsis

get-jvm-profiler-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --profiler|-r name 
(propertyname)*

Description

Use this command to view the Java Virtual Machine (JVM) profiler properties. The properties that you can view are as follows:

enabled - Indicates whether the profiler is enabled at runtime.
class-path - The class path for the profiler.
native-library-path - The native library path for the profiler.
jvm-options - The JVM options for the profiler.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--profiler|-r: Specify the name of the JVM profiler.

Operands

propertyname: Specify the name of the JVM profiler property you want to view.

Examples

wadm get-jvm-profiler-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --profiler=JVMprofiler

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-jvm-prop(1)

Name

get-jvm-prop– gets JVM properties

Synopsis

get-jvm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to view the Java Virtual Machine (JVM) properties. The properties that you can view are as follows:

enabled - Indicates whether the server creates a JVM.
java-home - The location of the JDK. If set to ${WS_JDK_HOME}, it will be replaced by java-home of the Administration Node during deployment.
class-path-prefix - The prefix for the system class path. You should only prefix the system class path if you wish to override system classes, such as the XML parser classes. Use this attribute with caution.
server-class-path - The class path containing the server classes.
class-path-suffix - The suffix for the system class path.
env-class-path-ignored - Indicates whether the server ignores the CLASSPATH environment variable.
native-library-path-prefix - The prefix for the operating system native library path.
sticky-attach - Indicates whether the server attaches each HTTP request processing thread to the JVM only once instead of attaching and detaching on each request.
debug - Indicates whether the JVM is started in debug mode, ready for attachment with a JPDA (Java Platform Debugger Architecture) debugger.
debug-jvm-options — List of JPDA options.
jvm-options — List of server-wide JVM options.
bytecode-preprocessor-class - The bytecode preprocessor class.
profiler - The name of the JVM profiler.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the JVM property you want to view.

Examples

wadm get-jvm-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-keep-alive-prop(1)

Name

get-keep-alive-prop– gets the keep-alive properties

Synopsis

get-keep-alive-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (property-name)*

Description

Use this command to view the keep-alive properties. The keep-alive (or HTTP/1.1 persistent connection handling) subsystem in Sun Java System Web Server 7.0 is designed to be scalable. The out-of-the-box configuration can be less than optimal if the workload is non-persistent (that is, HTTP/1.0 without the KeepAlive header), or for a lightly loaded system that's primarily servicing keep-alive connections.

The properties that you can view are as follows:

enabled - Indicates whether the server supports keep-alive connections. The default value is true.
threads - The number of keep-alive subsystem threads. The range of values is 1–128. The default value is default.
max-connections - The maximum number of concurrent keep-alive connections the server will support. The range of values is 1–1048576. The default value is default.
timeout - The timeout (in seconds) after which an inactive keep-alive connection will be closed. The range of values is 0.001–3600.
poll-interval - The interval (in seconds) between polls. The range of values is 0.001–1.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the keep-alive property that you want to view.

Examples

wadm get-keep-alive-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-lifecycle-module-prop(1)

Name

get-lifecycle-module-prop– gets a lifecycle module

Synopsis

get-lifecycle-module-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --module|-m name --config|-c config-name 
(propertyname)*

Description

Use this command to view the lifecycle module properties. The properties that you can view are as follows:

enabled - Indicates whether the lifecycle module is enabled at runtime.
name - The name that uniquely identifies the lifecycle module.
class - The class that implements the lifecycle module.
load-order - The order in which the lifecycle module is loaded. It is recommended that you choose a load-order value that is greater than or equal to 100 to avoid conflicts with the internal lifecycle modules.
is-failure-fatal - Indicates whether the server should treat exceptions thrown during the initialization of lifecycle module as fatal.
class-path - The class path for the lifecycle module.
description - The description of the lifecycle module.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--module|-m: Specify the name of the lifecycle module.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the lifecycle module property that you want to view.

Examples

wadm get-lifecycle-module-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --module=LifecycleProp

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-localization-prop(1)

Name

get-localization-prop– gets the localization properties

Synopsis

get-localization-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name
(property-name)*

Description

Use this command to view the localization properties. You can configure your browsers to send an Accept-language header that describes the language preference for the content you are accessing. All end user error messages are also based on the Accept-language header. The properties that you can view are as follows:

default-language - The default language for messages displayed to administrators and content served to clients.
negotiate-client-language - Indicates whether the server attempts to use the Accept-language HTTP header to negotiate the content language with clients. The default value is false.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the localization property that you want to view.

Examples

wadm get-localization-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-log(1)

Name

get-log– gets the information on error logs

Synopsis

get-log <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--start-date|-S dd/MMM/yyyy:HH:mm:ss] 
[--end-date|-E dd/MMM/yyyy:HH:mm:ss] [--log-level|-l
 all|catastrophe|security|config|failure|warning|info|fine|finer|finest]
 [--num-records|-n number-of-records] [--vs|-s vs-name]
 --config|-c config-name  nodehost

Description

Use this command to get the information on error logs. The error log lists all the errors the server has encountered since the log file was created. It also contains other server information such as, when the server was started and a list of unsuccessful login attempts made to the server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--start-date|-S: Specify the starting date and time from which the log messages must be shown. The format of the date must be dd/MM/yyyy:HH:mm:ss.
--end-date|-E: Specify the ending date and time until which the log messages must be shown. The format of the date must be dd/MM/yyyy:HH:mm:ss.
--log-level|-l: Specify the severity of the log messages that must be shown. The value can be all, catastrophe, security, config, failure, warning, info, fine, finer, and finest.
--num-records|-n: Specify the number of log messages to be shown from the end of the error log file.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

nodehost: Specify the name of the node.

Examples

wadm get-log --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-log-prop(1)

Name

get-log-prop– gets the log properties

Synopsis

get-log-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]--config|-c config-name (propertyname)*

Description

Use this command to view the log properties. The properties that you can view are as follows:

log-stdout - Indicates whether the server logs the data that applications write to stdout. The default value is true.
log-stderr - Indicates whether the server logs the data that applications write to stderr. The default value is true.
log-virtual-server-name - Indicates whether the server includes the virtual server name in log messages. The default value is false.
create-console - (Windows only) Indicates whether the server creates a console window. The default value is false.
log-to-console - Indicates whether the server writes the log messages to the console. The default value is true.
log-to-syslog - Indicates whether the server writes log messages to syslog (UNIX) or Event Viewer (Windows). The default value is false.
date-format - The date format for the log message timestamps. The default value is [%d/%b/%Y:%H:%M:%S].
archive-suffix - The suffix to be appended to file name of the rotated log. The default value is m%d05/21/08M.
archive-command - The command to be executed after the server rotates a log file. The value is a program command line, for example, gzip c:\Program Files\Perl\perl.exe" archive.pl.
log-level - The log verbosity for the server. The values can be finest (most verbose), finer, fine, info, warning, failure, config, security, or catastrophe (least verbose).
log-file - The log file for the server. For example, ../logs/errors.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the log property that you want to view.

Examples

wadm get-log-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-mail-resource-prop(1)

Name

get-mail-resource-prop– gets the mail resource properties

Synopsis

get-mail-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --jndi-name|-j name 
(propertyname)*

Description

Use this command to view the mail resource properties. The properties that you can view are as follows:

enabled - Indicates whether the resource is enabled at runtime.
jndi-name - The JNDI name of the resource.
description - The description of the mail resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the mail resource.

Operands

propertyname: Specify the name of the mail resource property that you want to view.

Examples

wadm get-mail-resource-prop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --jndi-name=MailReso

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-on-demand-compression-prop(1)

Name

get-on-demand-compression-prop– gets on demand compression properties

Synopsis

get-on-demand-compression-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--vs|s vs-name --config|-c config-name (propertyname)*

Description

Use this command to view the on demand compression properties. The properties that you can view are as follows:

insert-vary-header — Indicates whether to insert the Vary: Accept-encoding header. If set to Yes, a Vary: Accept-encoding header is inserted when a compressed version of a file is selected. If set to No, the header is never inserted. The default, the value is Yes.
compression-level — Specifies the level of compression. Choose a value between 1 and 9. The value 1 yields the best speed; the value 9 the best compression. The default value is 6, a compromise between speed and compression.
fragment-size — Specifies the memory fragment size in bytes to be used by the compression library to control how much to compress at a time. The default value is 8096.
enabled — Indicates whether on—demand compression is enabled at runtime.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the on demand compression property that you want to view.

Examples

wadm get-on-demand-compression-prop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--vs=vs compression-level

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-p3p-prop(1)

Name

get-p3p-prop– displays the P3P properties

Synopsis

get-p3p-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
(propertyname)*

Description

Use this command to view the P3P (platform for privacy preferences) properties. The properties that you can view are as follows:

enabled - Indicates whether P3P is enabled at runtime.
compact–policy - The P3P compact policy.
policy-url - The URL of the site's policy reference file.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the P3P property that you want to view.

Examples

wadm get-p3p-prop --user=admin --host=serverhost --port=8989
--password-file=../admin.passwd --ssl=true --no-prompt
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-parsed-html-prop(1)

Name

get-parsed-html-prop– gets the parsed HTML properties

Synopsis

get-parsed-html-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name 
--vs|-s vs-name (propertyname)*

Description

Use this command to view the parsed HTML properties. The properties that you can view are as follows:

enabled — Indicates whether the parsed HTML option is enabled at runtime.
files-to-parse — The type of files that the server will parse. The file type can be shtml, exec-html, and allhtml.
no-exec-tag — Indicates whether the server parses HTML and allows the HTML files to execute arbitrary programs on the server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the parsed HTML property that you want to view.

Examples

wadm get-parsed-html-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-perfdump(1)

Name

get-perfdump– gets the perfdump statistics

Synopsis

get-perfdump <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --node|-n node-name --config|-c config-name

Description

Use this command to view the perfdump statistics. The perfdump utility is a Server Application Function (SAF) built into Sun Java Systems Web Server, which collects the Web Server performance data and displays them in ASCII format.

This utility allows you to monitor a greater variety of statistics. With perfdump, the statistics are unified. Rather than monitoring a single process, statistics are multiplied by the number of processes. This gives you a more accurate view of the server performance.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--config|-c: Specify the name of the configuration.

Examples

wadm get-perfdump --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=config1_vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-perfdump-prop(1)

Name

perfdump

Synopsis

get-perfdump-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*

Description

Use this command to get the perfdump properties. The properties that you can view are as follows:

enabled - Indicates whether the perfdump utility is enabled at runtime.
uri — The URI of the perfdump utility.

Options

For connect_options description, see help(1).

--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

propertyname: Specify the name of the perfdump property that you want to view.

Examples

wadm get-perfdump-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-pkcs11-prop(1)

Name

get-pkcs11-prop– gets the PKCS #11 properties

Synopsis

get-pkcs11-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to view the Public Key Cryptography Standard (PKCS#11) properties. PKCS#11 defines the interface used for communication between the SSL and PKCS#11 modules. PKCS#11 modules are used for standards-based connectivity to SSL hardware accelerators. The properties that you can view are as follows:

enabled - Indicates whether the server initializes PKCS #11 tokens, prompting for pins as necessary. The default value is true if SSL is enabled and false if SSL is not enabled.
crl-path - The path of the directory that contains dynamically updated CRL files.
token -Configures a PKCS #11 token.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the PKCS#11 property that you want to view.

Examples

wadm get-pkcs11-prop --user=admin --host=serverhost --port=8989
--password-file=../admin.passwd --ssl=true --no-prompt 
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-precompressed-content-prop(1)

Name

get-precompressed-content-prop– gets the precompressed content properties

Synopsis

get-precompressed-content-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--config|-c config-name --vs|-s vs-name 
(propertyname)*

Description

Use this command to view the precompressed content properties. The properties that you can view are as follows:

enabled — Indicates whether the precompressed content option is enabled at runtime.
check-age — Indicates whether the compressed version is selected even if it is older than the non-compressed version.
insert-vary-header — Indicates whether a Vary: Accept-encoding header is inserted when a compressed version of a file is selected.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the precompressed content property that you want to view.

Examples

wadm get-precompressed-content-prop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--vs=vs check-age

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-qos-limits-prop(1)

Name

get-qos-limits-prop– gets the QOS limit properties

Synopsis

get-qos-limits-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] 
--config|-c config-name (property-name)*

Description

Use this command to view the quality of service (QOS) limit properties. QOS is the performance limits you set for a server instance or virtual server. The properties that you can view are as follows:

enabled - Indicates whether the QOS limits are enforced at runtime. The default value is true.
max-bps - The maximum transfer rate (bytes per second). The range of values is 1–2147483647.
max-connections - The maximum number of concurrent connections. The range of values is 1–1048576.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

property-name: Specify the name of the QOS limits property that you want to view.

Examples

wadm get-qos-limits-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-qos-prop(1)

Name

get-qos-prop– gets the quality of service (QOS) properties

Synopsis

get-qos-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (property-name)*

Description

Use this command to view the quality of service (QOS) properties. The properties that you can view are as follows:

enabled - Indicates whether the system tracks the QOS information. The default value is true if qos-limits are enabled and false if qos-limits are disabled.
interval - The interval (in seconds) over which QOS information is averaged. The range of values is 0.001 –3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the QOS property that you want to view.

Examples

wadm get-qos-prop --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-request-limits-prop(1)

Name

get-request-limits-prop– gets the request limits property

Synopsis

get-request-limits-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--uri-pattern|-t pattern]
--config|-c config-name (propertyname)*

Description

Use this command to view the request limits properties. The properties that you can view are as follows:

timeout — The time limit after which a request will be timed out.
rps-compute-interval - The time interval (in seconds) in which the average (request per second) RPS is computed.
continue-condition — The condition that must be met for a blocked request type to be available again for servicing. The values can be silence or threshold.
max-rps - The threshold value for RPS. If this value is exceeded, subsequent connections will not serviced. There is no default value because an acceptable RPS threshold can vary widely between sites.
monitor-attribute - The optional request attribute that has to be monitored.
error-code - The HTTP status code to use for blocked requests. The default is 503, "Service Unavailable".
max-connections - The maximum number of concurrent connections.

Note –

If you specify the --config option, this command will display only the timeout property. If you specify both the --config and --vs options, the command will display the rps-compute-interval, max-rps, enabled, continue-condition, error-code, and monitor-attribute properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI pattern.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the request limits property that you want to view.

Examples

wadm get-request-limits-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs 
--uri-pattern=/foo*

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-reverse-proxy-prop(1)

Name

get-reverse-proxy-prop– gets the reverse proxy properties

Synopsis

get-reverse-proxy-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
--uri-prefix|-r uri-prefix (propertyname)*

Description

Use this command to get the reverse proxy properties. The properties that you can view are as follows:

server - The URL of the remote server. If you specify multiple values, the server distributes the load among the specified servers.
sticky-cookie - The name of a cookie that, when present in a response, will cause subsequent requests to stick to that origin server.
sticky-param - The name of a URI parameter to inspect for route information. If a URI parameter is present in a request URI and its value contains a colon (:) followed by a route ID, the request will stick to the origin server identified by that route ID.
route-header - The name of the HTTP request header used to communicate the route IDs to origin servers.
route-cookie - The name of the cookie generated by the server when it encounters a sticky-cookie cookie in a response. The route-cookie cookie stores a route ID that enables the server to direct subsequent requests back to the same origin server.
rewrite-headers - A list of HTTP request headers. The value can be host, location, or content-location where,
- host: Indicates whether the host HTTP request header is rewritten to match the host specified by the server parameter. The default is false, which means that the host header is not rewritten.
- location: Indicates whether the location HTTP response headers that match the server parameter should be rewritten. The default is true, which means that the matching location headers are rewritten.
- content-location: Indicates whether the content-location HTTP response headers that match the server parameter should be rewritten. The default is true, which means that the content-location headers are rewritten.
auth-user — The user to authenticate as.
auth-password — The password that is needed for authentication.
auth-header — The name of the HTTP request header that is used to communicate the credentials. The default value is Authorization. When authenticating to a proxy server, you can specify the value as Proxy-authorization.
client-cert-nickname — The nickname of the client certificate to present to the remote server. The default is not to present a client certificate.
validate-server-cert — Indicates whether the proxy server validates the certificate presented by the remote server. The default value is true, indicating that the proxy server will accept any certificate.
use-keep-alive — Indicates whether the HTTP client should attempt to use persistent connections. The default value is true.
keep-alive-timeout — The maximum number of seconds to keep a persistent connection open. The default value is 29.
always-use-keep-alive — Indicates whether the HTTP client can reuse the existing persistent connections for all types of requests. The default value is false, indicating that persistent connections will not be reused for non-GET requests or for requests with a body.
protocol — The HTTP protocol version string. By default, the HTTP client uses either HTTP/1.0 or HTTP/1.1 based on the contents of the HTTP request. In general, you should not use the protocol parameter unless you encounter specific protocol interoperability problems.
proxy-agent — The value of the Proxy-agent HTTP request header. The default is a string that contains the proxy server product name and version.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI prefix of the reverse proxy.

Operands

propertyname: Specify the name of the reverse proxy property that you want to view.

Examples

wadm get-reverse-proxy-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --uri-prefix=/simple/

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-search-collection-prop(1)

Name

get-search-collection-prop– gets the search collection properties

Synopsis

get-search-collection-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
--collection-name|-O name (propertyname)*

Description

Use this command to view the search collection properties. The properties that you can view are as follows:

enabled — Indicates whether the collection can be searched at runtime. The default value is true.
name — The name that uniquely identifies the search collection.
display-name — The description of the search collection that is displayed to end users.
uri — The root URI for the searchable documents.
document-root — The file system root for the searchable documents.
path — The path of the file system that stores the search collection meta.
index-meta-tag — The document fields that are used for indexing.
include-extension — The types of document that is included. The values can be html, htm, txt, and pdf.
description — The description of the search collection.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--collection-name|-O: Specify the name of the search collection.

Operands

propertyname: Specify the name of the search collection property that you want to view.

Examples

wadm get-search-collection-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs 
--collection=searchcoll

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-search-prop(1)

Name

get-search-prop– gets the search properties

Synopsis

get-search-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
(propertyname)*

Description

Use this command to view the search properties. The properties that you can view are as follows:

enabled — Indicates whether the search application is enabled at runtime. The default value is true.
max-hits — The maximum number of search results to return in response to a single search query. The range of values is 0 - 10000.
uri — The root URI for the search web application.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the search property that you want to view.

Examples

wadm get-search-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-secretkey-restriction-prop(1)

Name

get-secretkey-restriction-prop– gets the secret key restriction properties

Synopsis

get-secretkey-restriction-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] 
--config|-c config-name --vs|-s vs-name (propertyname)*

Description

Use this command to view the secret key restriction properties. The properties that you can view are as follows:

enabled — Indicates whether the secret key restriction option is enabled at runtime.
reject-message-file - The location of the file that contains the reject access message.
min-key-size - The minimum size of the secret key.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration for which the secret key restriction information are to be displayed.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the secret key restriction property that you want to view.

Examples

wadm get-secretkey-restriction-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-servlet-container-prop(1)

Name

get-servlet-container-prop– gets the servlet container properties

Synopsis

get-servlet-container-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
(property-name)*

Description

Use this command to view the Servlet container properties. The properties that you can view are as follows:

dynamic-reload-interval - The interval when the server checks the deployed web applications for modifications. The range of values is 1–60, or –1 if dynamic reloading should be disabled. The default value is –1.
log-level - The log verbosity for the Servlet container. The values can be finest (most verbose), finer, fine, info, warning, failure, config, security, or catastrophe (least verbose).
anonymous-role - The name of the default or anonymous, role assigned to all principals. The default role is ANYONE.
single-threaded-servlet-pool-size - The number of Servlet instances to instantiate per SingleThreadedServlet. The range of values is 1–4096.
cross-context-allowed - Indicates whether the request dispatchers are allowed to dispatch to another context. The default value is true.
reuse-session-id - Indicates whether any existing session ID number is reused when creating a new session for that client. The default value is false.
encode-cookies - Indicates whether the Servlet container encodes the cookie values. The default value is true.
dispatcher-max-depth – The maximum depth for the Servlet container allowing nested request dispatches. The range of values is 0–2147483647. The default value is 20.
secure-session-cookie — Controls the conditions under which the JSESSIONID cookie is marked secure. The values can be as follows:
- dynamic — marks the cookie secure only when the request is received on a secure connection.
- true — always marks the cookie secure.
- false — never marks the cookie secure.
The default value is dynamic.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name: Specify the name of the Servlet container property that you want to view.

Examples

wadm get-servlet-container-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-servlet-stats(1)

Name

get-servlet-stats– gets Servlet statistics

Synopsis

get-servlet-stats <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name --node|-n node-name 
--vs|-s vs-name --uri|-r web-app-uri

Description

Use this command to view the Servlet statistics.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--node|-n: Specify the name of the node.
--vs|-s: Specify the name of the virtual server.
--uri|-r: Specify the name of the web application URI.

Examples

wadm get-servlet-stats --user=admin --host=serverhost --port=8989
--password-file=../admin.passwd --ssl=true --no-prompt --rcfile=null
--config=config1 --node=node1 --vs=config1_vs_1 /servlet-simple

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-session-replication-prop(1)

Name

get-session-replication-prop– gets the session replication property

Synopsis

get-session-replication-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--node|-n node-name ] 
--config|-c config-name (propertyname)*

Description

Use this command to view the session replication property. The properties that you can view are as follows:

key - The secret key that members of the cluster use to authenticate each other. Only applicable at the cluster level.
encrypted - Indicates whether the session data is encrypted prior to replication. The default value is false. Only applicable at the cluster level.
protocol - The protocol used for session replication. The values can be http or jrmp. Only applicable at the cluster level.
async - Indicates whether session replication is allowed to occur asynchronously from HTTP request/response processing. The default value is true. Only applicable at the cluster level.
getAttribute-triggers-replication - Indicates whether a call to the HttpSession.getAttribute method should cause a session to be backed up. The default value is true. Only applicable at the cluster level.
replica-discovery-max-hops - The maximum number of instances that should be contacted while attempting to find the backup of a session. The range of values is 1–2147483647, or -1 for no limit. Only applicable at the cluster level.
startup-discovery-timeout - The maximum time (in seconds) that an instance will spend trying to contact its designated backup instance. The range of values is 0.001–3600. Only applicable at the cluster level.
cookie-name - The name of the cookie that tracks which instance owns a session. Only applicable at the cluster level.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the session replication property that you want to view.

Examples

wadm get-session-replication-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-single-signon-prop(1)

Name

get-single-signon-prop– gets the single sign-on properties

Synopsis

get-single-signon-prop <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name (property-name)*

Description

Use this command to view the single sign-on properties. The properties that you can view are as follows:

enabled — Indicates whether the single sign-on feature is enabled at runtime. The default value is false.
idle-timeout — The timeout (in seconds) after which the user's single sign-on records becomes eligible for purging if no activity is seen. The range of values is 0.001 - 3600, or -1 for no timeout. The default value is 300 seconds.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

property-name: Specify the name of the single sign-on property that you want to view.

Examples

wadm get-single-signon-prop --user=admin 
--host=serverhost --password-file=../admin.passwd --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-snmp-prop(1)

Name

get-snmp-prop– gets SNMP properties

Synopsis

get-snmp-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to get the SNMP properties. The SNMP protocol is used to exchange data about network activity.

With SNMP, data travels between a managed device and a network management station (NMS). A managed device is anything that runs SNMP: hosts, routers, your Web Server, and other servers on your network. The NMS is a machine used to remotely manage that network. The properties that you can view are as follows:

enabled — Indicates whether SNMP is enabled at runtime. The default value is true.
master-host — The network address of the SNMP master agent.
description — The description of the server.
organization — The organization that owns the server.
location — The location of the server.
contact — The contact information of the person responsible for the server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the SNMP property that you want to view.

Examples

wadm get-snmp-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-soap-auth-provider-prop(1)

Name

get-soap-auth-provider-prop– gets a SOAP authentication provider

Synopsis

get-soap-auth-provider-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--provider|-o name (propertyname)*

Description

Use this command to view the Simple Object Access Protocol (SOAP) authentication provider properties. The properties that you can view are as follows:

name — The name that uniquely identifies the SOAP message-level authentication provider for use in default-soap-auth-provider-name and sun-web.xml.
class — The class that implements the provider realm (com.sun.enterprise.security.jauth.ServerAuthModule).
request-policy — Configures the authentication policy requirements for requests.
response-policy — Configures the authentication policy requirements for responses.
property — Configures the optional provider-specific properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--provider|-o: Specify the name of the SOAP authentication provider.

Operands

propertyname: Specify the name of the SOAP authentication provider property that you want to view.

Examples

wadm get-soap-auth-provider-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --provider=soap-auth

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-ssl-prop(1)

Name

get-ssl-prop– gets SSL properties

Synopsis

get-ssl-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name  --http-listener|-l name 
(propertyname)*

Description

Use this command to view the SSL properties. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP. The properties that you can view are as follows:

enabled — Indicates whether SSL/TLS is enabled at runtime. The default value is true.
server-cert-nickname — The nickname of a server certificate.
ssl2 — Indicates whether SSL2 connections are accepted. The default value is false.
ssl3 — Indicates whether SSL3 connections are accepted. The default value is true.
tls — Indicates whether TLS connections are accepted. The default value is true.
tls-rollback-detection — Indicates whether the server detects and blocks TLS version rollback attacks. The default value is true.
client-auth — The client certificate authentication method. The value can be required, optional, or false.
client-auth-timeout — The timeout (in seconds) after which client authentication handshake fails. The range of values is 0.001 - 3600.
max-client-auth-data — The maximum amount of application-level data to buffer during a client authentication handshake. The range of values is 0 - 2147483647.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--http-listener|-l: Specify the name of the HTTP listener.

Operands

propertyname: Specify the name of the SSL property that you want to view.

Examples

wadm get-ssl-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --http-listener=config1_ls

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-ssl-session-cache-prop(1)

Name

get-ssl-session-cache-prop– gets SSL session cache properties

Synopsis

get-ssl-session-cache-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
(propertyname)*

Description

Use this command to view a SSL session cache. The properties that you can view are as follows:

enabled - Indicates whether the server caches SSL/TLS sessions. The default value is true.
max-entries - The maximum number of SSL/TLS sessions the server will cache. The range of values is 1–524288.
max-ssl2-session-age - The maximum amount of time to cache an SSL2 session. The range of values is 5–100.
max-ssl3-tls-session-age - The maximum amount of time to cache an SSL3/TLS session. The range of values is 5–86400.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the SSL session cache property that you want to view.

Examples

wadm get-ssl-session-cache-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-stats-prop(1)

Name

get-stats-prop– gets statistics properties

Synopsis

get-stats-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to view properties of the statistics collection subsystem. The properties that you can view are as follows:

enabled - Indicates whether the server collects statistics at runtime. The default value is true.
interval - The interval (in seconds) at which statistics are updated. The range of values is 0.001 - 3600.
profiling - Indicates whether performance buckets that are used to track NSAPI function execution time are enabled. The default value is true.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration

Operands

propertyname: Specify the name property you want to view.

Examples

wadm get-stats-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-stats-xml(1)

Name

get-stats-xml– gets the XML statistics

Synopsis

get-stats-xml <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --node|-n node-name

Description

Use this command to view the XML statistics of a server configuration.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--node|-n: Specify the name of the node.

Examples

wadm get-stats-xml --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --node=node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-stats-xml-prop(1)

Name

get-stats-xml-prop– gets the XML statistics properties

Synopsis

get-stats-xml-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*

Description

Use this command to view the XML statistics properties of a server configuration.

enabled - Indicates whether the XML statistics option is enabled at runtime.
uri — The URI of the XML statistics.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the XML property that you want to view.

Examples

wadm get-stats-xml-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-symlinks-prop(1)

Name

get-symlinks-prop– gets the symbolic link properties

Synopsis

get-symlinks-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --vs|-s vs-name 
--config|-c config-name  (propertyname)*

Description

Use this command to view the symbolic link properties. The properties that you can view are as follows:

allow-soft-links — allows soft file system links. The values can be:
- true - always allow soft file system links
- false - never allow soft file system links
- on-owner-match- only allow when owners match
allow-hard-links — allows hard file system links. The values can be:
- true - always allow hard file system links
- false - never allow hard file system links
directory — Name of the directory from which links will be searched.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the symbolic link property that you want to view.

Examples

wadm get-symlinks-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-thread-pool-prop(1)

Name

get-thread-pool-prop– gets thread pool properties

Synopsis

get-thread-pool-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname)*

Description

Use this command to view the thread pool properties. You can use thread pools to allocate a certain number of threads to a specific service. By defining a pool with the maximum number of threads as 1, only one request is allowed to the specified service function.

The properties that you can view are as follows:

enabled - Indicates whether the thread pool is enabled at runtime.
min-threads - The minimum number of HTTP request processing threads. The range of values is 1–4096. The default value is default.
max-threads - The maximum number of HTTP request processing threads. The range of values is 1–4096. The default value is default.
stack-size - The stack size (in bytes) for HTTP request processing threads. The range of values is 8192–67108864.
queue-size - The maximum number of concurrent HTTP connections that can be queued waiting for processing. The range of values is 1–1048576. The default value is default.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the thread pool property that you want to view.

Examples

wadm get-thread-pool-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-unix-homedir-prop(1)

Name

get-unix-homedir-prop– gets UNIX home directory properties

Synopsis

get-unix-homedir-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*

Description

Use this command to view the properties of the UNIX home directory. The properties that you can view are as follows:

uri-prefix - The URI prefix for the user directory.
sub-dir - The name of the sub directory.
load-db-on-startup - The name of the password file that is loaded at server startup.
user-pwfile - The name of the file that contains the user password.
use-system-pwfile - Indicates whether the users are looked up from the password file specified in user-pwfile option.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the UNIX home directory property that you want to view.

Examples

wadm get-unix-homedir-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-url-redirect-prop(1)

Name

get-url-redirect-prop– displays the forwarding URL properties

Synopsis

get-url-redirect-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--uri-prefix|-r uri-prefix
|--condition|-C regex] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to view the forwarding URL properties. The properties that you can view are as follows:

uri-prefix - The URI prefix you want to redirect.
target-url - The target URL to which the requests is redirected.
fixed-url - The destination URL (if it is a fixed URL).

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--config|-c

Specify the name of the configuration.

--vs|-s

Specify the name of the virtual server.

--uri-prefix|-r

Specify the URI prefix you want to redirect.

--condition|-C

Specify the URL redirect condition.

Note –

The uri-prefix and condition options are mutually exclusive.

Operands

propertyname: Specify the name of the property that you want to view.

Examples

wadm get-url-redirect-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=config1_vs1 --uri-prefix=/redirect

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-user-prop(1)

Name

get-user-prop– gets user information

Synopsis

get-user-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--realm|-L realm] 
[--org-unit|-o ou] --config|-c config-name --authdb|-a name
--uid|-U userid (propertyname)*

Description

Use this command to get the user information. The properties that you can view are surname, full name, email ID, phone number, realm, org-unit, and user title.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Enter a description of an organizational unit within your company to which this user belongs.
--authdb|-a: Specify the authentication database that stores the user information.
--uid|-U: Enter the ID of the user.
--realm|-L: Specify the realm that authenticates the user.

Operands

propertyname: Specify the name of the user property that you want to view.

Examples

wadm get-user-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null--config=config1 --realm=rml1 --authdb=DIGESTFILE1
--uid=digestfile-config1-u1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-virtual-server-prop(1)

Name

get-virtual-server-prop– gets the virtual server properties

Synopsis

get-virtual-server-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name (propertyname)*

Description

Use this command to view the properties of a virtual server. The properties that you can view are as follows:

object-file - The obj.conf file that controls the request handling process for the virtual server.
canonical-server-name - The canonical host name of the virtual server. Requests using a different host name will be redirected to this host name.
enabled - Indicates whether the virtual server is enabled at runtime.
host - The hostname the virtual server services.
default-object-name - The name of the root obj.conf object.
name - The name that uniquely identifies the virtual server.
document-root - The document root for the virtual server.
mime-file - The mime.types file that configures MIME mappings for the virtual server.
log-file - The log file for the virtual server.
http-listener-name - The name of an HTTP listener associated with one or more of the virtual server's hostnames.
acl-file - The Access Control List (ACL) file that controls access to the virtual server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration on which the virtual server exists.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname: Specify the name of the virtual server property that you want to view.

Examples

wadm get-virtual-server-prop --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-virtual-server-stats(1)

Name

get-virtual-server-stats– gets the virtual server statistics

Synopsis

get-virtual-server-stats <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--node|-n node-name ] --config|-c config-name 
--vs|-s vs-name

Description

Use this command to view the virtual server statistics for a given configuration.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of virtual server.

Examples

wadm get-virtual-server-stats --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --node=node1 --vs=config1_vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-webapp-stats(1)

Name

get-webapp-stats– gets web application statistics

Synopsis

get-webapp-stats <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--node|-n node-name ] --config|-c config-name 
--uri|-r web-app-uri --vs|-s vs-name

Description

Use this command to view the the statistics for a given web application deployed on the given virtual server of the given instance.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--config|-c: Specify the name of the configuration.
--uri|-r: Specify the name of web application URI.
--vs|-s: Specify the name of the virtual server.

Examples

wadm get-webapp-stats --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=config1_vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

get-webdav-prop(1)

Name

get-webdav-prop– gets WebDAV properties

Synopsis

get-webdav-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]--config|-c config-name (propertyname)*

Description

Use this command to view the WebDAV properties. You can view the following properties:

enabled - Indicates whether WebDAV is enabled for the collection at runtime. The default value is true.
default-owner - The default owner for the resources.
min-lock-timeout - The minimum expiration time (in seconds) for WebDAV locks. The range of values is 0.001 - 3600, or 0 to not enforce a minimum expiration time.
max-xml-request-body-size - The maximum size (in bytes) allowed for WebDAV XML request bodies. The range of values is 0 - 2147483647, or -1 for no limit.
max-propfind-depth - The maximum depth of PROPFIND requests sent to collections. The values are 0, 1, or infinity.
max-expand-property-depth - The maximum depth allowed for WebDAV expand-property REPORT responses. The range of values is 0 - 100.
max-report-response-elements - The upper limit of the number of response elements a REPORT response body can have. The range of values is 0 - 2147483647, default 1000.
auth-auth-db-name - The ACL authentication database to use. The default value is default.
auth-method - The authentication method to use. The values can be basic, digest, or ssl. The default value is basic.
auth-prompt - The prompt to display to the client requests for authentication. The default value is Sun Java System Web Server WebDAV.
acl-db-max-size - The maximum size (in bytes) of memory representation of the WebDAV ACL database for a collection. If this memory limit is exceeded, the server will not cache WebDAV ACL lists. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-max-entries - The maximum number of ACEs to allow on a single resource. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-update-interval - The interval (in seconds) at which WebDAV ACL databases are synced to disk. The value range is 0.001 - 3600, or 0 to disable caching of WebDAV ACL lists.
property-db-max-size - The maximum size (in bytes) of WebDAV property database files. The range of values is 0 - 2147483647, or -1 for no limit.
property-db-update-interval - The interval (in seconds) at which WebDAV property databases are synced to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV properties.
lock-db-path - The filename of the WebDAV lock database is stored. The path can be the absolute path or path relative to the server's config directory.
lock-db-update-interval - The interval (in seconds) at which WebDAV lock databases are synced to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV lock information.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname: Specify the name of the WebDAV property that you want to view.

Examples

wadm get-webdav-prop --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--verbose --config=config1 property-db-update-interval

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

help(1)

Name

help– describes the command line interface

Synopsis

wadm --version|-V

or wadm --help|-?

or wadm [--user|-u admin-user] [--password-file|-w admin-pswd-file]
 [--host|-h admin-host] [--port|-p admin-port] [--no-ssl|-N]
 [--rcfile|-R rcfile]

Description

The Command Line Interface (CLI) enables you to configure and administer the Sun Java System Web Server 7.0. Use the command line tool wadm to execute the administration commands. The wadm usage is as follows:

wadm --version|-V displays the version of the administration CLI.
wadm --help|-? displays this man page in a text format.
wadm [--user|-u admin-user] [--password-file|-w admin-pswd-file] [--host|-h admin-host] [--port|-p admin-port] [--no-ssl|-N] [--rcfile|-R rcfile] launches wadm in a shell mode.

You can invoke wadm in stand-alone mode, shell mode, or file mode.

Stand-alone mode — In the stand-alone mode, you can directly invoke the CLI specifying the desired command, options, and operands. On completion of a command, the CLI returns back to the shell. The stand-alone mode supports both interactive and non-interactive execution of commands. Interactive execution, which is the default, prompts for the passwords if not already specified in the command or password-file. Non-interactive execution executes a command without prompting for passwords. You must specify the user and password-file options for every command that you execute in the stand-alone mode.

Example for stand-alone mode:

$ wadm list-configs --user=admin --host=serverhost --password-file=./admin.pwd
Shell mode — In the shell mode, you can invoke the CLI from a shell that is embedded within wadm. On completion of the command, the CLI returns back to the shell. You can exit the shell by typing exit or quit. The shell mode supports both interactive and non-interactive execution of command. This mode accepts user and password-file when you invoke wadm.

Example for shell mode:

$ wadm --user=admin --password-file=./admin.pwd

Sun Java System Web Server 7.0 Update 1 20:35

wadm> list-configs
File mode — In the file mode, you can create a commands-file containing a list of valid commands. The file mode accepts user and password-file when you invoke wadm.

Example for file mode:
$ cat sample.tcl set wadm::command false set x [list-configs] puts $x
$ wadm --user=admin --password-file=./admin.pwd --commands-file=sample.tcl

where sample.tcl is the name of the commands-file.

To get help on wadm, type wadm -help

To get help on any specific command, type

wadm sub-command --help

For example, $ wadm add-documents --help

Connect_Options

Use the connect_options to connect to the Administration Server. Connect_options include administration user name, password file, host, port (SSL/non-SSL) and an optional preferences file. These options are common for all commands. In the shell mode, the connect_options that you provide while invoking wadm are automatically used for every command that you execute.

A list of connect_options and description is as follows:

[--user|-u admin-user] [--password-file|-w admin-pswd-file]
 [--host|-h admin-host] [--port|-p admin-port] [--no-ssl|-N]
 [--rcfile|-R rcfile]

Note –

Optional arguments (or options) are displayed within square brackets [], for example, [-user|-u].

--user|-u

Specify the user name of the authorized Web Server administrator.

--password-file|-w

Specify the name and the location of the password file. The password file contains the password to authenticate administrators to the Administration Server. Apart from the administration password, you can also specify other passwords such as bind-password, user-password, keystore-password, token-pin, and so on. If you do not specify this option, you will be prompted for a password while executing the command.

A sample password file is as follows:

wadm_password=wadm-password
wadm_bind_password=bind-password
wadm_user_password=user-password
wadm_token_pin=token-pin
wadm_keystore_password=keystore-password
wadm_key_password=key-password
wadm_new_token_pin=new-token-password
wadm_admin_password=admin-password
wadm_<token_name>=token-pin

Note –

wadm_<token_name> is applicable only for the start-instance command. You can use wadm_<token_name> to set multiple token pins to start instances on multiple nodes.

For example, a default token named internal is configured for any instance. The entry for the default token in the password-file will be wadm_internal=88888888.

--host|-h

Specify the name of the machine where the Administration Server is running. The default host is localhost.

Note –

This option is required only if you are connecting to Administration Server remotely.

--port|-p

Specify the port number of the Administration Server. The default non-SSL port is 8800 and the default SSL port is 8989.

Note –

If you are invoking the CLI from an Administration Server installation, port numbers (SSL port value by default or non-SSL port value if the --no-ssl option is specified) are automatically picked up.

--no-ssl|-N

Specify this option to use a plain text connection to communicate with the Administration Server. The default connection is SSL.

--rcfile|-R

Specify the name of the rcfile that has to be loaded while starting wadm. The default file is .wadmrc. The .wadmrc file is a TCL file that gets loaded before any command is executed. You can use the long options as variables by changing the hyphen (-) in the option name to underscore (_) and prefixing it with wadm. For example:

--config can be set as set wadm_config config1
--key-type can be set as set wadm_key_type ecc

A sample .wadmrc is as follows:

set wadm_config sampleconfig
set wadm_password mypassword
set wadm_nodehost sample.sun.com

The wadm Variables

You can also set the following wadm variables to modify the overall behavior of wadm:

wadm::command: (Applicable only in the file mode.) Enables you to output all commands to stdout and stderr. If set to true, exceptions do not stop the execution of commands, rather they are printed in the stdout and the next command is executed. You can set this variable in the commands-file.
$ cat commands.tcl set wadm::command true set x [list-configs] puts $x
where commands.tcl is the name of the commands-file.
wadm::savehist: (Applicable only in the shell mode.) If set to true, all wadm commands that you execute are saved in the wadm::histfile file. The wadm::histfile is saved in your home directory. You can set this variable in the wadm environment using the wadm> set wadm::savehist true command:
wadm::file: This is set to true if you are executing the wadm commands in the file mode.
wadm::tokenize: If set to true, wadm parses the log files in a TCL friendly format.
wadm::log_date_format: Use this variable to define the date format in the log files. The default format is MM/dd/yyyy:HH:mm:ss.
wadm::date_format: Use this variable to define a date format in which a user can enter a date. The default value is the date format of the current locale.
wadm::property_separator: Use this variable to define the property separator. The default value is the equal to (=) symbol. For example, wadm>set wadm::property_separator :
wadm::field_separator: Use this variable to define the field or column separator. The default value is a blank space ( ). For example, wadm>set wadm::field_separator |
wadm::field_format: Use this variable to define the display format of a field or column. The default value is %-15s. For example, wadm>set wadm::field_format %-15s|

Exit Codes

The following exit codes are returned:

0 — command executed successfully
1–4 — connection failure errors
10–22 — parsing errors
33–43 — input/output errors
44–56 — general errors, for example, invalid configuration value
76–96 — generic back-end errors
110–123 — errors that are specific to Mbeans
125 — unknown errors

SJS Web Server Last Revised March 2007

install-cert(1)

Name

install-cert– installs a certificate

Synopsis

install-cert <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--token|-t name] [--replace|-a] [--file-on-server|-f]
 [--token-pin|-P name] --config|-c config-name 
--cert-type|-y server|chain|ca --nickname|-n nickname cert-file

Description

Use this command to install a certificate. Before you begin, you should have the certificate (DER) text from a certificate authority (CA). When you receive a certificate from the CA, it will be encrypted with your public key, which only you can decrypt. Web Server will use the key-pair file password you specify to decrypt the certificate when you install it.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--token|-t

Specify the token (cryptographic device), which contains the encrypted public key.

--config|-c

Specify the name of the configuration for which you are installing the certificate.

--replace|-a

If you specify this option, the command replaces the existing certificate (if any).

--cert-type|-y

Specify the type of certificates. The values can be server-cert, cert-chain, or trusted-ca.

server-cert — Indicates that the server will use the key-pair file password you specify to decrypt the certificate when you install it.
cert-chain — Allows the SSL connection to continue at the client's discretion when the client does not recognize the certificate's CA. Certificate chaining is the process of presenting your CA's certificate in addition to your own.
trusted-ca — Accepts the certificate of a CA as a trusted CA for client authentication.

--file-on-server|- f

If you specify this option, the command stores a copy of the certificate file on the server where you install the certificate.

--nickname|-n

Specify the nick name or the short name of the certificate.

--token-pin|-P

Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.

Operands

cert-file: Specify the name of the file that stores the certificate on the server.

Examples

wadm install-cert --user=admin --host=serverhost --port=8989 
--ssl=true --prompt=false --rcfile=null --password-file=certdb.newpasswd
--config=config1 --token=internal --cert-type=server --nickname=cert1
certbin.req

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

install-crl(1)

Name

install-crl– installs a CRL

Synopsis

install-crl <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--file-on-server|-f] --config|-c config-name crl-file

Description

Use this command to install a Certificate Revocation List (CRL). A CRL is a revocation list provided by a certificate authority (CA). A CRL lists all certificates that either client or server users should no longer trust. When the data in a certificate changes, the certificate is revoked.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration where you want to install the CRL.
--file-on-server|- f: If you specify this option, the CRL file is on the administration server machine.

Operands

crl-file: Specify the name of the CRL file that you want to install.

Examples

wadm install-crl --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 ServerSign.crl

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-acls(1)

Name

list-acls– lists all ACLs

Synopsis

list-acls <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--vs|-s vs-name] --config|-c config-name

Description

Use this command to list all Access Control Lists (ACL).

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which you want to list the ACLs.

Examples

wadm list-acls --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-authdbs(1)

Name

list-authdbs– lists all authentication databases

Synopsis

list-authdbs <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--vs|-s vs-name] --config|-c config-name

Description

Use this command to list all authentication databases.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify the option, the command displays additional columns of information.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which you want to list the authentication databases.

Examples

wadm list-authdbs --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-authdb-userprops(1)

Name

list-authdb-userprops– lists the authentication database user properties

Synopsis

list-authdb-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--vs|-s vs-name] 
--config|-c config-name --authdb|-a name

Description

Use this command to list the authentication database user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which you want to list the authentication database user properties.
--authdb|-a: Specify the name of the authentication database that contains the user properties to be listed.

Examples

wadm list-authdb-userprops --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --authdb=LDAP1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-auth-realms(1)

Name

list-auth-realms– lists all authentication realms

Synopsis

list-auth-realms <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all authentication realms.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.

Examples

wadm list-auth-realms --user=admin --port=8989
--password-file=../admin.passwd --host=serverhost --ssl=true
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-auth-realm-userprops(1)

Name

list-auth-realm-userprops– lists authentication realm properties

Synopsis

list-auth-realm-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name 
--realm|-L name

Description

Use this command to list all authentication realm properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--realm|-L: Specify the name of the authentication realm.

Examples

wadm list-auth-realm-userprops --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--realm=basic

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-certs(1)

Name

list-certs– lists all certificates

Synopsis

list-certs <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--cert-type|-y(server|ca;
default is 'server')] [--token|-t name] 
[--token-pin|-P name] --config|-c config-name

Description

Use this command to list all certificates.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--token|-t: Specify the token (cryptographic device), which contains the encrypted public key.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--cert-type|-y: Specify the value as server to list the server certificates, or ca to list the certificate authority (CA) certificates.
--config|-c: Specify the name of the configuration for which you want to list the certificates.

Examples

wadm list-certs --user=admin --host=serverhost --port=8989
--ssl=true --prompt=false --rcfile=null --config=config1
--password-file=certdb.newpasswd

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-cgi-dirs(1)

Name

list-cgi-dirs– lists CGI directories

Synopsis

list-cgi-dirs <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name

Description

Use this command to list the CGI directories.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the CGI directories.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.

Examples

wadm list-cgi-dirs --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-cgi-envvars(1)

Name

list-cgi-envvars– lists the CGI environment variables

Synopsis

list-cgi-envvars <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list the CGI environment variables.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the CGI environment variables.

Examples

wadm list-cgi-envvars --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-ciphers(1)

Name

list-ciphers– lists ciphers

Synopsis

list-ciphers <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--cipher-type|-t ssl2/ssl3tls ] 
--config|-c config-name --http-listener|-l name

Description

Use this command to list SSL ciphers.

If you are using a ssl2 cipher, the following cipher names are valid:

SSL_RC4_128_WITH_MD5
SSL_RC4_128_EXPORT40_WITH_MD5
SSL_RC2_128_CBC_WITH_MD5
SSL_RC2_128_CBC_EXPORT40_WITH_MD5
SSL_DES_64_CBC_WITH_MD5
SSL_DES_192_EDE3_CBC_WITH_MD5

If you are using a ssl3tls cipher, the following cipher names are valid:

SSL_RSA_WITH_RC4_128_MD5
SSL_RSA_WITH_RC4_128_SHA
SSL_RSA_WITH_3DES_EDE_CBC_SHA
SSL_RSA_WITH_DES_CBC_SHA
SSL_RSA_EXPORT_WITH_RC4_40_MD5
SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5
SSL_RSA_WITH_NULL_MD5
SSL_RSA_WITH_NULL_SHA
SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA
SSL_RSA_FIPS_WITH_DES_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_RC4_128_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_RSA_EXPORT1024_WITH_DES_CBC_SHA
TLS_RSA_EXPORT1024_WITH_RC4_56_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_NULL_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_NULL_SHA
TLS_ECDHE_RSA_WITH_RC4_128_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--cipher-type|-t: Specify the type of cipher. The value can be ssl2 or ssl3tls ciphers.
--config|-c: Specify the name of the configuration for which you want to list the ciphers.
--http-listener|-l: Specify the name of the HTTP listener.

Examples

wadm list-ciphers --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--cipher-type=ssl3tls --config=config1 --http-listener=config1_ls

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-config-files(1)

Name

list-config-files– lists configuration files

Synopsis

list-config-files <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list the configuration file information.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.

Examples

wadm list-config-files --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-configs(1)

Name

list-configs– lists all existing configurations

Synopsis

list-configs <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l]

Description

Use this command to list all existing configurations.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.

Examples

wadm list-configs --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-crls(1)

Name

list-crls– lists all installed CRLs

Synopsis

list-crls <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name

Description

Use this command to list the Certificate Revocation List (CRL) for a specified configuration.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to view the CRLs.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-crls --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-custom-resources(1)

Name

list-custom-resources– lists all custom resources

Synopsis

list-custom-resources <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all custom resources.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the custom resources.

Examples

wadm list-custom-resources --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-custom-resource-userprops(1)

Name

list-custom-resource-userprops– displays all custom resource properties

Synopsis

list-custom-resource-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name 
--jndi-name|-j resourcename

Description

Use this command to list all custom resource properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the name of the Java Naming and Directory Interface.

Examples

wadm list-custom-resource-userprops --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=custom

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-dav-collections(1)

Name

list-dav-collections– displays a list of DAV collections

Synopsis

list-dav-collections <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to view a list of DAV collections.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the DAV collection.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-dav-collections --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-document-dirs(1)

Name

list-document-dirs– lists all document directories

Synopsis

list-document-dirs <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name

Description

Use this command to list all document directories.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the document directories.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-document-dirs --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-error-pages(1)

Name

list-error-pages– lists error pages

Synopsis

list-error-pages <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] [--all|-l] 
--vs|-s vs-name --config|-c config-name

Description

Use this command to list the error pages.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the error pages.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-error-pages --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=config1_vs_1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-events(1)

Name

list-events– displays all events

Synopsis

list-events <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all scheduled events.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the events.

Examples

wadm list-events --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-external-jndi-resources(1)

Name

list-external-jndi-resources– lists all external JNDI resources

Synopsis

list-external-jndi-resources <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all external Java Naming and Directory Interface (JNDI) resources.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the external JNDI resources.

Examples

wadm list-external-jndi-resources --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989
--ssl=true --no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-external-jndi-resource-userprops(1)

Name

list-external-jndi-resource-userprops– lists all external JNDI resource properties

Synopsis

list-external-jndi-resource-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name 
--jndi-name|-j resourcename

Description

Use this command to list the external JNDI (Java Naming and Directory Interface) resource properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the resource.

Examples

wadm list-external-jndi-resource-userprops --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=external-jndi

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-fastcgi-handlers(1)

Name

list-fastcgi-handlers– lists FastCGI handlers

Synopsis

list-fastcgi-handlers <connect_options>[--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--uri-pattern|-t pattern] 
--config|-c config-name --vs|-s vs-name

Description

Use this command to list all FastCGI handlers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--uri-pattern|-t: Specify the URI pattern.
--config|-c: Specify the name of the configuration for which you want to list the FastCGI handlers.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-fastcgi-handlers --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --uri-pattern=/fastcgi/* --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-group-members(1)

Name

list-group-members– lists group members

Synopsis

list-group-members <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--org-unit|-o orgunit] [--vs|-s vs-name]
--config|-c config-name --authdb|-a name --group|-g group-id

Description

Use this command to list all group members.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the group members.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Enter a description of an organizational unit within your company to which this group member belongs.
--authdb|-a: Specify the name of the authentication database that stores the group information.
--group|-g: Specify the ID of the group member.

Examples

wadm list-group-members --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --authdb=LDAP1 --group=group1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-groups(1)

Name

list-groups– lists user groups

Synopsis

list-groups <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--name|-n wildcardcharacter] 
[--vs|-s vs-name] --config|-c config-name --authdb|-a name

Description

Use this command to list user groups.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--name|-n: Specify the name of the user group that you want to list. Use wildcard character to list specific user groups.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which you want to list the group information.
--authdb|-a: Specify the name of the authentication database that stores the group information.

Examples

wadm list-groups --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --authdb=LDAP1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-http-listeners(1)

Name

list-http-listeners– displays all existing HTTP listeners

Synopsis

list-http-listeners <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all existing HTTP listeners.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the HTTP listener sockets.

Examples

wadm list-http-listeners --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-instances(1)

Name

list-instances– lists all nodes or configurations

Synopsis

list-instances <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--config|-c config-name] [--node|-n node-name] 
[--all|-l  (--config=name | --node=name)]

Description

Use this command to list all instances. If you specify the configuration name, the command lists all nodes on which the configuration is deployed. If you specify the node, the command lists all configurations deployed on that node. In the verbose mode, this command also lists the instance status.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration for which you want to list the nodes.
--node|-n: Specify the host name of the node for which you want to list the configurations.
--all|-l: If you specify this option, the command displays additional columns of information.

Examples

wadm list-instances --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-jdbc-resources(1)

Name

list-jdbc-resources– lists all JDBC resources

Synopsis

list-jdbc-resources <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all JDBC resources.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the JDBC resources.

Examples

wadm list-jdbc-resources --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-jdbc-resource-userprops(1)

Name

list-jdbc-resource-userprops– lists all JDBC resource properties

Synopsis

list-jdbc-resource-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] [--property-type|-t
type] --config|-c config-name --jndi-name|-j
resourcename

Description

Use this command to list the JDBC resource properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--property-type|-t: Specify the type of the JDBC resource property. The types of property can be property, connection-lease-property, or connection-creation-property. The default type is property.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the name of the Java Naming and Directory Interface (JNDI).

Examples

wadm list-jdbc-resource-userprops --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null  --config=config1 
--jndi-name=jdbc

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-jvm-options(1)

Name

list-jvm-options– lists all JVM options

Synopsis

list-jvm-options <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  [--all|-l] [--profiler|-r profiler-name] 
[--debug-options|-d] --config|-c config-name

Description

Use this command to list all Java Virtual Machine (JVM) options.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--profiler|-r: Indicates if these options belong to the JVM profiler.
--debug-options|-d: Specify this option to list the JVM options of type debug.
--config|-c: Specify the name of the configuration for which you want to list the JVM options.

Examples

wadm list-jvm-options --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-jvm-profilers(1)

Name

list-jvm-profilers– lists all JVM profilers

Synopsis

list-jvm-profilers <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all Java Virtual Machine (JVM) profilers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the JVM profilers.

Examples

wadm list-jvm-profilers --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-lifecycle-modules(1)

Name

list-lifecycle-modules– lists all lifecycle modules

Synopsis

list-lifecycle-modules <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all lifecycle modules.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the lifecycle modules.

Examples

wadm list-lifecycle-modules --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-lifecycle-module-userprops(1)

Name

list-lifecycle-module-userprops– lists the lifecycle module properties

Synopsis

list-lifecycle-module-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name 
--module|-m name

Description

Use this command to list the lifecycle module properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--module|-m: Specify the name of the life cycle module.

Examples

wadm list-lifecycle-module-userprops --user=admin 
--host=serverhost--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --module=Lifecycle1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-locks(1)

Name

list-locks– displays a list of locks

Synopsis

list-locks <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
--collection-uri|-d uri

Description

Use this command to view a list of locks. You can lock a resource so as to serialize access to that resource. Using a lock, a user accessing a particular resource is reassured that another user will not modify the same resource. The lock database maintained by the server keeps track of the lock tokens that are issued to users.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to list the locks.
--vs|-s: Specify the name of the virtual server.
--collection-uri|-d: Specify the name of the collection URI.

Examples

wadm list-locks --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs1 --collection-uri=/dav1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-mail-resources(1)

Name

list-mail-resources– lists all mail resources

Synopsis

list-mail-resources <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all mail resources.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration for which you want to view the mail resources.

Examples

wadm list-mail-resources --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-mail-resource-userprops(1)

Name

list-mail-resource-userprops– lists the mail resource user properties

Synopsis

list-mail-resource-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name 
--jndi-name|-j name

Description

Use this command to list the mail resource user properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the mail resource.

Examples

wadm list-mail-resource-userprops --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --jndi-name=MailReso

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-mime-types(1)

Name

list-mime-types– lists all MIME types

Synopsis

list-mime-types <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--vs|-s vs-name] 
[--category|-y type|enc|lang] 
--config|-c config-name

Description

Use this command to list all MIME (Multi-purpose Internet Mail Extension) types.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--vs|-s: Specify the name of the virtual server.
--category|-y: Specify the category of the MIME types. The value can be type, enc, or lang.
--config|-c: Specify the name of the configuration.

Examples

wadm list-mime-types --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-nodes(1)

Name

list-nodes– lists all nodes

Synopsis

list-nodes <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--all|-l]

Description

Use this command to lists all the nodes that are registered to the administration server. This command also lists the node status.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.

Examples

wadm list-nodes --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-org-units(1)

Name

list-org-units– lists all organization units

Synopsis

list-org-units <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--all|-l] [--vs|-s vs-name] 
--config|-c config-name --authdb|-a name

Description

Use this command to list all organization units.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which you want to list the organization units.
--authdb|-a: Specify the authentication database that stores the organization unit information.

Examples

wadm list-org-units --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt
--rcfile=null --config=config1 --authdb=LDAP1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-reverse-proxy-headers(1)

Name

list-reverse-proxy-headers– lists reverse proxy headers

Synopsis

list-reverse-proxy-headers <connect_options> [--echo|-e] 
[--no-prompt|-Q][--verbose|-v] [--all|-l] --config|-c config-name 
--vs|-s vs-name --uri-prefix|-r uri-prefix

Description

Use this command to list the reverse proxy headers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--uri-prefix|-r: Specify the URI of the reverse proxy.

Examples

wadm list-reverse-proxy-headers --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs 
--uri-prefix=/simple/

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-reverse-proxy-uris(1)

Name

list-reverse-proxy-uris– lists the reverse proxy URIs

Synopsis

list-reverse-proxy-uris <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
--vs|-s vs-name

Description

Use this command to list the reverse proxy Universal Resource Indicators (URI).

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-reverse-proxy-uris --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-search-collections(1)

Name

list-search-collections– lists search collections

Synopsis

list-search-collections <connect_options> [--echo|-e] 
[--no-prompt|-Q][--verbose|-v] [--all|-l] --vs|-s vs-name 
--config|-c config-name

Description

Use this command to list the search collections.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-search-collections --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-search-events(1)

Name

list-search-events– lists all search events

Synopsis

list-search-events <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name 
--collection|-O name

Description

Use this command to list search events.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--collection|-O: Specify the name of the collection.

Examples

wadm list-search-events --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs1 --collection=coll1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-soap-auth-providers(1)

Name

list-soap-auth-providers– lists all SOAP authentication providers

Synopsis

list-soap-auth-providers <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] 
--config|-c config-name

Description

Use this command to list the SOAP authentication providers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.

Examples

wadm list-soap-auth-providers --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-soap-auth-provider-userprops(1)

Name

list-soap-auth-provider-userprops– lists the SOAP authentication provider properties

Synopsis

list-soap-auth-provider-userprops <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name 
--provider|-o name

Description

Use this command to list the SOAP authentication provider properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--provider|-o: Specify the name of the SOAP authentication provider.

Examples

wadm list-soap-auth-provider-userprops --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989
--ssl=true --no-prompt --rcfile=null --config=config1
--provider=soap-auth

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-tokens(1)

Name

list-tokens– lists PKCS #11 tokens

Synopsis

list-tokens <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all PKCS#11 tokens.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.

Examples

wadm list-tokens --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-uri-patterns(1)

Name

list-uri-patterns– lists all URI patterns

Synopsis

list-uri-patterns <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--feature|-f feature] 
--vs|-s vs-name --config|-c config-name

Description

Use this command to list all Uniform Resource Indicator (URI) patterns.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--feature|-f: Specify the feature whose URI patterns should be listed.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-uri-patterns --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-url-redirects(1)

Name

list-url-redirects– lists all forwarding URLs

Synopsis

list-url-redirects <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --type|-t (uri-prefix|condition) 
--config|-c config-name --vs|-s vs-name

Description

Use this command to list all forwarding URLs.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--type|-t: Specify the type of the URL redirects.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Examples

wadm list-url-redirects --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-users(1)

Name

list-users– lists all users

Synopsis

list-users <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] [--uid|-U wildcardstr] 
[--first-name|-f wildcardstr] [--last-name|-n wildcardstr] 
[--email|-mwildcardstr] [--vs|-s vs-name] 
--config|-c config-name --authdb|-a name

Description

Use this command to list all users.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--first-name|-f: Specify a wildcard string for the user's first name.
--last-name|-n: Specify a wildcard string for the user's last name.
--uid|-U: Specify a wildcard string for the user ID.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.
--authdb|-a: Specify the name of the authentication database from which the list of users will being obtained.

Examples

wadm list-users --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 --authdb=LDAP1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-variables(1)

Name

list-variables– lists all variables

Synopsis

list-variables <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--all|-l] --config|-c config-name

Description

Use this command to list the server.xml variables.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Examples

wadm list-variables --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-virtual-servers(1)

Name

list-virtual-servers– lists all virtual servers

Synopsis

list-virtual-servers <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name

Description

Use this command to list all virtual servers.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration where the virtual servers exist.

Examples

wadm list-virtual-servers --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

list-webapps(1)

Name

list-webapps– lists all web applications

Synopsis

list-webapps <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name

Description

Use this command to list all web applications.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--all|-l: If you specify this option, the command displays additional columns of information.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of a virtual server.

Examples

wadm list-webapps --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

migrate-jks-keycert(1)

Name

migrate-jks-keycert– migrates all certs and keys from JKS

Synopsis

migrate-jks-keycert <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--token|-t name] 
[--key-password|-y] [--keystore-password|-o] 
[--token-pin|-P] --config|-c config-name 
--keystore|-k path

Description

Given a Java keystore, this command will migrate all certificates and keys from the JKS to the configuration's certificate database (NSS based). The Administration password file must contain the following lines for migrate-jks-keystore, else you will be prompted for these passwords:

wadm_key_password=<pswd>
wadm_keystore_password=<pswd>
wadm_token_pin=<pswd>

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--key-password|-y: Specify the key password while migrating the JKS. You can also define the key-password in the password file.
--keystore-password|-o: Specify the key store password while migrating the JKS. You can also define the keystore-password in the password file.
--token|-t: Specify the token (cryptographic device), which contains the encrypted public key.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--config|-c: Specify the name of the configuration.
--keystore|-k: Specify the path to the JKS path.

Examples

wadm migrate-jks-keycert --user=admin --host=serverhost 
--port=8989 --ssl=true --prompt=false --rcfile=null
--password-file=certdb.newpasswd --config=config1 
--token=internal --keystore=server-truststore.jks

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

migrate-server(1)

Name

migrate-server– migrates instances

Synopsis

migrate-server <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--search-collection-copy-path|-s
 directory] [--log-dir|-d directory] 
([--all|-l]|[--config|-c newconfigname]|
[--instance|-n instancename]) --server-root|-r path

Description

Use this command to migrate Web Server instances. This command migrates a Web Server 6.0 or 6.1 instance to Web Server 7.0. The old and new instance installation should always be on the same machine. Before migration, stop the old server instance to avoid any port clashes. See the migration log before using the migrated instance to check if any manual configuration is required.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--search-collection-copy-path -s: Specify the directory for the search-collections of the old instance.
--config|-c: Specify the name of the new configuration that will be created after migration.
--instance|-n: Specify the name of the instance to be migrated.
--all|-l: Specify this option to migrate all server instances.
--log-dir|-d: Specify the directory for creating the migration log files, for example, server_root/admin-serv/logs.
--server-root|-r: Specify the installation location (directory) where previous versions of Web Server, that is, 6.0 or 6.1 is installed.

Examples

wadm migrate-server --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --log-dir=/sun/WS7/https-server1/logs 
--server-root=/sun/WS7 --instance=https-instance1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

pull-config(1)

Name

config-store

Synopsis

pull-config <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  nodehost

Description

Use this command to pull a configuration from any instance of the configuration and overwrite the configuration in the config-store. You can use this command when an instance is modified manually, so that the manual modification can be reflected in the config-store.

Do not edit any file under the config-store directory. The files under this directory are created by Sun Java System Web Server for internal use.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the server configuration.

Operands

nodehost: Specify the name of the node.

Examples

wadm pull-config --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

reconfig-instance(1)

Name

reconfig-instance– reconfigures server instances

Synopsis

reconfig-instance <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (nodehost)*

Description

Use this command to reconfigure server instances. Configuration changes are reflected on instances without a server restart. Only dynamically reconfigurable changes in the configuration will be effected.

Changes in the user, temp-path, log, thread-pool, pkcs11, stats, cgi, dns, dns-cache, file-cache, acl-cache, ssl-session-cache, access-log-buffer, and jvm [except log-level] settings will not come in to effect after a reconfiguration. Any such changes that require restart will be logged when a reconfiguration is done. Reconfiguring the file cache requires a server restart.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

nodehost: Specify the name of the node.

Examples

wadm reconfig-instance --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

register-node(1)

Name

Synopsis

register-node <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]

Description

Use this command to register an administration node with an administration server. Note that the administration server must be running for register-node to work

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Examples

wadm register-node --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

reindex-search-collection(1)

Name

reindex-search-collection– reindexes a search collection

Synopsis

reindex-search-collection <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name collection-name

Description

Use this command to reindex a search collection. If you modify the documents after creating a collection, the collection is reindexed. Reindexing a collection does not index any new content into the collection; it only updates the existing contents. Also, it removes the index entries for documents that are no longer present in the server file system.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

collection-name: Specify the name of the collection.

Examples

wadm reindex-search-collection --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--vs=vs searchcoll

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

remove-documents(1)

Name

remove-documents– removes search documents

Synopsis

remove-documents <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --pattern|-P pattern 
--config|-c config-name --collection|-O name

Description

Use this command to remove the search documents.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--pattern|-P: Specify the wild card pattern of the documents that have to be deleted.
--config|-c: Specify the name of the configuration.
--collection|-O: Specify the name of the collection.

Examples

wadm remove-documents --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null  
--config=config1 --vs=vs --pattern=*.jpg --collection=searchcoll2

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

remove-node(1)

Name

remove-node– removes a node from the server farm

Synopsis

remove-node <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--force|-f] --node|-n node-name

Description

Use this command to remove a node from the server farm.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--force|-f: Specify this option to enable a forced removal of a node.
--node|-n: Specify the name of the node that you want to remove.

Examples

wadm remove-node --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--node=node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

remove-webapp(1)

Name

remove-webapp– removes web applications

Synopsis

remove-webapp <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]  --vs|-s vs-name --uri|-r context-root 
--config|-c config-name

Description

Use this command to remove a web application.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--uri|-r: Specify the root URI for the web application.
--config|-c: Specify the name of the configuration.

Examples

wadm remove-webapp --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --vs=vs --uri=/simpleapp

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

renew-admin-certs(1)

Name

renew-admin-certs– renews administration certificates

Synopsis

renew-admin-certs <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--token-pin|-P name] [--validity|-d num of months]

Description

Use this command to renew the administration certifications with the nicknames Admin-CA-Cert, Admin-Server-Cert, and Admin-Client-Cert. This command also updates the nodes that are currently running and are accessible with the renewed certificates.

After you run this command, it is recommended that you stop and restart the administration servers and nodes so that the new certificates will be in effect. It is necessary that you re-register a node if the node was offline (not running or was not accessible due to network problems) during the renewal of the certificates.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--validity|-d: Specify the validity period (in months) for the administration certificates. The default validity period is 120 months.

Examples

wadm renew-admin-certs --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --validity=120

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

restart-admin(1)

Name

restart-admin– restarts the administration server or node

Synopsis

restart-admin <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] nodehost

Description

Use this command to restart the administration server or node. This command allows you to restart only the administration server. To restart any instance, use the restart-instance command.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

nodehost: Specify the name of the administration server or node.

Examples

wadm restart-admin --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

restart-instance(1)

Name

restart-instance– restarts instances

Synopsis

restart-instance <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (nodehost)*

Description

Use this command to restart the instance running on the specified configuration and on the specified node. If no nodes are specified, all instances running on the specified configuration are restarted. If the instance on any node is not running, this command will display an error.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the configuration that the instance points to.

Operands

nodehost: Specify the name of the node.

Examples

wadm restart-instance --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

rotate-log(1)

Name

rotate-log– rotates log

Synopsis

rotate-log <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (nodehost)*

Description

Use this command to rotate log. The logs are rotated at the time you execute this command. The server saves the old log files and marks the saved file with a name that includes the date and time when they were saved.

Note –

You can set up your log files to be automatically archived. At a certain time, or after a specified interval, the server rotates your access logs.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

nodehost: Specify the name of the node.

Examples

wadm rotate-log --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-access-log-buffer-prop(1)

Name

set-access-log-buffer-prop– edits the access log buffer properties

Synopsis

set-access-log-buffer-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
(property-name=value)+

Description

Use this command to edit the access log buffer properties. The properties that you can edit are as follows:

enabled - Indicates whether the system buffers access log updates. The default value is true.
buffer-size - The size (in bytes) of individual access log buffers. The range of values is 4096–1048576.
max-buffers - The maximum number of access log buffers per server. The range of values is 1–65536.
max-buffers-per-file - The maximum number of access log buffers per access log file. The range of values is 1–128. The default value is default.
max-age - The maximum amount of time to buffer a given access log entry. The range of values is 0.001–3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config -c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the access log buffer property that you want to edit.

Examples

wadm set-access-log-buffer-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
max-buffers=1200 buffer-size=8193 enabled=true max-age=1 
max-buffers-per-file=8

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-acl(1)

Name

set-acl– edits an Access Control List

Synopsis

set-acl <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
--aclfile|-l file

Description

Use this command to edit an Access Control List (ACL).

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--aclfile|-l: Specify the name of ACL file that you want to edit to add or remove an access control entry.
--config|-c: Specify the name of the configuration.

Examples

wadm set-acl --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--vs=vs --config=config1 --aclfile=sample.acl

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-acl-cache-prop(1)

Name

set-acl-cache-prop– edits the ACL cache properties

Synopsis

set-acl-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (propertyname=value)+

Description

Use this command to edit the access control list (ACL) cache properties. The properties that you can edit are as follows:

enabled - Indicates whether the server caches the file content and meta information. The default value is true.
max-users - The maximum number of users for which the server will cache authentication information. The range of values is 1 - 1048576.
max-groups-per-user — The maximum number of groups per user for which the server will cache the membership information. The range of values is 1 - 1024.
max-age — The maximum amount of time ((in seconds) to cache the authentication information. The range of values is 0.001 - 3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the file cache property that you want to edit.

Examples

wadm set-acl-cache-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=false max-users=400 
max-age=240 max-groups-per-user=8

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-admin-prop(1)

Name

set-admin-prop– sets the administration node properties

Synopsis

set-admin-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--node|-n node-name] [--set-password|-r]
(propertyname=value)+

Description

Use this command to edit the administration node properties. The properties that you can edit are as follows:

description - The description of the node.
server-user - The user ID of the server user, for example, root.
ssl-port - The SSL port if the server uses SSL connection to communicate.
non-ssl-port - The non-SSL port if the server uses non-SSL connection to communicate.
java-home - The location of the JDK directory. The JDK must have permission for the account the server runs as.
log-level - The log verbosity for the server.
log-file - The path of the server's log file.
admin-user - The user name of the authorized Web Server administrator.
access-log-file - The path of the server's access log file.

Note: If you modify the java-home property, stop and start the administration server on the specified node for the changes to take effect. If you make changes to any other properties, restart the administration server on the specified node.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--set-password|-r: Specify this option to change the administration server user password.

Operands

propertyname=value: Specify the name and value of the administration node property that you want to edit.

Examples

wadm set-admin-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null log-level=fine is-admin-server=false

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-authdb-prop(1)

Name

set-authdb-prop– edits the authentication database properties

Synopsis

set-authdb-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name 
--authdb|-a authdb-name  (propertyname=value)+

Description

Use this command to edit the authentication database properties. The properties that you can edit are as follows:

enabled — Indicates whether the authentication database is enabled at runtime. The default value is true.
path — The path of the authentication database.
url — The URL of the authentication database.
auth-expiring-url — The URL to which the server redirects the request to in case the password is about to expire soon.
bind-dn — The name that the Administration Server uses to initially bind (or log in) to the directory server, for example, cn=Directory Manager.
bind-pw — (Applicable only for databases of type LDAP.) The password used for authentication.
dc-suffix — The dcsufix of the LDAP database.
search-filter — The search filter to find the user.
group-search-filter — The search filter to find group memberships for the user.
group-search-attr — The LDAP attribute name that contains the group name entries.
digestauthstate — Indicates whether the LDAP server is capable of handling HTTP digest authentication.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration for which the authentication database properties are being edited.
--authdb|-a: Specify the name of the authentication database.

Operands

propertyname=value: Specify the name and value of the authentication database property that you want to edit.

Examples

wadm set-authdb-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --authdb=KEYFILE1 enabled=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-auth-realm-prop(1)

Name

set-auth-realm-prop– edits authentication realms

Synopsis

set-auth-realm-prop <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--realm|-L name (propertyname=value)

Description

Use this command to edit an authentication realm. The properties that you can edit are as follows:

type — The name of a built-in authentication realm type. (Applicable only when class is omitted.)
class - The class that implements a pluggable Servlet container authentication realm. (Applicable only when class is omitted.)

Options

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--realm|-L: Specify the name of the authentication realm.

Operands

propertyname=value: Specify the name and value of the authentication realm property that you want to edit.

Examples

wadm set-auth-realm-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --realm=basic type=file
class=com.iplanet.ias.security.auth.realm.file.FileRealm

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-cache-control-directives(1)

Name

set-cache-control-directives– edits cache control directives information

Synopsis

set-cache-control-directives <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern]
--config|-c config-name --vs|-s vs-name (propertyname=value)+

Description

Use this command to edit the file cache directives. Web Server uses the cache-control directives to control the information that is cached by a Proxy Server. Using the cache-control directives, you can override the default caching of the proxy to protect sensitive information from being cached. For these directives to work, the Proxy Server must comply with HTTP 1.1. The properties that you can edit are as follows:

public — Indicates that the response is cachable by any cache. This is the default behavior.
private — Indicates that the response is only cachable by a private (non-shared) cache.
no-cache — Indicates that the response is not cached.
no-store — Indicates that the cache does not store the request or response anywhere in nonvolatile storage.
must-revalidate — Indicates that the cache entry is re-validated from the originating server.
max-age — The maximum age (in seconds) the client accepts a response.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname=value: Specify the name and value of the cache control directive property that you want to edit. The list of properties are private, public, max-age, no-cache, must-revalidate, and no-store.

Examples

wadm set-cache-control-directives --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs1 
public=true private=true must-revalidate=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-cert-trust-prop(1)

Name

set-cert-trust-prop– sets the certificate trust properties

Synopsis

set-cert-trust-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--token|-t name] [--token-pin|-P name]
[--nickname|-n nickname] --config|-c config-name 
(propertyname=value)+

Description

Use this command to edit the certificate trust properties. A certificate is issued and digitally signed by a CA. You decide which CAs you trust enough to serve as verifiers of other users' identity. Before requesting a server certificate, you must create a trust database. The properties that you can edit are as follows:

is-client-ca — Indicates if this certificate is trusted to sign client certificates.
is-server-ca — Indicates if this certificate is trusted to sign server certificates.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--token|-t: Specify the token (cryptographic device), which contains the encrypted public key.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--nickname|-n: Specify the short name or the nick name of the certificate.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the certificate trust property that you want to edit.

Examples

wadm set-cert-trust-prop --user=admin --host=serverhost 
--password-file=certdb.newpasswd --port=8989 --ssl=true
--prompt=false --rcfile=null --config=config1 --token=internal 
--nickname="Cert Manager-Sun" is-client-ca=true is-server-ca=false

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-cgi-prop(1)

Name

set-cgi-prop– edits the CGI properties

Synopsis

set-cgi-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] [--uri-pattern|-t pattern]
--config|-c config-name (propertyname=value)+

Description

Use this command to edit the common gateway interface (CGI) properties. CGI programs can be defined with any number of programming languages. The properties that you can edit are as follows:

If you specify the --config option, you can view the following properties:

timeout - The timeout (in seconds) after which the server will terminate a long-running CGI program. The range of values is 0.001-3600, or -1 for no timeout.
idle-timeout - The timeout (in seconds) after which the server will terminate a nonresponsive CGI program. The range of values is 0.001-3600.
cgistub-path - The path to the Cgistub binary. The default value is default.
cgistub-idle-timeout - The timeout (in seconds) after which an unused Cgistub process will be terminated. The range of values is 0.001-3600.
min-cgistubs - The minimum number of Cgistub processes the server will keep while waiting to run the CGI programs. The range of values is 1-4096.
max-cgistubs - The maximum number of Cgistub processes the server will keep on hand, waiting to run CGI programs. The range of values is 1-4096.

If you specify the --vs option, you can view the following properties:

user – The name of the user to execute the CGI programs.
group – The name of the group to execute the CGI programs.
chroot – The additional root directory that you create to limit the server to specific directories.
directory – The directory to change to after chroot but before the execution of the CGI program begins.
nice – The nice value is an increment that determines the priority of the CGI program's relative to the server. Typically, the server runs with a nice value of 0 and the nice increment would be between 0 (the CGI program runs at the same priority as the server) and 19 (the CGI program runs at a much lower priority than the server).

You can increase the priority of the CGI program above that of the server by specifying a nice increment of -1. Sun, however, does not recommended you to do so.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: (This option is deprecated.) Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the CGI property that you want to edit.

Examples

wadm set-cgi-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 timeout=10 max-cgistubs=20 
idle-timeout=600 min-cgistubs=10 cgistub-idle-timeout=60 
cgistub-path=../../lib/Cgistub

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-config-file(1)

Name

set-config-file– sets the configuration file details

Synopsis

set-config-file <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --upload-file|-o  localfile 
(filename)

Description

Use this command to edit any configuration file present in the config directory under server-root.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--upload-file|-o: Specify the name of the local file to be uploaded to the configuration directory.

Operands

filename: Specify the name of the configuration file.

Examples

wadm set-config-file --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 
--upload-file=magnus.conf magnus.conf

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-config-prop(1)

Name

set-config-prop– edits the config properties

Synopsis

set-config-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname=value)+

Description

Use this command to edit the configuration file properties. The properties that you can edit are as follows:

default-auth-db-name — The name of the default authentication database.
user — The name of the Web Server user.
audit-accesses — Indicates whether the authentication and authorization events are logged. The default value is false.
acl-file (read-only) — The name of the ACL file that controls access to the server.
mime-file (read-only) — The name of the mime.types file that configures the MIME mappings for the server.
platform — Indicates whether the server runs as a 32-bit or 64-bit process. The value can be 32 or 64.
temp-path — The path where the server stores its temporary files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the configuration property that you want to edit.

Examples

wadm set-config-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 platform=32 audit-accesses=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-custom-resource-prop(1)

Name

set-custom-resource-prop– edits the custom resource properties

Synopsis

set-custom-resource-prop <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--jndi-name|-j name (propertyname=value)+

Description

Use this command to edit custom resource properties. The properties that you can edit are as follows:

enabled - Indicates whether the custom resource is enabled at runtime. The default value is true.
res-type - The type of custom resource.
factory-class - The class that instantiates a naming context which is used to look up the external resource. The value is a fully qualified class name that implements javax.naming.spi.ObjectFactory.
description - The description of the resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the custom resource.

Operands

propertyname=value: Specify the name and value of the custom resource property that you want to edit.

Examples

wadm set-custom-resource-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989
--ssl=true--no-prompt --rcfile=null --config=config1 
--jndi-name=custom enabled=true 
res-type=samples.jndi.cust-Resource.MyBean
factory-class=samples.jndi.cust-Resource.MyCustomConnectionFactory

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-dav-collection-prop(1)

Name

set-dav-collection-prop– edits the DAV collection properties

Synopsis

set-dav-collection-prop <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name--uri|-r uri (propertyname=value)+

Description

Use this command to edit the DAV collection properties. You can edit the following properties:

enabled - Indicates whether WebDAV is enabled for the collection at runtime. The default value is true.
provider — The name of the provider that manages this collection.
default-owner - The name of the default owner of the resources.
uri - The existing root URI on which WebDAV should be enabled.
source-uri - The new URI that the clients can use to access the source code of content.
min-lock-timeout - The minimum time (in seconds) for WebDAV locks to expire. The range of values is 0.001 - 3600, or -1 to not enforce a minimum.
max-xml-request-body-size - The maximum size (in bytes) allowed for WebDAV XML request bodies. The range of values is 0 - 2147483647, or -1 for no limit.
max-propfind-depth - The maximum depth of PROPFIND requests sent to the collections. The values can be 0, 1, or infinity.
max-expand-property-depth - The maximum depth allowed for WebDAV expand-property REPORT responses. The range of values is 0 - 100.
max-report-response-elements - The upper limit of the number of response elements a REPORT response body can have. The range of values is 0 - 2147483647. The default value is 1000.
auth-auth-db-name - The ACL authentication database to use. The default value is default.
auth-method - The authentication method to use. The values can be basic, digest, or ssl. The default value is basic.
auth-prompt - The prompt that will be displayed to clients during authentication. The default value is Sun Java System Web Server WebDAV.
acl-db-max-size - The maximum size (in bytes) of the memory representation of the WebDAV ACL database for a collection. If this memory limit is exceeded, the server will not cache the WebDAV ACL lists. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-max-entries - The maximum number of ACEs to allow on a single resource. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-update-interval - The interval (in seconds) at which WebDAV ACL databases are synchronized to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV ACL lists.
property-db-max-size - The maximum size (in bytes) of WebDAV property database files. The range of values is 0 - 2147483647, or -1 for no limit.
property-db-update-interval - The interval (in seconds) at which WebDAV property databases are synchronized to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV properties.
lock-db-path - The path of the WebDAV lock database.
lock-db-update-interval - The interval (in seconds) at which the WebDAV lock databases are synchronized to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV lock information.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration where this DAV collection exists.
--vs|-s: Specify the name of the virtual server.
--uri|-r: Specify the URI through which the content is accessed.

Operands

propertyname=value: Specify the name and value of the DAV collection property that you want to edit.

Examples

wadm set-dav-collection-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs 
--uri=/dav_config1 min-lock-timeout=1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-default-content-type(1)

Name

set-default-content-type– edits the default content type details

Synopsis

set-default-content-type <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--uri-pattern|-t pattern] [--charset|-r text]
--config|-c config-name --vs|-s vs-name content-type

Description

Use this command to edit the default content type details.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--charset|-r: Specify the default character set to be used.

Operands

content-type: Specify the type of the default content that you want to edit.

Examples

wadm set-default-content-type --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--vs=vs text/pdf

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-dns-cache-prop(1)

Name

set-dns-cache-prop– edits the DNS cache properties

Synopsis

set-dns-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname=value)+

Description

Use this command to edit the Domain Name Server (DNS) cache properties. The properties that you can edit are as follows:

enabled - Indicates whether the server caches the DNS lookup results. The default value is true.
max-age - The maximum amount of time (in seconds) to cache a DNS lookup result. The range of values is 1–31536000.
max-entries - The maximum number of DNS lookup results to cache. The range of values is 32–32768.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the DNS cache property that you want to edit.

Examples

wadm set-dns-cache-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=false max-entries=2048 
max-age=240

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-dns-prop(1)

Name

set-dns-prop– edits the DNS properties

Synopsis

set-dns-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name (property-name=value)+

Description

Use this command to edit the Domain Name Server (DNS) properties. The properties that you can edit are as follows:

enabled - Indicates whether the server does the DNS lookups. The default value is false.
async - Indicates whether the server uses its own asynchronous DNS resolver instead of the operating system's synchronous resolver. The default value is true.
timeout - The timeout (in seconds) for asynchronous DNS lookups. The range of values is 0.001–3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the DNS property that you want to edit.

Examples

wadm set-dns-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=true async=true timeout=24

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-error-page(1)

Name

set-error-page– edits the error page

Synopsis

set-error-page <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--uri-pattern|-t pattern] [--is-path|-a false] 
--vs|-s vs-name --config|-c config-name --error-page|-g errorpage

--code|-d errorcode

Description

Use this command to edit the error page.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--is-path|-a: If you specify this option, error page is treated as a file and not as an URI.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.
--error-page|-g: Specify the page that will be displayed when an error occurs. This page can point either to a file or URI.
--code|-d: Enter the error code.

Examples

wadm set-error-page --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs --code=500 
--error-page=/server-error-uri-new

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-external-jndi-resource-prop(1)

Name

set-external-jndi-resource-prop– edits the external JNDI resource property

Synopsis

set-external-jndi-resource-prop <connect_options> --echo|-e]
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--jndi-name|-j name  (propertyname=value)+

Description

Use this command to edit the external Java Naming and Directory Interface (JNDI) resource properties. The properties that you can edit are as follows:

enabled - Indicates whether the JNDI resource is enabled at runtime.
jndi-lookup-name — The JNDI lookup name of the resource.
res-type - The resource type.
factory-class - The class that instantiates resources.
description - The description of the resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the name of the external JNDI resource.

Operands

propertyname=value: Specify the name and value of the external JNDI resource property that you want to edit.

Examples

wadm set-external-jndi-resource-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true--no-prompt --rcfile=null --config=config1 --jndi-name=
external-jndi enabled=true res-type=org.apache.naming.Res
factory-class=samples.jndi.externalRes.MyExternalConnectionFactory
description=JndiExternalResource

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-fastcgi-handler-prop(1)

Name

set-fastcgi-handler-prop– edits the FastCGI handler properties

Synopsis

set-fastcgi-handler-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--mime-type|-m type]
[--uri-pattern|-t pattern] [--role|-o authorizer|responder
|filter|error] --config|-c config-name --vs|-s vs-name 
(propertyname=value)+

Description

Use this command to edit FastCGI handler properties. The properties that you can edit are as follows:

app-path — Indicates the FastCGI application path that processes the request.
bind-path — Indicates the name of the UNIX domain socket on the UNIX platform. On the Windows platform, bind-path must be specified as host:port. The value can also be a named pipe on both UNIX and Windows platforms
app-args — The name-value pairs that are passed as arguments to the FastCGI application process.
app-env — The environment variables of the FastCGI application process.
max-procs — The maximum number of FastCGI application processes that can be created. The default value is 1.
min-procs — The minimum number of FastCGI application processes that can be created. The default value is 1.
listen-queue-size — Indicates the size, in bytes, of the operating system listen queue back log. The default value is 256 bytes.
connection-timeout — Applicable if the reuse-connection option is set to true. Indicates the time-out value, in seconds, for the pooled connections. If a connection is idle for the specified amount period of time, then the connection is closed. The default value is 5 seconds.
reuse-connection — Indicates whether the connections to the FastCGI applications are reused. The value false indicates that the connections to FastCGI applications are closed after each request and true indicates that existing connections are reused for new requests. The default value is false.
response-timeout — Indicate the FastCGI server response time-out in seconds. If there is no response from the FastCGI application within the specified period of time, the request is discarded. The default value is 5 seconds.
request-retry — Indicates the number of times the request should be re-send when the FastCGI application rejects the request. The default value is 0 (zero).
restart-interval — The time interval, in minutes, after which the FastCGI application restarts. If the value for this option is 0 (zero), the FastCGI application is not forced to restart. The default value is 60 minutes.
chroot — (UNIX only). The additional root directory that you create where the FastCGI server application runs in. The default value is the web server's root directory. This property is displayed only if the value of the role option is authorizer, responder, or filter. .
server-user — (UNIX only). Indicates the user ID of a server user, for example, root. The default value is the web server's user ID. This property is displayed only if the value of the role option is authorizer, responder, or filter.
nice — (UNIX only). The nice value of FastCGI server application processes. Typically, the server is run with a nice value of 0 and the nice increment would be between 0 (the FastCGI program runs at same priority as server) and 19 (the FastCGI program runs at much lower priority than server). Do not increase the priority of the FastCGI program above that of the server by specifying a nice increment of -1. This property is displayed only if the value of the role option is authorizer, responder, or filter.
group — (UNIX only). Indicates the name of the group that execute the FastCGI programs. This property is displayed only if the value of the role option is authorizer, responder, or filter.
error-url — The web page, URI, or URL that FastCGI should display if an error occurs. The value of this parameter is an absolute path, a path relative to document root, an URL, or a URI. This property is displayed only if the value of the role option is error.
error-reason — Indicates any FastCGI protocol error. This property is displayed only if the value of the role option is error.

Options

For connect_options description, see help(1).

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

--verbose|-v

Specify this option to display a verbose output.

--mime-type|-m

Specify the MIME type of the FastCGI handler.

--uri-pattern|-t

Specify the URI pattern.

--role|-o

Specify the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.

In the responder role, the FastCGI application receives all information associated with an HTTP request and generates a response.
In the authorizer role, the FastCGI application receives all information associated with an HTTP request and generates an authorized or unauthorized decision.
In the filter role, the FastCGI application receives all information associated with an HTTP request and additional data from a file stored on the web server, and generates a filtered version of the data stream as an HTTP response.
In the error role, the FastCGI application terminates if an error occurs. You can configure the application to display a specific page or redirect the request to a URL if an error occurs.

--config|-c

Specify the name of the configuration for which you want to edit the FastCGI handler property.

--vs|-s

Specify the name of the virtual server.

Operands

propertyname=value: Specify the name and value of the FastCGI property that you want to edit.

Examples

wadm set-fastcgi-handler-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true--no-prompt --rcfile=null --mime-type=magnus-internal/fcgi
--uri-pattern=/fcgi/* --role=filter --config=config1 --vs=vs
--bind-path=localhost:2222 app-path=/new-app-path

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-file-cache-prop(1)

Name

set-file-cache-prop– edits the file cache properties

Synopsis

set-file-cache-prop <connect_options> [--echo|-e][--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (property-name=value)+

Description

Use this command to edit the file cache properties. The properties that you can edit are as follows:

enabled - Indicates whether the server caches the file content and meta information. The default value is true.
max-age - The maximum amount of time (in seconds) to cache the file content and/or meta information. The range of values is 0.001–3600.
max-entries - The maximum number of paths for which the file content and/or meta information should be cached. The range of values is 1–1048576.
max-open-files - The maximum number of file descriptors the file cache will keep open. The range of values is 1–1048576. The default value is default.
sendfile - Indicates whether the server will attempt to use the operating system's sendfile, sendfilev, send_file, or TransmitFile system call. The default value is true on Windows and false on other platforms.
copy-files - Indicates whether the server copies the cached files to a temporary directory. The default value is true on Windows and false on other platforms.
copy-path - The name of the temporary directory that the server uses when copy-files is true.
replacement - The cache entry replacement algorithm. The values can be false,lru, or lfu.
cache-content - Indicates whether the server caches the file content. The default value is true.
max-heap-file-size - The maximum size (in bytes) of files to cache on the heap. The range of values is 0–2147483647.
max-heap-space - The maximum amount (in bytes) of heap to use for caching files. The range of values is between 0– 9223372036854775807.
max-mmap-file-size - The maximum size (in bytes) of files to mmap. The range of values is 0-2147483647.
max-mmap-space - The maximum amount (in bytes) of mmap address space to use for caching files. The range of value is 0– 9223372036854775807.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the file cache property that you want to edit.

Examples

wadm set-file-cache-prop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
max-entries=10240 max-mmap-file-size=10 cache-content=true 
max-age=300 max-open-files=10 copy-files=false enabled=true 
max-heap-file-size=5242880 replacement=false
copy-path=/tmp/file-cache sendfile=false max-mmap-space=10
max-heap-space=104857600

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-home-page(1)

Name

set-home-page– edits the home page

Synopsis

set-home-page <connect_options> [--echo|-e][--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
 home-page-url

Description

Use this command to edit the home page. Home page is a document that exists on the server and acts as a catalog or entry point for the server's contents. The location of this document is defined within the server's configuration files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

home-page-url: Specify the URL of the home page.

Examples

wadm set-home-page --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs /index.html

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-http-listener-prop(1)

Name

set-http-listener-prop– edits the HTTP listener properties

Synopsis

set-http-listener-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--http-listener|-l name  (propertyname=value)+

Description

Use this command to edit the HTTP listener properties. The properties that you can set are as follows:

enabled - Indicates whether the listener is enabled at runtime.
name - The name that uniquely identifies the HTTP listener.
ip - The IP address on which to listen.
port - The port on which to listen.
acceptor-threads - The number of threads dedicated to accept connections received by this listener. The range of values is 1–128. The default value is default.
server-name - The name of the default server. Can include a scheme (for example, http://) as prefix and port (for example, 80) as suffix.
blocking-io - Indicates whether the server uses blocking IO. The default value is false.
family - The name of the protocol family.
listen-queue-size - The maximum size of the operating system listen queue. The range of values is 1 - 65536.
receive-buffer-size - The size (in bytes) of the operating system socket receive buffer. The range of values is 1 - 1048576.
send-buffer-size - The size (in bytes) of the operating system socket send buffer. The range of values is 1 - 1048576.
default-virtual-server-name - The name of the virtual server that processes requests which did not match a host.
description - The description of the HTTP listener.
handle-protocol-mismatch - Indicates whether the server responds to SSL or non-SSL protocol mismatches in client requests. The default is true, meaning the server will attempt to detect SSL or non-SSL protocol mismatches and send an HTTP redirect or SSL alert when a mismatch is detected.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration on which the HTTP listener socket exists.
--http-listener|-l: Specify the name of the HTTP listener.

Operands

propertyname=value: Specify the name and value of the property that you want to edit.

Examples

wadm set-http-listener-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --http-listener=ls1 family=default
send-buffer-size=5000 receive-buffer-size=5000 blocking-io=false
enabled=true acceptor-threads=10 listen-queue-size=512

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-http-prop(1)

Name

set-http-prop– edits the HTTP properties

Synopsis

set-http-prop <connect_options> [--echo|-e][--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname=value)+

Description

Use this command to edit the HTTP properties. The properties that you can edit are as follows:

version - The highest HTTP protocol version that the server supports.
server-header - The server header that contains the name of the server software and version. The default value is Sun Java System Web Server 7.0.
request-header-buffer-size - The size (in bytes) of the buffer that is used to read HTTP request header. The range of values is 0-2147483647.
strict-request-headers - Indicates whether the server rejects certain malformed HTTP request headers. The default value is false.
max-request-headers - The maximum number of header fields that can be allowed in an HTTP request header. The range of values is 1-512.
output-buffer-size - The size (in bytes) of buffer used to read the HTTP responses. The range of values is 0-2147483647.
max-unchunk-size - The maximum size (in bytes) of a chunked HTTP request body the server will unchunk. The range of values is 0-2147483647.
unchunk-timeout - The maximum time (in seconds) that the server will spend waiting for a chunked HTTP request body to arrive. The range of values can be between 0 - 3600 or -1 for no timeout.
io-timeout - The maximum time (in seconds) that the server will wait for an individual packet. The range of values is 0-3600 or -1 for no timeout.
request-header-timeout - The maximum time (in seconds) that the server will wait for the complete HTTP request header. The range of values is 0-604800 or -1 for no timeout.
request-body-timeout - The maximum time (in seconds) that the server will wait for the complete HTTP request body. The range of values is 0-604800 or -1 for no timeout.
favicon - Indicates whether the server replies to requests for favicon.ico with its own built-in icon file. The default value is true.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the HTTP property that you want to edit.

Examples

wadm set-http-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt
--rcfile=null --config=config1 request-header-buffer-size=16384 
max-unchunk-size=16384 max-request-headers=50 io-timeout=120 
favicon=true unchunk-timeout=120 strict-request-headers=false 
request-body-timeout=3600 output-buffer-size=16384 
request-header-timeout=3600 version=HTTP/1.1 
server-header=Sun-Java-System-Web-Server/7.0

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-index-files(1)

Name

set-index-files– edits the index files

Synopsis

set-index-files <connect_options> [--echo|-e][--no-prompt|-Q] 
[--verbose|-v]--config|-c config-name --vs|-s vs-name 
index-file-names

Description

Use this command to edit the index files.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

index-file-names: Specify the name of the index file that you want to edit.

Examples

wadm set-index-files --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs index.xml,home.html,index.jsp

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-jdbc-resource-prop(1)

Name

set-jdbc-resource-prop– edits the JDBC resource properties

Synopsis

set-jdbc-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --jndi-name|-jname 
(propertyname=value)+

Description

Use this command to edit the JDBC resource properties. The properties that you can edit are as follows:

enabled - Indicates whether the JDBC resource is enabled at runtime.
datasource-class - The JDBC driver class.
min-connections - The minimum number of concurrent connections to maintain to the database server.
max-connections - The maximum number of concurrent connections to maintain to the database server.
idle-timeout- The timeout (in seconds) after which an idle connection to the database server will close.
wait-timeout - The timeout (in seconds) after which a caller waiting for an available connection to the database server will receive an error.
isolation-level - The level of transaction isolation.
isolation-level-guaranteed - Indicates whether the server sets the isolation level each time a connection is leased to an application.
connection-validation - Specifies how the server validates a connection before "leasing" it to an application.
connection-validation-table-name - The name of the table if the connection-validation is a database table.
fail-all-connections - Indicates whether all connections are immediately closed and reestablished when there is an error while validating a connection.
description - The description of JDBC resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the JDBC resource.

Operands

propertyname=value: Specify the name and value of the JDBC resource property that you want to edit.

Examples

wadm set-jdbc-resource-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --jndi-name=jdbc enabled=true 
min-connections=1 max-connections=5 idle-timeout=3600 
wait-timeout=3600 isolation-level=serializable 
isolation-level-guaranteed=false 
connection-validation-table-name=false 
connection-validation=false fail-all-connections=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-jvm-profiler-prop(1)

Name

set-jvm-profiler-prop– edits the JVM profiler properties

Synopsis

set-jvm-profiler-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name --profiler|-r name 
(propertyname=value)

Description

Use this command to edit the Java Virtual Machine (JVM) profiler properties. The properties that you can edit are as follows:

enabled - Indicates whether the profiler is enabled at runtime.
class-path - The class path for the profiler.
native-library-path - The native library path for the profiler.
jvm-options - The JVM options for the profiler.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--profiler|-r: Specify the name of the JVM profiler.

Operands

propertyname: Specify the name and value of JVM profiler property that you want to edit.

Examples

wadm set-jvm-profiler-prop --user=admin 
--password-file=../admin.passwd--host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--profiler=JVMprofiler class-path=/tmp/SUN 
native-library-path=/tmp

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-jvm-prop(1)

Name

set-jvm-prop– edits the JVM properties

Synopsis

set-jvm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (propertyname=value)

Description

Use this command to edit the Java Virtual Machine (JVM) properties. The properties that you can edit are as follows:

enabled - Indicates whether the server creates a JVM.
java-home - The location of the JDK. The directory must be owned by the account the server runs as.
class-path-prefix - The prefix for the system class path. You should only prefix the system class path if you wish to override system classes, such as the XML parser classes. Use this attribute with caution.
server-class-path - The class path containing the server classes.
class-path-suffix - The suffix for the system class path.
env-class-path-ignored - Indicates whether the server ignores the CLASSPATH environment variable.
native-library-path-prefix - The prefix for the operating system native library path.
sticky-attach - Indicates whether the server attaches each HTTP request processing thread to the JVM only once instead of attaching and detaching on each request.
debug - Indicates whether the JVM is started in debug mode, ready for attachment with a JPDA (Java Platform Debugger Architecture) debugger.
debug-jvm-options — List of JPDA options.
jvm-options — List of server-wide JVM options.
bytecode-preprocessor-class - The bytecode preprocessor class.
profiler - The name of the JVM profiler.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the JVM property that you want to edit.

Examples

wadm set-jvm-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null--config=config1 sticky-attach=false debug=true 
class-path-suffix=cli.jar

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-keep-alive-prop(1)

Name

set-keep-alive-prop– edits the keep-alive properties

Synopsis

set-keep-alive-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name (property-name=value)*

Description

Use this command to edit the keep-alive properties. The properties that you can edit are as follows:

enabled - Indicates whether the server supports keep-alive connections. The default value is true.
threads - The number of keep-alive subsystem threads. The range of values is 1–128. The default value is default.
max-connections - The maximum number of concurrent keep-alive connections the server will support. The range of values is 1–1048576. The default value is default.
timeout - The timeout (in seconds) after which an inactive keep-alive connection will be closed. The range of values is 0.001–3600.
poll-interval - The interval (in seconds) between polls. The range of values is 0.001–1.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the keep-alive property that you want to edit.

Examples

wadm set-keep-alive-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null--config=config1 enabled=false poll-interval=0.002 
threads=2 timeout=60 max-connections=400

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-lifecycle-module-prop(1)

Name

set-lifecycle-module-prop– edits a lifecycle module

Synopsis

set-lifecycle-module-prop <connect_options> --echo|-e] 
[--no-prompt|-Q] [--verbose|-v]--config|-c config-name 
--module|-m name (propertyname=value)+

Description

Use this command to edit the lifecycle module properties. The properties that you can edit are as follows:

enabled - Indicates whether the lifecycle module is enabled at runtime.
name - The name that uniquely identifies the lifecycle module.
class - The class that implements the lifecycle module.
load-order - The order in which the lifecycle module is loaded. It is recommended that you choose a load-order value that is greater than or equal to 100 to avoid conflicts with the internal lifecycle modules.
is-failure-fatal - Indicates whether the server should treat exceptions thrown during the initialization of lifecycle module as fatal.
class-path - The class path for the lifecycle module.
description - The description of the lifecycle module.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--module|-m: Specify the name of the life cycle module.

Operands

propertyname=value: Specify the name and value of the lifecycle module that you want to edit.

Examples

wadm set-lifecycle-module-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--module=LifecycleProp class-path=/tmp enabled=false 
class=LifecycleClass is-failure-fatal=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-localization-prop(1)

Name

set-localization-prop– edits the localization properties

Synopsis

set-localization-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] 
--config|-c config-name (property-name=value)+

Description

Use this command to edit the localization properties. The properties that you can edit are as follows:

default-language - The default language for messages displayed to administrators and content served to clients.
negotiate-client-language - Indicates whether the server attempts to use the Accept-language HTTP header to negotiate the content language with clients. The default value is false.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the localization property that you want to edit.

Examples

wadm set-localization-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 default-language=de-1901 
negotiate-client-language=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-log-prop(1)

Name

set-log-prop– sets the log properties

Synopsis

set-log-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name (propertyname=value)+

Description

Use this command to edit the log properties. The properties that you can edit are as follows:

log-stdout - Indicates whether the server logs the data that applications write to stdout. The default value is true.
log-stderr - Indicates whether the server logs the data that applications write to stderr. The default value is true.
log-virtual-server-name - Indicates whether the server includes the virtual server name in log messages. The default value is false.
create-console - (Windows only) Indicates whether the server creates a console window. The default value is false.
log-to-console - Indicates whether the server writes the log messages to the console. The default value is true.
log-to-syslog - Indicates whether the server writes log messages to syslog (UNIX) or Event Viewer (Windows). The default value is false.
date-format - The date format for the log message timestamps. The default value is [%d/%b/%Y:%H:%M:%S].
archive-suffix - The suffix to be appended to file name of the rotated log. The default value is m%d05/21/08M.
archive-command - The command to be executed after the server rotates a log file. The value is a program command line, for example, gzip c:\Program Files\Perl\perl.exe" archive.pl.
log-level - The log verbosity for the server. The values can be finest (most verbose), finer, fine, info, warning, failure, config, security, or catastrophe (least verbose).
log-file - The log file for the server. For example, ../logs/errors.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of log property that you want to edit.

Examples

wadm set-log-prop --user=admin --password-file=../admin.passwd
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null
--config=config1 log-virtual-server-name=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-mail-resource-prop(1)

Name

set-mail-resource-prop– edits the mail resource properties

Synopsis

set-mail-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --jndi-name|-j name 
(propertyname=value)+

Description

Use this command to edit the mail resource properties. The properties that you can edit are as follows:

enabled - Indicates whether the resource is enabled at runtime.
description - The description of the mail resource.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--jndi-name|-j: Specify the JNDI name of the mail resource.

Operands

propertyname=value: Specify the name and value of mail resource property that you want to edit.

Examples

wadm set-mail-resource-prop --user=admin 
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--jndi-name=MailReso description=MailReso

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-pkcs11-prop(1)

Name

set-pkcs11-prop– edits the PKCS#11 properties

Synopsis

set-pkcs11-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (propertyname=value)+

Description

Use this command to edit the PKCS#11 properties. The properties that you can edit are as follows:

enabled - Indicates whether the server initializes PKCS #11 tokens, prompting for PINs as necessary. The default value is true if SSL is enabled and false if SSL is not enabled.
crl-path - The path of the directory that contains the dynamically updated CRL files.
token - Configures a PKCS #11 token.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the PKCS#11 property that you want to edit.

Examples

wadm set-pkcs11-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-qos-limits-prop(1)

Name

set-qos-limits-prop– edits the QOS limit properties

Synopsis

set-qos-limits-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--vs|-s vs-name] --config|-c config-name
(property-name=value)

Description

Use this command to edit the Quality of Service (QOS) limit properties. The properties that you can edit are as follows:

enabled - Indicates whether the QOS limits are enforced at runtime. The default value is true.
max-bps - The maximum transfer rate (bytes/second). The range of values is 1–2147483647.
max-connections - The maximum number of concurrent connections. The range of values is 1–1048576.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the QOS limits property that you want to edit.

Examples

wadm set-qos-limits-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=true max-bps=100 
max-connections=100

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-qos-prop(1)

Name

set-qos-prop– edits the QOS properties

Synopsis

set-qos-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name  (propertyname=value)+

Description

Use this command to edit the Quality of Service (QOS) settings. Quality of Service refers to the performance limits you set for a server instance or virtual server. For example, if you are an internet service provider you might want to charge different amounts of money for virtual servers depending on how much bandwidth you allow them. You can limit two areas: the amount of bandwidth and the number of connections. The properties that you can edit are as follows:

enabled - Indicates whether the system tracks QOS information. The default value is true if qos-limits are enabled and false if qos-limits are disabled.
interval - The interval, in seconds, over which QOS information is averaged. The range of values is 0.001 –3600.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the QOS property that you want to edit.

Examples

wadm set-qos-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=true interval=60

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-request-limits-prop(1)

Name

set-request-limits-prop– sets the request limits properties

Synopsis

set-request-limits-prop <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [-vs|-s vs-name ] 
[--uri-pattern|-t pattern] --config|-c config-name 
(propertyname=value)

Description

Use this command to edit the request limits properties. The properties that you can edit are as follows:

timeout — The time limit after which a request will be timed out.
rps-compute-interval - The time interval (in seconds) in which the average (request per second) RPS is computed.
continue-condition — The condition that must be met for a blocked request type to be available again for servicing. The values can be silence or threshold.
max-rps - The threshold value for RPS. If this value is exceeded, subsequent connections will not serviced. There is no default value because an acceptable RPS threshold can vary widely between sites.
monitor-attribute - The optional request attribute that has to be monitored.
error-code - The HTTP status code to use for blocked requests. The default is 503, "Service Unavailable".
max-connections - The maximum number of concurrent connections.

Note –

If you specify the --config option, this command will enable you to edit only the timeout property. If you specify both the --config and --vs options, you can edit the rps-compute-interval, max-rps, enabled, continue-condition, error-code, and monitor-attribute properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--vs|-s: Specify the name of the virtual server.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the request limits property that you want to edit.

Examples

wadm set-request-limits-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs 
--uri-pattern=/foo* max-connections=100 rps-compute-interval=10 
continue-condition=silence error-code=500

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-reverse-proxy-prop(1)

Name

set-reverse-proxy-prop– sets the reverse proxy properties

Synopsis

set-reverse-proxy-prop <connect_options> [--echo|-e] --no-prompt|-Q]
[--verbose|-v] --config|-c config-name --vs|-s vs-name  
--uri-prefix|-r uri-prefix (propertyname=value)+

Description

Use this command to set the reverse proxy properties. The properties that you can edit are as follows:

sticky-cookie - The name of a cookie that, when present in a response, will cause subsequent requests to stick to that origin server.
sticky-param - The name of a URI parameter to inspect for route information. If a URI parameter is present in a request URI and its value contains a colon (:) followed by a route ID, the request will stick to the origin server identified by that route ID.
route-header - The name of the HTTP request header used to communicate the route IDs to origin servers.
route-cookie - The name of the cookie generated by the server when it encounters a sticky-cookie cookie in a response. The route-cookie cookie stores a route ID that enables the server to direct subsequent requests back to the same origin server.
rewrite-headers - A list of HTTP request headers. The value can be host, location, or content-location where,
- host: Indicates whether the host HTTP request header is rewritten to match the host specified by the server parameter. The default is false, which means that the host header is not rewritten.
- location: Indicates whether the location HTTP response headers that match the server parameter should be rewritten. The default is true,which means that the matching location headers are rewritten.
- content-location: Indicates whether the content-location HTTP response headers that match the server parameter should be rewritten. The default is true, which means that the content-location headers are rewritten.
auth-user — The user to authenticate as.
auth-password — The password that is needed for authentication.
auth-header — The name of the HTTP request header that is used to communicate the credentials. The default value is Authorization. When authenticating to a proxy server, you can specify the value as Proxy-authorization.
client-cert-nickname — The nickname of the client certificate to present to the remote server. The default is not to present a client certificate.
validate-server-cert — Indicates whether the proxy server validates the certificate presented by the remote server. The default value is true, indicating that the proxy server will accept any certificate.
use-keep-alive — Indicates whether the HTTP client should attempt to use persistent connections. The default value is true.
keep-alive-timeout — The maximum number of seconds to keep a persistent connection open. The default value is 29.
always-use-keep-alive — Indicates whether the HTTP client can reuse the existing persistent connections for all types of requests. The default value is false, indicating that persistent connections will not be reused for non-GET requests or for requests with a body.
protocol — The HTTP protocol version string. By default, the HTTP client uses either HTTP/1.0 or HTTP/1.1 based on the contents of the HTTP request. In general, you should not use the protocol parameter unless you encounter specific protocol interoperability problems.
proxy-agent — The value of the Proxy-agent HTTP request header. The default is a string that contains the proxy server product name and version.
timeout — The maximum number of seconds a connection can be idle. The default value is 300.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-prefix|-r: Specify the URI prefix of the reverse proxy.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname=value: Specify the name and value of the reverse proxy property that you want to edit.

Examples

wadm set-reverse-proxy-prop --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --vs=vs 
--uri-prefix=/simple/ auth-header=Authorization 
always-use-keep-alive=true sticky-cookie=JSESSIONID 
validate-server-cert=false use-keep-alive=true 
route-header=Proxy-jroute rewrite-headers=loconfig1ion,
content-loconfig1ion sticky-param=jsessionid 
route-cookie=JROUTE server=http://sun.com:8080 
keep-alive-timeout=30

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-search-collection-prop(1)

Name

set-search-collection-prop– sets the search collection properties

Synopsis

set-search-collection-prop <connect_options> [--echo|-e]
--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--vs|-s vs-name --collection-name|-O name 
(propertyname=value)+

Description

Use this command to edit the search collection properties. The properties that you can edit are as follows:

enabled — Indicates whether the collection can be searched at runtime. The default value is true.
name — The name that uniquely identifies the search collection.
display-name — The description of the search collection that is displayed to end users.
uri — The root URI for the searchable documents.
document-root — The file system root for the searchable documents.
path — The path of the file system that stores the search collection metadata.
index-meta-tag — The document fields that are used for indexing.
include-extension — The types of document that is included. The values can be html, htm, txt, and pdf.
description — The description of the search collection.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.
--collection-name|-O: Specify the name of the search collection.

Operands

propertyname=value: Specify the name and value of the search collection property that you want to edit.

Examples

wadm set-search-collection-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs
--collection=searchcoll enabled=false include-extension=pdf
index-meta-tag=author

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-search-prop(1)

Name

set-search-prop– sets the search properties

Synopsis

set-search-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --vs|-s vs-name --config|-c config-name 
(propertyname=value)+

Description

Use this command to edit the search properties. The properties that you can edit are as follows:

enabled — Indicates whether the search application is enabled at runtime. The default value is true.
max-hits — The maximum number of search results to return in response to a single search query. The range of values is 0 - 10000.
uri — The root URI for the search web application.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname=value: Specify the name and value of the search properties that you want to edit.

Examples

wadm set-search-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs enabled=false max-hits=1200

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-servlet-container-prop(1)

Name

set-servlet-container-prop– edits the servlet container properties

Synopsis

set-servlet-container-prop <connect_options> [--echo|-e]
--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
(property-name=value)+

Description

Use this command to edit the Servlet container properties. The properties that you can edit are as follows:

dynamic-reload-interval - The interval when the server checks the deployed web applications for modifications. The range of values is 1–60, or –1 if dynamic reloading should be disabled. The default value is –1.
log-level - The log verbosity for the Servlet container. The values can be finest (most verbose), finer, fine, info, warning, failure, config, security, or catastrophe (least verbose).
anonymous-role - The name of the default or anonymous, role assigned to all principals. The default role is ANYONE.
single-threaded-servlet-pool-size - The number of Servlet instances to instantiate per SingleThreadedServlet. The range of values is 1–4096.
cross-context-allowed - Indicates whether the request dispatchers are allowed to dispatch to another context. The default value is true.
reuse-session-id - Indicates whether any existing session ID number is reused when creating a new session for that client. The default value is false.
encode-cookies - Indicates whether the Servlet container encodes the cookie values. The default value is true.
dispatcher-max-depth – The maximum depth for the Servlet container allowing nested request dispatches. The range of values is 0–2147483647. The default value is 20.
secure-session-cookie — Controls the conditions under which the JSESSIONID cookie is marked secure. The values can be as follows:
- dynamic — marks the cookie secure only when the request is received on a secure connection.
- true — always marks the cookie secure.
- false — never marks the cookie secure.
The default value is dynamic.

Options

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

property-name=value: Specify the name and value of the Servlet container property that you want to edit.

Examples

wadm set-servlet-container-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
cross-context-allowed=false dispatcher-max-depth=15 
dynamic-reload-interval=5 encode-cookies=false log-level=finer
reuse-session-id=true secure-session-cookie=false
single-threaded-servlet-pool-size=2

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-session-replication-prop(1)

Name

set-session-replication-prop– edits the session replication properties

Synopsis

set-session-replication-prop <connect_options> --echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--node|-n node-name ] 
--config|-c config-name  (propertyname=value)+

Description

Use this command to edit the session replication properties. The properties that you can edit are as follows:

key - The secret key that members of the cluster use to authenticate each other. Only applicable at the cluster level.
encrypted - Indicates whether the session data is encrypted prior to replication. The default value is false. Only applicable at the cluster level.
protocol - The protocol used for session replication. The values can be http or jrmp. Only applicable at the cluster level.
async - Indicates whether session replication is allowed to occur asynchronously from HTTP request/response processing. The default value is true. Only applicable at the cluster level.
getAttribute-triggers-replication - Indicates whether a call to the HttpSession.getAttribute method should cause a session to be backed up. The default value is true. Only applicable at the cluster level.
replica-discovery-max-hops - The maximum number of instances that should be contacted while attempting to find the backup of a session. The range of values is 1–2147483647, or -1 for no limit. Only applicable at the cluster level.
startup-discovery-timeout - The maximum time (in seconds) that an instance will spend trying to contact its designated backup instance. The range of values is 0.001–3600. Only applicable at the cluster level.
cookie-name - The name of the cookie that tracks which instance owns a session. Only applicable at the cluster level.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--node|-n: Specify the name of the node.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the session replication property that you want to edit.

Examples

wadm set-session-replication-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 enabled=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-soap-auth-provider-prop(1)

Name

set-soap-auth-provider-prop– edits the SOAP authentication provider properties

Synopsis

set-soap-auth-provider-prop <connect_options> --echo|-e]
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
--provider|-o name (propertyname=value)+

Description

Use this command to edit the SOAP (Simple Object Access Protocol) authentication provider properties. The properties that you can edit are as follows:

name — The name that uniquely identifies the SOAP message-level authentication provider for use in default-soap-auth-provider-name and sun-web.xml.
class — The class that implements the provider realm (com.sun.enterprise.security.jauth.ServerAuthModule).
request-policy — Configures the authentication policy requirements for requests.
response-policy — Configures the authentication policy requirements for responses.
property — Configures the optional provider-specific properties.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--provider|-o: Specify the name of the SOAP authentication provider.

Operands

propertyname=value: Specify the name and value of the SOAP authentication property that you want to edit.

Examples

wadm set-soap-auth-provider-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
--provider=soap-auth request-policy-auth-source=sender
request-policy-auth-recipient=after-content
response-policy-auth-source=sender
response-policy-auth-recipient=after-content

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-ssl-prop(1)

Name

set-ssl-prop– edits the SSL properties

Synopsis

set-ssl-prop <connect_options> [--echo|-e]
--no-prompt|-Q] [--verbose|-v] --config|-c config-name
--http-listener|-l name (propertyname=value)+

Description

Use this command to edit the SSL properties. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP. The properties that you can edit are as follows:

enabled — Indicates whether SSL/TLS is enabled at runtime. The default value is true.
server-cert-nickname — The nickname of a server certificate.
ssl2 — Indicates whether SSL2 connections are accepted. The default value is false.
ssl3 — Indicates whether SSL3 connections are accepted. The default value is true.
tls — Indicates whether TLS connections are accepted. The default value is true.
tls-rollback-detection — Indicates whether the server detects and blocks TLS version rollback attacks. The default value is true.
client-auth — The client certificate authentication method. The value can be required, optional, or false.
client-auth-timeout — The timeout (in seconds) after which client authentication handshake fails. The range of values is 0.001 - 3600.
max-client-auth-data — The maximum amount of application-level data to buffer during a client authentication handshake. The range of values is 0 - 2147483647.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
--http-listener|-l: Specify the name of the HTTP listener.

Operands

propertyname=value: Specify the name and value of the SSL property that you want to edit.

Examples

wadm set-ssl-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --http-listener=config1_ls tls=true
server-cert-nickname=Server-Cert client-auth-timeout=65
client-auth=false enabled=true ssl2=false 
max-client-auth-data=1048575 tls-rollback-detection=true 
ssl3=true

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-ssl-session-cache-prop(1)

Name

set-ssl-session-cache-prop– edits the SSL session cache properties

Synopsis

set-ssl-session-cache-prop <connect_options> --echo|-e] 
[--no-prompt|-Q] [--verbose|-v] --config|-c config-name 
(propertyname=value)+

Description

Use this command to edit the SSL session cache properties. The properties that you can edit are as follows:

enabled - Indicates whether the server caches SSL/TLS sessions. The default value is true.
max-entries - The maximum number of SSL/TLS sessions the server will cache. The range of values is 1–524288.
max-ssl2-session-age - The maximum amount of time to cache an SSL2 session. The range of values is 5–100.
max-ssl3-tls-session-age - The maximum amount of time to cache an SSL3/TLS session. The range of values is 5–86400.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the SSL session cache property that want edit.

Examples

wadm set-ssl-session-cache-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null --config=config1 
enabled=false max-entries=20000 max-ssl2-session-age=5 
max-ssl3-tls-session-age=5

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-stats-prop(1)

Name

set-stats-prop– edits the statistics properties

Synopsis

set-stats-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name (propertyname=value)+

Description

Use this command to edit properties of the statistics collection subsystem. The properties that you can edit are as follows:

enabled - Indicates whether the server collects statistics at runtime. The default value is true.
interval - The interval (in seconds) at which statistics are updated. The range of values is 0.001 - 3600.
profiling - Indicates whether the performance buckets that are used to track NSAPI function execution time are enabled. The default value is true.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of statistics property that you want to edit.

Examples

wadm set-stats-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=true profiling=true 
interval=10

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-symlinks-prop(1)

Name

set-symlinks-prop– edits the symbolic link properties

Synopsis

set-symlinks-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] [--uri-pattern|-t pattern] --vs|-s vs-name
 --config|-c config-name (propertyname=value)+

Description

Use this command to edit the symbolic link properties. A symbolic link consists of two files, an original file that contains the data, and another that points to the original file. Symbolic links can be used across different file systems and can be linked to directories. The properties that can you can edit are as follows:

allow-soft-links — allows soft file system links. The values can be:
- true - always allow soft file system links
- false - never allow soft file system links
- on-owner-match- only allow when owners match
allow-hard-links — allows hard file system links. The values can be:
- true - always allow hard file system links
- false - never allow hard file system links
directory — Name of the directory from which links will be searched.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--uri-pattern|-t: Specify the URI wildcard pattern.
--config|-c: Specify the name of the configuration.
--vs|-s: Specify the name of the virtual server.

Operands

propertyname=value: Specify the name and value of the symbolic link property.

Examples

wadm set-symlinks-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 --vs=vs allow-soft-links=false 
allow-hard-links=false directory=../

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-thread-pool-prop(1)

Name

set-thread-pool-prop– edits the thread pool properties

Synopsis

set-thread-pool-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name  (propertyname=value)+

Description

Use this command to edit the thread pool properties. The properties that you can edit are as follows:

enabled - Indicates whether the thread pool is enabled at runtime.
min-threads - The minimum number of HTTP request processing threads. The range of values is 1–4096. The default value is default.
max-threads - The maximum number of HTTP request processing threads. The range of values is 1–4096. The default value is default.
stack-size - The stack size (in bytes) for HTTP request processing threads. The range of values is 8192–67108864.
queue-size - The maximum number of concurrent HTTP connections that can be queued waiting for processing. The range of values is 1–1048576. The default value is default.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the thread pool property that you want to edit.

Examples

wadm set-thread-pool-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 enabled=false queue-size=2048 
min-threads=32 stack-size=100000 max-threads=256

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-token-pin(1)

Name

set-token-pin– sets the PKCS #11 token pin

Synopsis

set-token-pin <connect_options> [--echo|-e]
[--no-prompt|-Q] [--verbose|-v] [--token-pin|-P name]
[--new-token-pin|-o name] [--save-pin|-a (true|false)] 
--token|-t name --config|-c config-name

Description

Use this command to set or reset the SSL token pin for the server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--new-token-pin|-o: Specify a new token pin when changing the token password. You can also define the new-token-pin in the password file.
--save-pin|-a: If you specify this option, token element is added in configuration's server.xml file with the given pin (password).
--token|-t: Specify the name of the PKCS #11 token.
--config|-c: Specify the name of the configuration.

Examples

wadm set-token-pin --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 --token=internal

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-token-prop(1)

Name

set-token-prop– sets the PKCS #11 token properties

Synopsis

set-token-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] [--set-password|-r] [--token-pin|-P name] 
--config|-c config-name --token|-t name (propertyname=value)*

Description

Use this command to enable or disable the SSL tokens for the server. You can also use this command to save the token-pin in the server.xml file, which will facilitate unsupervised server startup. The property that you can edit is as follows:

enabled - Indicates whether the SSL token is enabled at runtime.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--set-password|-r: If you specify this option, you are prompted for the SSL token pin that can be set or reset and saved in the server.xml file.
--token-pin|-P: Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
--config|-c: Specify the name of the configuration.
--token|-t: Specify the name of the PKCS #11 token that contains the certificates.

Operands

propertyname=value: Specify the name and value of the PKCS#11 token property that you want to edit.

Examples

wadm set-token-prop --user=admin --password-file=../admin.pwd 
--host=serverhost --port=8989 --config=config1 --token=internal

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-user-prop(1)

Name

set-user-prop– edits user information

Synopsis

set-user-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v][--vs|-s vs-name] [--org-unit|-o org-unit] 
[--realm|-L realm] [--set-password|-r] [--user-password|-W] 
--config|-c config-name --authdb|-a name 
--uid|-U userid (propertyname=value)

Description

Use this command to edit the user information. The properties that you can edit are surname, full name, email ID, phone number, realm, org-unit, and user title.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--realm|-L: Specify the realm that authenticates the user.
--vs|-s: Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
--org-unit|-o: Enter a description of an organizational unit within your company to which this user belongs.
--set-password|-r: Specify this option to change the administration server user password.
--user-password|-W: Specify the user password. You can also define the user-password in the password file.
--config|-c: Specify the name of the configuration.
--authdb|-a: Specify the authentication database that stores the user information.
--uid|-U: Specify the ID of the user whose property information you want to edit.

Operands

propertyname=value: Specify the user property that you want edit.

Examples

wadm set-user-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null --config=config1 --realm=rlm1 
--authdb=DIGESTFILE1--uid=digest-config1-u1 groups=group1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-virtual-server-prop(1)

Name

set-virtual-server-prop– edits the virtual server properties

Synopsis

set-virtual-server-prop <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] --config|-c config-name --vs|-s vs-name 
(propertyname=value)+

Description

Use this command to edit the virtual server properties. The properties that you can edit are as follows:

object-file - The obj.conf file that controls the request handling process for the virtual server.
canonical-server-name - The canonical host name of the virtual server. Requests using a different host name will be redirected to this host name.
enabled - Indicates whether the virtual server is enabled at runtime.
host - The hostname the virtual server services.
default-object-name - The name of the root obj.conf object.
name - The name that uniquely identifies the virtual server.
document-root - The document root for the virtual server.
mime-file - The mime.types file that configures MIME mappings for the virtual server.
log-file - The log file for the virtual server.
http-listener-name - The name of an HTTP listener associated with one or more of the virtual server's hostnames.
acl-file - The Access Control List (ACL) file that controls access to the virtual server.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.
---vs|-s: Specify the name of the virtual server.

Operands

propertyname=value: Specify the name and value of the property that you want to edit.

Examples

wadm set-virtual-server-prop --user=admin
--password-file=../admin.passwd --host=serverhost --port=8989 
--ssl=true --no-prompt --rcfile=null  --config=config1 --vs=vs 
enabled=true host=serverhost default-object-name=default 
document-root=../docs http-listener-name=config1_ls

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

set-webdav-prop(1)

Name

set-webdav-prop– edits the WebDAV properties

Synopsis

set-webdav-prop <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name (propertyname=value)+

Description

Use this command to edit the WebDAV properties. You can edit the following properties:

enabled - Indicates whether WebDAV is enabled for the collection at runtime. The default value is true.
default-owner - The default owner for the resources.
min-lock-timeout - The minimum expiration time (in seconds) for WebDAV locks. The range of values is 0.001 - 3600, or 0 to not enforce a minimum expiration time.
max-xml-request-body-size - The maximum size (in bytes) allowed for WebDAV XML request bodies. The range of values is 0 - 2147483647, or -1 for no limit.
max-propfind-depth - The maximum depth of PROPFIND requests sent to collections. The values are 0, 1, or infinity.
max-expand-property-depth - The maximum depth allowed for WebDAV expand-property REPORT responses. The range of values is 0 - 100.
max-report-response-elements - The upper limit of the number of response elements a REPORT response body can have. The range of values is 0 - 2147483647, default 1000.
auth-auth-db-name - The ACL authentication database to use. The default value is default.
auth-method - The authentication method to use. The values can be basic, digest, or ssl. The default value is basic.
auth-prompt - The prompt to display to the client requests for authentication. The default value is Sun Java System Web Server WebDAV.
acl-db-max-size - The maximum size (in bytes) of memory representation of the WebDAV ACL database for a collection. If this memory limit is exceeded, the server will not cache WebDAV ACL lists. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-max-entries - The maximum number of ACEs to allow on a single resource. The range of values is 0 - 2147483647, or -1 for no limit.
acl-db-update-interval - The interval (in seconds) at which WebDAV ACL databases are synced to disk. The value range is 0.001 - 3600, or 0 to disable caching of WebDAV ACL lists.
property-db-max-size - The maximum size (in bytes) of WebDAV property database files. The range of values is 0 - 2147483647, or -1 for no limit.
property-db-update-interval - The interval (in seconds) at which WebDAV property databases are synced to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV properties.
lock-db-path - The filename of the WebDAV lock database is stored. The path can be the absolute path or path relative to the server's config directory.
lock-db-update-interval - The interval (in seconds) at which WebDAV lock databases are synced to disk. The range of values is 0.001 - 3600, or 0 to disable caching of WebDAV lock information.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration.

Operands

propertyname=value: Specify the name and value of the WebDAV property that you want to edit.

Examples

wadm set-webdav-prop --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null --config=config1 acl-db-max-entries=12 
property-db-update-interval=1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

start-instance(1)

Name

start-instance– starts an instance

Synopsis

start-instance <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] --config|-c config-name (nodehost)*

Description

Use this command to start instance(s) running on the specified configuration and on the specified nodes. If you do not specify any nodes, all instances running on the specified configuration are started. If you run this command when instance(s) is already running, an error is displayed.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration that the instance points to.

Operands

nodehost: Specify the name of the node.

Examples

wadm start-instance --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

start-snmp-master-agent(1)

Name

start-snmp-master-agent– starts the SNMP master agent

Synopsis

start-snmp-master-agent <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v] [--snmp-port|-m
 snmp-master-agent-port] (nodehost)

Description

Use this command to start the SNMP master agent. In general, to use SNMP you must have a master agent and at least one subagent installed and running on your system. You need to install the master agent before you can enable a subagent.

Note –

You cannot start the SNMP master agent through the administration interfaces when the Administration server is installed as a non-root user. To allow a non-root Administration server user to start master agent through administration interfaces, the non-root user must be given the privileges to bind to the privileged ports using RBAC, which the SNMP master agent runs on. The default SMUX port is 199 and default SNMP port is 161.

Another workaround is to manually start the master agent as root using the following command:

magt CONFIG INIT

The magt command is located under server-root/lib/snmp/magt/.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--snmp-port|-m: Specify the port number of the SNMP master agent.

Operands

nodehost: Specify the name of the node.

Examples

wadm start-snmp-master-agent --user=admin --host=serverhost
--password-file=../admin.passwd  --port=8989 --ssl=true --no-prompt 
--rcfile=null --snmp-port=161 node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

start-snmp-subagent(1)

Name

start-snmp-subagent– starts the SNMP subagent

Synopsis

start-snmp-subagent <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] (nodehost)+

Description

Use this command to start the SNMP subagent. The subagent gathers information about the server and passes the information to the server's master agent. Before starting the SNMP subagent, verify that the master agent is installed and running.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

nodehost: Specify the name of the node.

Examples

wadm start-snmp-subagent --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true --no-prompt 
--rcfile=null node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

stop-admin(1)

Name

stop-admin– stops the administration server or node

Synopsis

stop-admin <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v] nodehost

Description

Use this command to stop the administration server or node. To restart the administration server, you can use the restart-admin command.

Options

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

nodehost: Specify the name of the node.

Examples

wadm stop-admin --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null 
serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

stop-instance(1)

Name

stop-instance– stops instances

Synopsis

stop-instance <connect_options> [--echo|-e] [--no-prompt|-Q] 
[--verbose|-v]--config|-c config-name (nodehost)*

Description

Use this command to stop the instance running on the specified configuration and on the specified nodes. If you do not specify any nodes, all instances running on the specified configuration are stopped. If an instance on any node is not running, this command will result in an error.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.
--config|-c: Specify the name of the configuration that the instance points to.

Operands

nodehost: Specify the name of the node.

Examples

wadm stop-instance --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null  
--config=config1 serverhost

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

stop-snmp-master-agent(1)

Name

stop-snmp-master-agent– stops the SNMP master agent

Synopsis

stop-snmp-master-agent <connect_options> [--echo|-e] 
[--no-prompt|-Q] [--verbose|-v]  (nodehost)+

Description

Use this command to stop the SNMP master agent.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

nodehost: Specify the name of the node.

Examples

wadm stop-snmp-master-agent --user=admin --password-file=../admin.passwd 
--host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

stop-snmp-subagent(1)

Name

stop-snmp-subagent– stops the SNMP subagent

Synopsis

stop-snmp-subagent <connect_options> [--echo|-e] [--no-prompt|-Q]
[--verbose|-v] (nodehost)*

Description

Use this command to stop the SNMP subagent.

Options

For connect_options description, see help(1).

--echo|-e: Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
--no-prompt|-Q: If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
--verbose|-v: Specify this option to display a verbose output.

Operands

nodehost: Specify the name of the node.

Examples

wadm stop-snmp-subagent --user=admin --host=serverhost
--password-file=../admin.passwd --port=8989 --ssl=true 
--no-prompt --rcfile=null node1

Exit Status

The following exit values are returned:

0: command executed successfully
>0: error in executing the command

User Commands

add-documents(1)

Name

Synopsis

Description

Options

Examples

Exit Status

See Also

add-webapp(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

block-reverse-proxy-header(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

copy-config(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

copy-virtual-server(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

create-authdb(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

create-authdb-userprop(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

create-auth-realm(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status

See Also

create-auth-realm-userprop(1)

Name

Synopsis

Description

Options

Operands

Examples

Exit Status