Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
If you specify this option, sub directories of the document root will not be searched.
Specify the wild card pattern of the documents that have to be added.
Specify the name of the configuration for which you want to add the search documents.
Specify the name of the virtual server.
Specify the name of the collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), remove-documents(1), create-search-collection(1), set-search-collection-prop(1), delete-search-collection(1), list-search-collections(1), get-search-collection-prop(1), reindex-search-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the new web application.
If you specify this option, JSPs will be precompiled into classes during deployment. This improves performance.
If you specify this option, path to the WAR (Web Application Archive) file must be the absolute path on the administration server.
Specify this option to disable the web application at runtime.
Specify the name of the target directory for deploying the web application.
For large web applications, using a target directory outside Web Server's installation directory improves Admin Server's performance. The --directory option is used for this purpose.
Specify the name of the configuration for which you want to add the web application.
Specify the name of the virtual server where you want to deploy the web application.
Specify the URI for your web application. This will be the application context root and is relative to the server host.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix of the reverse proxy.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
copy-config <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name copy-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration that needs to be copied.
wadm copy-config --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 copyconfig1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to create a copy of an existing virtual server.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the source virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-virtual-server(1), set-virtual-server-prop(1), delete-virtual-server(1), get-virtual-server-prop(1), list-virtual-servers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
If you specify this option, the authentication database is disabled at runtime.
Specify the name of the configuration for which you want to create the authentication database.
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.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), set-authdb-prop(1), get-authdb-prop(1), delete-authdb(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create the authentication database user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the authentication database user property.
If you set this option to true, the property value is encoded and stored in the configuration files.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which you want to create the authentication database properties.
Specify the name of the authentication database.
Specify the name and value of the database user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), list-authdbs(1), delete-authdb(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of a built-in authentication realm type. The type can be file, ldap, pam, native or certificate.
Specify the class for custom realm.
The type and class options are mutually exclusive.
Specify the name of the configuration for which you want to create the authentication realm.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-auth-realm-prop(1), delete-auth-realm(1), get-auth-realm-prop(1), list-auth-realms(1), create-auth-realm-userprop(1), delete-auth-realm-userprop(1), list-auth-realm-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create the authentication realm user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the authentication realm user property.
Specify the name of the configuration for which you want to create the authentication realm user property.
Specify the name of the authentication realm.
Specify the name and value of the authentication realm user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-auth-realm-userprop(1), list-auth-realm-userprops(1), create-auth-realm(1), delete-auth-realm(1), get-auth-realm-prop(1), set-auth-realm-prop(1), list-auth-realms(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
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.
Specify the name of the curve. This option is applicable if you choose the key-type as ecc.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the name of your organization, company, or educational institution.
Enter a description of an organizational unit within your company.
Enter a description of the city, principality, or country of the organization.
Specify the state or province where your organization is located.
Specify a two-character abbreviation of your country's name (in ISO format). For example, the country code for the United States is US.
Specify the name of the configuration for which you want create the certificate.
Specify the token (cryptographic device) name, which contains the encrypted public key.
Specify the host name of the server for which you are requesting a certificate from the Certificate Authority (CA).
(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.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option if the CGI directory will have shell CGI programs.
Specify the URI prefix to use for the CGI directory. This prefix appears as the directory for the CGI programs in the URL.
Specify the path of the directory that contains the CGI programs.
Specify the name of the configuration for which you want to create the CGI directory.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-cgi-envvar <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --description|-D text --config|-c config-name (varname=value)+
Use this command to create a common gateway interface (CGI) environment variable.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the new CGI environment variable.
Specify the name of the configuration for which you want to create the CGI environment variables.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-cgi-envvar(1), list-cgi-envvars(1), create-cgi-dir(1), set-cgi-prop(1), delete-cgi-dir(1), list-cgi-dirs(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the path where all content such as HTML pages, images, and web applications are available. The default value is ../docs.
Specify the path of the Java Development Kit (JDK) home.
Specify the IP for the default listener.
Specify the platform type that you want to install. The value can be 32 or 64. The default value is 32.
Specify the user ID of a server user. For example, root. This option is mandatory if the administration server is on UNIX.
Specify the port for the default listener.
Specify the host name of the server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to disable the custom resource at runtime.
Specify the type of custom resource you want create.
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.
Specify the name of the configuration for which you want to create a custom resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), delete-custom-resource-userprop(1), list-custom-resource-userprops(1), set-custom-resource-prop(1), delete-custom-resource(1), list-custom-resources(1), get-custom-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create custom resource user properties. A custom resource accesses a local Java Naming and Directory Interface (JNDI) repository.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the custom resource user property.
Specify the name of the configuration for which you want to create the custom resource user property.
Specify the JNDI name of the custom resource.
Specify the name and value of the custom resource user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource(1), set-custom-resource-prop(1), delete-custom-resource(1), list-custom-resources(1), get-custom-resource-prop(1), delete-custom-resource-userprop(1), list-custom-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI that DAV clients can use to access the source code of the content.
If you specify this option, this DAV collection is disabled at runtime.
Specify the name of the provider that manages this collection.
Specify the directory where the DAV lock database is stored.
Specify the interval (in seconds) at which the DAV lock information is written to the disk.
Specify the minimum expiration time (in seconds) for DAV locks.
Specify the interval (in seconds) at which the WebDAV file properties are written to the disk.
Specify the maximum size (in bytes) of the WebDAV file property database files.
Specify the maximum size (in bytes) allowed for WebDAV XML request bodies.
Specify the maximum depth of the PROPFIND requests sent to collections.
Specify the maximum size (in bytes) allowed for the WebDAV report response.
Specify the maximum depth allowed for WebDAV expand property report responses.
Specify the name of the authentication database.
Specify an authentication prompt.
Specify an authentication method. The method can be basic, digest, or ssl.
Specify the maximum entries that can exist in the access control list (ACL) database.
Specify the interval (in seconds) at which the Access Control List (ACL) database will be updated.
Specify the maximum size of the Access Control List (ACL) database.
Specify the name of the configuration for which you want to create a DAV collection.
Specify the name of the virtual server.
Specify the URI through which the content is accessed.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), get-dav-collection-prop(1), list-dav-collections(1), set-dav-collection-prop(1), delete-dav-collection(1), enable-dav-collection(1), disable-dav-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI prefix that has to be mapped to a directory.
Specify the path to the directory that will store the documents.
Specify the name of the virtual server.
Specify the name of the configuration for which you want to create the document directory.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to disable the event at runtime.
Specify the time you want this event start. The format of the time is hh:mm, for example, 12:30.
Specify the month you want this event to occur. The range of values is 1–12.
Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the day of the month you want this event to occur. The range of values is 1–31.
Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.
Specify the name of the configuration for which you want to create the event.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to disable the external JNDI resource at runtime.
Enter a description of the external JNDI resource.
Specify the external JNDI lookup name.
Specify the type of the external JNDI resource.
Specify the name of the user-written factory class that implements javax.naming.spi.InitialContextFactory.
Specify the name of the configuration for which you want to create an external JNDI resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource-userprop(1), delete-external-jndi-resource-userprop(1), list-external-jndi-resource-userprops(1), set-external-jndi-resource-prop(1), delete-external-jndi-resource(1), get-external-jndi-resource-prop(1), list-external-jndi-resources(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create an external Java Naming and Directory Interface (JNDI) resource user property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the external JNDI resource user property.
Specify the name of the configuration for which you want to create the external JNDI resource user property.
Specify the name of the external JNDI resource.
Specify the name and value of the external JNDI resource user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-external-jndi-resource-userprop(1), list-external-jndi-resource-userprops(1), create-external-jndi-resource(1), set-external-jndi-resource-prop(1), delete-external-jndi-resource(1), get-external-jndi-resource-prop(1), list-external-jndi-resources(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the MIME type.
Specify the URI pattern.
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.
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.
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....
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.
Specify the minimum number of FastCGI application processes that can be created. The default value is 1.
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.
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.
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.
Specify the name of the group to execute the FastCGI programs.
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.
Specify the size, in bytes, of the operating system listen queue back log. The default value is 256 bytes.
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"....
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.
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.
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.
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.
Specify the number of times the request should be re-send when the FastCGI application rejects the request. The default value is 0 (zero).
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.
Specify the FastCGI protocol error. Use this option to differentiate the error URLs to be displayed in case of any plug-in errors.
Specify the name of the configuration for which you want to create the FastCGI handler.
Specify the name of the virtual server where you want to add the FastCGI handler.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-fastcgi-handler(1), get-fastcgi-handler-prop(1), set-fastcgi-handler-prop(1), list-fastcgi-handlers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify this option to disable the authentication database at runtime.
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.
Specify the location of the authentication database file.
Specify the name of the configuration for which you want to create the authentication database.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-ldap-authdb(1), create-pam-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), delete-authdb(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter the ID of the user.
Enter a description for the group.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Enter a description of an organizational unit within your company to which this group belongs.
Specify the name of the configuration for which you want to create the user group.
Specify the name of the authentication database that will store the group information.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create a new group member.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of an organizational unit within your company to which this group member belongs.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the authentication database that stores the group information.
Specify the ID of the group.
Specify the name of the configuration for which you want create group member.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option if you want to disable the HTTP listener at runtime.
Specify the IP address of the host machine. Type `*' to set all available IP addresses.
Specify the number of threads dedicated to accept the connections received by this listener. The range of values is 1–128.
If you specify this option, the HTTP listener socket is in the blocking mode.
Specify the HTTP protocol family. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6.
Specify the size (in bytes) of the operating system listen queue back log. The range of values is 1 - 65536.
Specify the size (in bytes) of the operating system socket receive buffer. The range of values is 1 - 1048576.
Specify the size (in bytes) of the operating system socket send buffer. The range of values is 1 - 1048576.
Enter a description of the HTTP listener.
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.
Specify the port number where the configuration binds to and listens for requests. The range of values is 1–65535.
Specify the name of the configuration for which you want to create the new HTTP listener socket.
Specify the name of the default server.
Specify the name of the default virtual server that processes requests which do not match a host-pattern.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-http-listener-prop(1), list-http-listeners(1), delete-http-listener(1), get-http-listener-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-instance <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--force|-f] --config|-c config-name (nodehost)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
Specify the name of the configuration for which you want to create the instance.
wadm create-instance --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-instance(1), list-instances(1), start-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
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.
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.
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.
Specify this option if you want to disable the JDBC resource at runtime.
Specify the transaction isolation level. The accepted values are read-uncommitted, read-committed, repeatable-read, or serializable.
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.
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.
Specify the table used when connection-validation-method is table.
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.
Specify the name of the configuration for which you want to create the JDBC resource.
Specify the name of the JDBC drive class.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), delete-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), set-jdbc-resource-prop(1), delete-jdbc-resource(1), list-jdbc-resources(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create JDBC resource user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the JDBC resource user property.
Specify the name of the configuration for which you want to create a JDBC resource user property.
Specify the JNDI name of the JDBC resource.
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.
Specify the name and value of the JDBC resource user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), create-jdbc-resource(1), set-jdbc-resource-prop(1), delete-jdbc-resource(1), list-jdbc-resources(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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]*
Use this command to create Java Virtual Machine (JVM) options. You must restart the server for newly created JVM options to take affect.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration for which you want to create the JVM options.
Specify the name of the JVM profiler to which these JVM options apply.
If you specify this option, the command creates a JVM option of type debug.
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. |
While specifying the JVM options, use hyphens (--) as a delimiter. Else, the JVM options that you define will be interpreted as a CLI option.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Provide a valid class path for the profiler.
Specify the path of the native library for the profiler.
Specify this option to disable the JVM profiler at runtime.
Specify the name of the configuration for which you want to create the JVM profiler.
wadm create-jvm-profiler --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 JVMProfiler1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-jvm-profiler-prop(1), get-jvm-profiler-prop(1), delete-jvm-profiler(1), create-jvm-options(1), delete-jvm-options(1), list-jvm-options(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URL to which the server redirects the request to in case the password is about to expire soon.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
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.
Specify the password for authentication. You can also define the bind-password in the password file.
Specify the search filter to find group memberships for the user. The default value is uniquemember.
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.
Specify the LDAP attribute name that contains group name entries. The default value is CN.
Specify a suffix for the LDAP database.
Specify this option to disable the authentication database at runtime.
Specify the URL of the LDAP authentication database. The type of authentication database is specified in the URL scheme.
Specify the name of the configuration for which you want to create the LDAP authentication database.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), delete-authdb(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to disable the lifecycle module at runtime.
If you specify this option, the server will not treat exceptions thrown during lifecycle module initialization as fatal.
Specify the class path for the lifecycle module.
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.
Enter a description of the lifecycle module.
Specify the name of the configuration for which you want to create the lifecycle module.
Specify the name of the class that implements the lifecycle module.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-lifecycle-module-prop(1), delete-lifecycle-module(1), get-lifecycle-module-prop(1), list-lifecycle-modules(1), create-lifecycle-module-userprop(1), delete-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create a lifecycle module user property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the lifecycle module user property.
Specify the name of the configuration for which you want to create the lifecycle module user properties.
Specify the name of the lifecycle module.
Specify the name and value of the lifecycle module property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1), create-lifecycle-module(1), set-lifecycle-module-prop(1), delete-lifecycle-module(1), get-lifecycle-module-prop(1), list-lifecycle-modules(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-mail-resource <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--no-enabled|-n] [--description|-D text] --config|-c config-name jndi-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the option to disable the mail resource at runtime.
Enter a description for the mail resource being created.
Specify the name of the configuration for which you want to create the mail resource.
wadm create-mail-resource --user=admin --host=serverhost --password-file=../admin.passwd--port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 MailResource1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-mail-resource(1), set-mail-resource-prop(1), list-mail-resources(1), get-mail-resource-prop(1), create-mail-resource-userprop(1), delete-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create the mail resource user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the mail resource user property.
Specify the name of the configuration.
Specify the JNDI name of the mail resource.
Specify the name and value of mail resource user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), delete-mail-resource(1), list-mail-resources(1), get-mail-resource-prop(1), set-mail-resource-prop(1), delete-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the category of the MIME types. The value can be type, enc, or lang.
Specify the name of the configuration for which you want to create the MIME type.
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.
wadm create-mime-type --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 application/sxc |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify this option to disable this authentication database at runtime.
Specify the name of the configuration for which you want to create the authentication database.
wadm create-pam-authdb --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 PAM1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), delete-authdb(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration for which you want to create the reverse proxy.
Specify the name of the virtual server.
Specify the URI prefix for the reverse proxy that you create.
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.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-reverse-proxy(1), list-reverse-proxy-uris(1), get-reverse-proxy-prop(1), set-reverse-proxy-prop(1), block-reverse-proxy-header(1), forward-reverse-proxy-header(1), list-reverse-proxy-headers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to disable this search collection at runtime.
Enter a name of the search collection that is displayed to users.
Specify the path to the directory system where the search collection metadata is stored.
Enter a description of the search collection.
Specify document fields that are used for indexing. Use comma (,) to specify multiple fields. For example, subject.
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.
Specify the file system documents root directory for the searchable documents.
Specify the name of the configuration for which you want to create the search collection.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-search-collection-prop(1), delete-search-collection(1), list-search-collections(1), get-search-collection-prop(1), reindex-search-collection(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to create a new search event. You can schedule tasks to be performed on collections at regular intervals.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify a time when this search event is scheduled.
Specify the day of the month when this search event is scheduled. The range of values is 1–31.
Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
Specify the month when this search event is scheduled. The range of values is 1 to 12.
Specify this option to disable the search event at runtime.
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.
If you specify this option, sub directories of the document root will not be searched.
Specify the wild card pattern of the documents.
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.
Specify the name of the configuration for which you want to create the event.
Specify the name of the virtual server.
Specify the name of the collection for which you need to schedule an event.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-search-event(1), list-search-events(1), disable-search-event(1), enable-search-event(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to create a new self-signed certificate.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the token (cryptographic device) name, which contains the encrypted public key.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Enter a description of an organizational unit within your company.
Enter a description of the city, principality, or country of the organization.
Specify the state or province where the business is located.
Specify the validity of the certificate.
Enter the official name of your company, educational institution, or organization.
Enter a two-character abbreviation of your country's name (in ISO format). For example, the country code for the United States is US.
Specify the type of the certificate key. The key types can be rsa or ecc.
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.
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.
Specify the name of the configuration for which you want to create the certificate.
Specify the host name of the server for which you are creating a self-signed certificate.
(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.
Enter a nick name for the certificate that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-service <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--config|-c config name (nodehost)+
Use this command to create a new Service Management Facility (SMF) service. SMF is a programming model that provides persistently running applications called services. A service can represent a running application, the software state of a device or a set of other services. By default, the first web server installation creates a service. You can use the create-service command to create a service for subsequent server installations.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm create-service --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to create a SOAP (Simple Object Access Protocol) authentication provider.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
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.
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.
This option defines a requirement for message layer authentication of the receiver of the response message to its sender, for example, by XML encryption.
Specify the name of the configuration for which you want to create the SOAP authentication provider.
Specify the class that implements the provider. The value of this option is a class name that implements javax.security.auth.XXX.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-soap-auth-provider-prop(1), delete-soap-auth-provider(1), get-soap-auth-provider-prop(1), list-soap-auth-providers(1), create-soap-auth-provider-userprop(1), delete-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create the SOAP (Simple Object Access Protocol) authentication provider user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Enter a description of the SOAP authentication user property.
Specify the name of the configuration for which you want to create the SOAP authentication user properties.
Specify the name of the SOAP authentication provider.
Specify the name and value of the SOAP authentication provider user property that you want to create.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1), create-soap-auth-provider(1), set-soap-auth-provider-prop(1), get-soap-auth-provider-prop(1), delete-soap-auth-provider(1), list-soap-auth-providers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI prefix you want to redirect.
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>
The uri-prefix and condition options are mutually exclusive.
Specify the target URL to which the requests should be redirected.
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.
Specify the name of the configuration for which you want to create a forwarding URL.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the first name of the user.
Specify the full name of the user.
Specify the surname or last name of the user.
Specify the password for the user being created. You can also define the user-password in the password file.
Specify the email address of the user.
Specify the contact number of the user.
Specify the title of the user.
Enter a description of an organizational unit within your company to which this user belongs.
Specify the realm that authenticates this user.
Specify the name of the configuration for which you want to create the user.
Specify the authentication database that will store the user information.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to create a server.xml variable. You can create a variable at the server as well as the virtual server levels.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Type a description of the server.xml variable that you want to create.
Specify the name of the virtual server for which you want to create a variable.
Specify the name of the configuration for which you want to create a variable.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of an HTTP listener associated with one or more of the virtual server's host names.
Define a list of hosts to be added to the new virtual server. To specify multiple URLs, separate them by a comma (,).
Specify a canonical host name of the virtual server. Requests that use a different host name will be redirected to this host name.
Specify a log file for the ACL file that controls access to the virtual server.
Specify the document root for the virtual server.
Specify the configuration where you want to create a new virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-virtual-server-prop(1), delete-virtual-server(1), get-virtual-server-prop(1), list-virtual-servers(1), copy-virtual-server(1), create-http-listener(1), create-config(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-acl <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (aclname)+
Use this command to delete access control list (ACL).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which the stored access control lists are to be deleted.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-authdb <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name authdb-name
Use this command to delete an authentication database.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the fully functioning virtual Web Server that resides within the same physical location of the Sun Java System Web Server.
Specify the name of the configuration for which the authentication database is being deleted.
wadm delete-authdb --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 DIGESTFILE1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-authdb-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name --authdb|-a dbname (propertyname)+
Use this command to delete the authentication database user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration.
Specify the name of the authentication database.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), list-authdbs(1), delete-authdb(1), create-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-auth-realm <connect_options>[--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name realm-name
Use this command to delete an authentication realm.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-auth-realm --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 basic |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-auth-realm(1), set-auth-realm-prop(1), get-auth-realm-prop(1), list-auth-realms(1), create-auth-realm-userprop(1), delete-auth-realm-userprop(1), list-auth-realm-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-auth-realm-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --realm|-L name (propertyname)
Use this command to delete an authentication realm user property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the authentication realm.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-auth-realm-userprop(1), list-auth-realm-userprops(1), create-auth-realm(1), delete-auth-realm(1), get-auth-realm-prop(1), set-auth-realm-prop(1), list-auth-realms(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to delete a certificate.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to enable a forced deletion of a certificate.
Specify the token (cryptographic device) name, which contains the encrypted public key.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the name of the configuration for which you are deleting the certificate.
wadm delete-cert --user=admin --host=serverhost --port=8989 --ssl=true --prompt=false --rcfile=null --password-file=certdb.newpasswd --config=config1 --token=internal cert2 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a common gateway interface (CGI) directory.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration for which the CGI directory is being deleted.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
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.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-cgi-envvar <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (varname)+
Use this command to delete a common gateway interface (CGI) environment variable.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration for which the CGI environment variable that is being deleted.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-config <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] config-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm delete-config --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-crl <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name issuername
Use this command to delete a CRL (certificate revocation list).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration from which the CRL is being deleted.
wadm delete-crl --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 "GlobalSign ServerSign CA" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-custom-resource <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name resource-name
Use this command to delete a custom resource.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-custom-resource --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 custom |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), delete-custom-resource-userprop(1), list-custom-resource-userprops(1), create-custom-resource(1), set-custom-resource-prop(1), list-custom-resources(1), get-custom-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-custom-resource-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j resourcename (propertyname)+
Use this command to delete a custom resource property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the custom resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), list-custom-resource-userprops(1), create-custom-resource(1), set-custom-resource-prop(1), delete-custom-resource(1), list-custom-resources(1), get-custom-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
delete-dav-collection <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --uri|-r uri-prefix --vs|-s vs-name
Use this command to delete a DAV collection.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the URI through which the content is accessed.
Specify the name of the virtual server where the WebDAV collection exists.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-dav-collection(1), get-dav-collection-prop(1), set-dav-collection-prop(1), list-dav-collections(1), enable-dav-collection(1), disable-dav-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a document directory.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration where the document directory exists.
Specify the name of the virtual server.
Specify the URI prefix that has to be mapped to a directory.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete an error page.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the error code.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a scheduled event.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the time you want this event start. The time format is hh:mm, for example, 12:30.
Specify the month you want this event to occur. The range of values is 1–12.
Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the day of the month you want this event to occur. The range of values is 1–31.
Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
Specify the name of the configuration.
Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-external-jndi-resource <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name jndi-name
Use this command to delete an external Java Naming and Directory Interface (JNDI) resource.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-external-jndi-resource --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 jndi1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource-userprop(1), delete-external-jndi-resource-userprop(1), list-external-jndi-resource-userprops(1), create-external-jndi-resource(1), set-external-jndi-resource-prop(1), get-external-jndi-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-external-jndi-resource-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j resourcename (propertyname)+
Use this command to delete an external Java Naming and Directory Interface (JNDI) resource property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the external JNDI resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource(1), set-external-jndi-resource-prop(1), delete-external-jndi-resource(1), get-external-jndi-resource-prop(1), create-external-jndi-resource-userprop(1), list-external-jndi-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a FastCGI handler.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the MIME type.
Specify the URI pattern.
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.
Specify the name of the configuration for which you want to delete the FastCGI handler.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-fastcgi-handler(1), get-fastcgi-handler-prop(1), set-fastcgi-handler-prop(1), list-fastcgi-handlers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to delete a user group.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
Give a description of an organizational unit within your company to which this user belongs.
Specify the authentication database where the group information is stored.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to delete an existing group member.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the fully functioning virtual Web server that resides within the same physical location as the Sun Java System Web Server.
Give a description of an organizational unit within your company to which this group member belongs.
Specify the authentication database in which the group information is stored.
Specify the ID of the group.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
delete-home-page <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name
Use this command to delete the home page.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm delete-home-page --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), enable-directory-listing(1), disable-directory-listing(1), get-directory-listing-prop(1), set-default-content-type(1), get-default-content-type(1), set-home-page(1), get-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-http-listener <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--force|-f] --config|-c config-name listener-name
Use this command to delete a HTTP listener socket.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to enable a forced deletion of the HTTP listener.
Specify the name of the configuration where the HTTP listener socket exists.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-http-listener(1), set-http-listener-prop(1), list-http-listeners(1), get-http-listener-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-instance <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--save-logs|-S] [--force|-f] --config|-c config-name (nodehost)+
Use this command to delete instances of the specified configuration and nodes.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to enable a forced deletion of an instance.
Specify this option to save the logs while deleting an instance.
Specify the name of the configuration that the instance points to.
wadm delete-instance --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), start-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-jdbc-resource <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name jndi-name
Use this command to delete a JDBC resource from the named configuration.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-jdbc-resource --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 jdbc |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), delete-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), create-jdbc-resource(1), set-jdbc-resource-prop(1), list-jdbc-resources(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to delete a JDBC resource property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
Specify the name of the configuration.
Specify the JNDI name of the JDBC resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), create-jdbc-resource(1), set-jdbc-resource-prop(1), delete-jdbc-resource(1), list-jdbc-resources(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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]*
Use this command to delete the Java Virtual Machine (JVM) options.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the JVM profiler to which these JVM options apply to.
If you specify this option, the JVM options of type debug is deleted.
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. |
While specifying the JVM options, use hyphens (--) as a delimiter. Else, the JVM options that you define will be interpreted as a CLI option.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-jvm-profiler <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name name
Use this command to delete a Java Virtual Machine (JVM) profiler.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-jvm-profiler --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 jvmprofiler1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jvm-profiler(1), set-jvm-profiler-prop(1), get-jvm-profiler-prop(1), create-jvm-options(1), delete-jvm-options(1), list-jvm-options(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-lifecycle-module <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name name
Use this command to delete a lifecycle module.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-lifecycle-module --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 LifecycleMod |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-lifecycle-module(1), set-lifecycle-module-prop(1), get-lifecycle-module-prop(1), list-lifecycle-modules(1), create-lifecycle-module-userprop(1), delete-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-lifecycle-module-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --module|-m name (propertyname)+
Use this command to delete a lifecycle module property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the life cycle module.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1), create-lifecycle-module(1), set-lifecycle-module-prop(1), delete-lifecycle-module(1), get-lifecycle-module-prop(1), list-lifecycle-modules(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-mail-resource <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name jndi-name
Use this command to delete a mail resource.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-mail-resource --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 MailReso |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), set-mail-resource-prop(1), list-mail-resources(1), get-mail-resource-prop(1), set-mail-resource-prop(1), create-mail-resource-userprop(1), delete-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-mail-resource-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j resourcename (propertyname)+
Use this command to delete the mail resource user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the mail resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), delete-mail-resource(1), list-mail-resources(1), get-mail-resource-prop(1), set-mail-resource-prop(1), create-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to delete a MIME (Multi-purpose Internet Mail Extension) type.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of a virtual server.
Specify the category of the MIME types. The value can be type, enc, or lang.
Specify the name of the configuration.
wadm delete-mime-type --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 appl/sxc |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a reverse proxy.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix of the reverse proxy that you want to delete.
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/ |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-reverse-proxy(1), list-reverse-proxy-uris(1), get-reverse-proxy-prop(1), set-reverse-proxy-prop(1), block-reverse-proxy-header(1), forward-reverse-proxy-header(1), list-reverse-proxy-headers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-search-collection <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name collection-name
Use this command to delete a search collection.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-collection(1), set-search-collection-prop(1), list-search-collections(1), get-search-collection-prop(1), reindex-search-collection(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a search event.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to disable the search event at runtime.
Specify a time when this search event is scheduled.
Specify the day of the month when this search event is scheduled. The range of values is 1–31.
Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
Specify the month when this search event is scheduled. The range of values is 1 to 12.
Specify the task the search event executes. The value can be add-documents or reindex.
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.
If you specify this option, sub directories of the document root will not be searched.
Specify the wild card pattern of the documents.
Specify the name of the configuration for which you want to delete the search event.
Specify the name of the virtual server.
Specify the name of the collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-event(1), list-search-events(1), disable-search-event(1), enable-search-event(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-service <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--config|-c config name (nodehost)+
Use this command to delete a Service Management Facility (SMF) service.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-service --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-soap-auth-provider <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name provider_name
Use this command to delete a SOAP authentication provider.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-soap-auth-provider(1), set-soap-auth-provider-prop(1), get-soap-auth-provider-prop(1), list-soap-auth-providers(1), create-soap-auth-provider-userprop(1), delete-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-soap-auth-provider-userprop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --provider|-o name (propertyname)*
Use this command to delete a SOAP authentication provider property.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the SOAP authentication provider.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1), create-soap-auth-provider(1), set-soap-auth-provider-prop(1), get-soap-auth-provider-prop(1), delete-soap-auth-provider(1), list-soap-auth-providers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to delete a forwarding URL.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix you want to redirect. The uri-prefix and condition options are mutually exclusive.
Specify the URL redirect condition. The condition and uri-prefix options are mutually exclusive.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to delete an existing user.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
Give a description of an organizational unit within your company to which this user belongs.
Specify the name of the configuration.
Specify the name of the authentication database that stores the user information.
Specify the name of the realm that authenticates this user.
wadm delete-user --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --authdb=keyfile1 user1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-variable <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (varname)+
Use this command to delete a server.xml variable.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm delete-variable --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs foo |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
delete-virtual-server <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name virtual-server-name
Use this command to delete a virtual server.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm delete-virtual-server --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 vs1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-virtual-server(1), set-virtual-server-prop(1), get-virtual-server-prop(1), list-virtual-servers(1), copy-virtual-server(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
deploy-config <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--force|-f] [--restart|-r] [--no-reconfig|-o] config-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
Specify this option for the command to restart the instances running in this configuration.
If you specify this option, the command will not reconfigure a configuration.
wadm deploy-config --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-access-log <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] [--uri-pattern|-t pattern] --config|-c config-name
Use this command to disable the access log.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the virtual server.
Specify the name of the configuration.
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" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-admin-ldap-auth <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]
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.
For a description of connect_options, see help(1).
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.
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.
Specify this option to display a verbose output.
wadm disable-admin-ldap-auth --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to disable the common gateway interface (CGI) support for certain files types registered in the mime-types file.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which the stored CGI properties are displayed.
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* |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-cgi-prop(1), create-cgi-dir(1), delete-cgi-dir(1), list-cgi-dirs(1), get-cgi-file-type-prop(1), enable-cgi-file-type(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to disable SSL ciphers.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the type of supported ciphers. The type can be ssl2 or ssl3tls.
Specify the name of the configuration file that contains the metadata to configure the runtime services of the Web Server.
Specify the name of the HTTP listener.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-dav-collection <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name --uri|-r uri
Use this command to disable a WebDAV collection.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server where this WebDAV collection exists.
Specify a URI through which the content is accessed.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-dav-collection(1), get-dav-collection-prop(1), set-dav-collection-prop(1), list-dav-collections(1), delete-dav-collection(1), enable-dav-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-directory-listing <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--error-page|-g filepath] --config|-c config-name --vs|-s vs-name
Use this command to disable directory listing and set an error response file.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the file to be displayed as a customized error response page.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), get-directory-listing-prop(1), enable-directory-listing(1), get-default-content-type(1), set-default-content-type(1), get-home-page(1), set-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-document-footer <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name --vs|-s vs-name
Use this command to disable the document footer.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm disable-document-footer --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to disable a scheduled event.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the time you want this event start. The time format is hh:mm, for example, 12:30.
Specify the month you want this event to occur. The range of values is 1–12.
Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the day of the month you want this event to occur. The range of values is 1–31.
Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
Specify the name of the configuration.
Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-htaccess <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name --vs|-s vs-name
Use this command to disable the .htaccess file.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm disable-htaccess --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-java <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name
Use this command to disable Java for a particular configuration. By default, Java is enabled for Sun Java System Web Server 7.0.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm disable-java --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to disable on-demand compression.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-p3p <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-cconfig-name --vs|-s vs-name
Use this command to disable P3P (platform for privacy preferences), which is a protocol that specifies a way to enable web security policies.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm disable-p3p --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-parsed-html <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] --vs|-s vs-name --config|-c config-name
Use this command to disable the parsed HTML content.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm disable-parsed-html --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-perfdump <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name
Use this command to disable the perfdump utility.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm disable-perfdump --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-precompressed-content <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] --vs|-s vs-name --config|-c config-name
Use this command to disable precompressed content.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm disable-precompressed-content --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-request-limits <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] --config|-c config-name --vs|-s vs-name
Use this command to disable the request limits.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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* |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to disable a search event.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify a time when this search event is scheduled.
Specify the day of the month when this search event is scheduled. The range of values is 1–31.
Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
Specify the month when this search event is scheduled. The range of values is 1 to 12.
Specify the wild card pattern of the documents that have to be added.
Specify the command the search event executes. The values can be add-documents or reindex.
Specify the name of the configuration for which you want to disable the search event.
Specify the name of the virtual server.
Specify the name of the collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-event(1), delete-search-event(1), list-search-events(1), disable-search-event(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-secretkey-restriction <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri-pattern|-t pattern] --vs|-s vs-name --config|-c config-name
Use this command to disable the secret key restriction.
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration for which you want to disable the secret key restrictions.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
wadm disable-secretkey-restriction --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-single-signon <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name
Use this command to disable single sign-on.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm disable-single-signon --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-snmp <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name
Use this command to disable SNMP.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm disable-snmp --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-stats-xml <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --vs|-s vs-name --config|-c config-name
Use this command to disable the server instance statistics.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm disable-stats-xml --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-unix-homedir <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name
Use this command to disable the UNIX home directory.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the configuration where the user document directory exists.
Specify the name of the virtual server.
wadm disable-unix-homedir --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-webapp <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --vs|-s vs-name --uri|-r context-root --config|-c config-name
Use this command to disable a web application.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the root URI for the web application.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
disable-webdav <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name
Use this command to disable WebDAV (Web-based Distributed Authoring and Versioning).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm disable-webdav --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable the access log.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the log format string for an access log.
Set this option to true to log the IP of the client into the access log.
Specify the URI wildcard pattern.
Specify the name of the virtual server.
Specify the name of the configuration.
Specify the file name for access log.
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%" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable the administration server to authenticate against a Lightweight Directory Access Protocol (LDAP) server.
For a description of connect_options, see help(1).
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.
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.
Specify this option to display a verbose output.
Specify the URL to which the server redirects the request if the password is going to expire soon.
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.
Specify the password for authentication. You can define the --bind-password|-b in a password file.
Specify the search filter to find group memberships for the user. The default value is uniquemember.
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.
Specify the LDAP attribute name that contains group name entries. The default value is CN.
Specify a suffix for the LDAP database.
Specify a comma separated list of groups. Users belonging to these groups are allowed to login.
Specify the URL of the LDAP authentication database. The type of authentication database is specified in the URL scheme.
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" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
The name of the user to execute the CGI programs.
The name of the group to execute the CGI programs.
The additional root directory that you create to limit the server to specific directories.
The directory to change to after chroot but before the execution of the CGI program
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.
Specify the name of the configuration for which the stored CGI properties are displayed.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
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* |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-cgi-prop(1), create-cgi-dir(1), delete-cgi-dir(1), list-cgi-dirs(1), get-cgi-file-type-prop(1), disable-cgi-file-type(1), create-mime-type(1), delete-mime-type(1), list-mime-types(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
Use this command to enable the SSL ciphers. A cipher is a cryptographic algorithm that is used for encryption or decryption.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the type of cipher. The type can be ssl2 or ssl3tls.
Specify the name of the configuration file that contains the metadata to configure the runtime services of the Web Server.
Specify the name of the HTTP listener.
Specify the name of the SSL cipher. For a list of ciphers, see the list-ciphers help page.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
enable-dav-collection <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name --uri|-r uri
Use this command to enable the WebDAV collection.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server in which this WebDAV collection is present.
Specify the name of the configuration.
Specify the URI through which the content is accessed.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-dav-collection(1), get-dav-collection-prop(1), set-dav-collection-prop(1), list-dav-collections(1), delete-dav-collection(1), disable-dav-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable directory listing.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), get-directory-listing-prop(1), disable-directory-listing(1), get-default-content-type(1), set-default-content-type(1), get-home-page(1), set-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the type of files to be included in the footer. The default value is text or html.
Specify the name of the virtual server.
Specify the date format to be displayed for the timestamp information. The custom format can be of type %B, %d, and %y.
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.
Specify the name of the configuration.
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" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable an event that you have created.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the time you want this event start. The time format is hh:mm, for example, 12:30.
Specify the month you want this event to occur. The range of values is 1–12.
Specify the day of the week you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the day of the month you want this event to occur. The range of values is 1–31.
Specify the time interval at which you want this event to occur. The range of values is 60–86400 seconds.
Specify the name of the configuration.
Specify the command the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl or commandline.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the .htaccess configuration file.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm enable-htaccess --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
enable-java <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm enable-java --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
If you specify this option, the Vary: Accept-encoding header is not inserted when a compressed version of a file is selected.
Specify the memory fragment size (in bytes) that has to be used by the compression library to control the rate of compression.
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.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable P3P (platform for privacy preferences). P3P is a protocol that specifies the method to enable web security policies.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URL of the site's policy reference file.
Specify the P3P compact policy.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
If you specify this option, the server parses HTML but does not allow HTML files to execute arbitrary programs on the server.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm enable-parsed-html --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
enable-perfdump <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--uri|-r uri] --config|-c config-name --vs|-s vs-name
Use this command to enable the perfdump utility.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI of the perfdump utility.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, a Vary: Accept-encoding header is not inserted when a compressed version of a file is selected.
If you specify this option, the compressed version is always selected even if it is older than the non-compressed version.
Specify the URI wildcard pattern.
Specify whether the static files should be compressed or not. The default value is false.
Specify the directory name in which the original non-compressed file is located.
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.
Specify the minimum size of the file. The default value is 256 kilobytes.
Specify the maximum size of the file. The default value is 1048576 kilobytes.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable the request limits.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
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.
Specify the HTTP status code to use for blocked requests. The default is 503, "Service Unavailable".
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.
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.
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.
Specify the URI pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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* |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable a search event.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the wild card pattern of the documents that have to be added.
Specify a time when this search event is scheduled.
Specify the day of the month when this search event is scheduled. The range of values is 1–31.
Specify the day of the week when this search event is scheduled. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.
Specify the time interval, in seconds, at which this search event will occur. The range of values is 60–86400.
Specify the month when this search event is scheduled. The range of values is 1 to 12.
Specify the task the search event executes. The value can be add-documents or reindex.
Specify the name of the configuration for which you want to enable the search event.
Specify the name of the virtual server.
Specify the name of the collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-event(1), delete-search-event(1), list-search-events(1), disable-search-event(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable the secret key restrictions.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Define the location of the file that contains the “reject access” message.
Specify the URI wildcard pattern.
Specify the name of the configuration for which the secret key restriction are to be enabled.
Specify the name of the fully functioning virtual server that resides within the same physical location as the Sun Java System Web Server.
Define the minimum size of the secret key.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
enable-single-signon <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--idle-timeout|-l timeout] --config|-c config-name --vs|-s vs-name
Use this command to enable single sign-on.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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.
wadm enable-single-signon --user=admin -host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable SNMP.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the master host.
Specify the name of the configuration.
Enter a description.
Specify the name of the organization.
Specify the location.
Enter the contact details.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable the server instance statistics which can be obtained in an XML format using get-stats-xml.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix of the instance for which you want to get the XML statistics.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to enable the UNIX home directory.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI prefix for the user directory.
Specify the name of the sub directory.
If you specify this option, the password file will be loaded at server startup.
Specify the file that contains the user password. Specify this option if you do not want to use the system password file.
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.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm enable-unix-homedir --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
enable-webapp <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name --uri|-r context-root
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of a virtual server.
Specify the root URI for the web application.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
enable-webdav <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm enable-webdav --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to expire a lock.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the configuration where the locks exist.
Specify the name of the virtual server.
Specify the URI on which the lock exists.
Specify the name of the collection URI.
Specify the ID of the lock that you want to expire. Lock IDs are displayed when you run the list-lock command.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix of the reverse proxy.
Specify the name of the HTTP request header that is used to forward the reverse proxy parameter.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), block-reverse-proxy-header(1), list-reverse-proxy-headers(1), create-reverse-proxy(1), delete-reverse-proxy(1), list-reverse-proxy-uris(1), get-reverse-proxy-prop(1), set-reverse-proxy-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
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.
Specify the status code of HTTP response code, for example, 200, 300, or 400.
Specify the number of log messages to be shown.
Specify the name of the virtual server. Use this option if you want to view the access file entries of a particular virtual server.
Specify the name of the configuration.
wadm get-access-log --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-access-log-buffer-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-access-log-buffer-prop --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-access-log-buffer-prop(1), enable-access-log(1), disable-access-log(1), get-access-log(1), get-log(1), get-log-prop(1), set-log-prop(1), rotate-log(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the URI wildcard pattern.
Specify the name of the configuration.
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" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-acl <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (aclname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-acl-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-acl-cache-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-admin-ldap-auth-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]
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.
For a description of connect_options, see help(1).
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.
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.
Specify this option to display a verbose output.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-admin-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--node|-n node-name] [--set-password|-r] (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify this option to change the administration server user password.
wadm get-admin-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-authdb-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name --authdb|-a name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration.
Specify the name of the authentication database.
wadm get-authdb-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --authdb=KEYFILE1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), delete-authdb(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-auth-realm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --realm|-L name (propertyname)*
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.)
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the authentication realm.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-auth-realm(1), delete-auth-realm(1), set-auth-realm-prop(1), list-auth-realms(1), create-auth-realm-userprop(1), delete-auth-realm-userprop(1), list-auth-realm-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the token (cryptographic device), which contains the encrypted public key.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the name of the configuration for which the certificate properties will be displayed.
Specify the short name or nick name of the certificate.
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" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which the stored CGI properties are displayed.
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* |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), set-cgi-prop(1), create-cgi-dir(1), delete-cgi-dir(1), list-cgi-dirs(1), enable-cgi-file-type(1), disable-cgi-file-type(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
(This option is deprecated.) Specify the URI wildcard pattern.
Specify the name of the configuration for which the stored CGI properties are displayed.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
wadm get-cgi-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-config-file <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]--config|-c config-name (filename)
Use this command to view any configuration file present in the config directory under server-root.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing it.
If you specify this option, wadm will not prompt you for passwords while 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.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-config-file --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 magnus.conf |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-config-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-config-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
get-config-stats <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--node|-n node-name] --config|-c config-name
Use this command to view the configuration statistics at the instance or configuration level.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the node.
Specify the name of the configuration.
wadm get-config-stats --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-crl-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --issuer-name|-r CA's name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the certificate authority (CA) issuer. The value can be the name of a company, organization, or department.
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" |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-custom-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the custom resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), delete-custom-resource-userprop(1), list-custom-resource-userprops(1), create-custom-resource(1), delete-custom-resource(1), list-custom-resources(1), set-custom-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server where this WebDAV collection exists.
Specify the name of the URI through which the content is accessed.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-dav-collection(1), set-dav-collection-prop(1), list-dav-collections(1), delete-dav-collection(1), enable-dav-collection(1), disable-dav-collection(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to view the default content details.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), enable-directory-listing(1), disable-directory-listing(1), get-directory-listing-prop(1), set-default-content-type(1), get-home-page(1), set-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-directory-listing-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), enable-directory-listing(1), disable-directory-listing(1),get-default-content-type(1), set-default-content-type(1), get-home-page(1), set-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-dns-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-dns-cache-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-dns-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-dns-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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)*
Use this command to view the error page details.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the error code.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-external-jndi-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the external JNDI resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource-userprop(1), delete-external-jndi-resource-userprop(1), list-external-jndi-resource-userprops(1), create-external-jndi-resource(1), set-external-jndi-resource-prop(1), delete-external-jndi-resource(1), list-external-jndi-resources(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the MIME type of the FastCGI handler.
Specify the URI pattern.
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.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-fastcgi-handler(1), delete-fastcgi-handler(1), set-fastcgi-handler-prop(1), list-fastcgi-handlers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-file-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-file-cache-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
get-home-page <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm get-home-page --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
help(1), enable-directory-listing(1), disable-directory-listing(1), get-directory-listing-prop(1), set-default-content-type(1), get-default-content-type(1), set-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
wadm get-htaccess-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-http-listener-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --http-listener|-l name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the configuration on which the HTTP listener socket exists.
Specify the name of the HTTP listener.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-http-listener(1), set-http-listener-prop(1), list-http-listeners(1), delete-http-listener(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-http-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-http-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
get-index-files <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name
Use this command to view the index files. Index files are a list of welcome files or startup pages for the virtual server.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm get-index-files --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), enable-directory-listing(1), disable-directory-listing(1), get-directory-listing-prop(1), set-default-content-type(1), get-default-content-type(1), set-home-page(1), delete-home-page(1), get-home-page(1), set-index-files(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-jdbc-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-jname (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the JDBC resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), delete-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), create-jdbc-resource(1), delete-jdbc-resource(1), list-jdbc-resources(1), set-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-jvm-profiler-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --profiler|-r name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the JVM profiler.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jvm-profiler(1), delete-jvm-profiler(1), set-jvm-profiler-prop(1), create-jvm-options(1), delete-jvm-options(1), list-jvm-options(1), get-jvm-prop(1), set-jvm-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-jvm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-jvm-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-keep-alive-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-keep-alive-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-lifecycle-module-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --module|-m name --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the lifecycle module.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-lifecycle-module(1), set-lifecycle-module-prop(1), delete-lifecycle-module(1), list-lifecycle-modules(1), create-lifecycle-module-userprop(1), delete-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-localization-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm get-localization-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
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.
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.
Specify the number of log messages to be shown from the end of the error log file.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm get-log --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), get-access-log-prop(1), rotate-log(1), get-access-log(1), enable-access-log(1), disable-access-log(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-log-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]--config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-log-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-mail-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the mail resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), set-mail-resource-prop(1), delete-mail-resource(1), list-mail-resources(1), create-mail-resource-userprop(1), delete-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the virtual server.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-p3p-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm get-p3p-prop --user=admin --host=serverhost --port=8989 --password-file=../admin.passwd --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
get-perfdump <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --node|-n node-name --config|-c config-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify the name of the configuration.
wadm get-perfdump --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=config1_vs1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-perfdump-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify the name of the configuration.
Specify the name of the virtual server.
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm get-perfdump-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-pkcs11-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-pkcs11-prop --user=admin --host=serverhost --port=8989 --password-file=../admin.passwd --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-qos-limits-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm get-qos-limits-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-qos-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-qos-prop --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI pattern.
Specify the name of the virtual server.
Specify the name of the configuration.
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* |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix of the reverse proxy.
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/ |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-reverse-proxy(1), delete-reverse-proxy(1), list-reverse-proxy-uris(1), set-reverse-proxy-prop(1), block-reverse-proxy-header(1), forward-reverse-proxy-header(1), list-reverse-proxy-headers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the name of the search collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-collection(1), set-search-collection-prop(1), list-search-collections(1), delete-search-collection(1), reindex-search-collection(1), get-search-prop(1), set-search-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-search-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm get-search-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), add-documents(1), remove-documents(1), set-search-prop(1), get-search-collection-prop(1), set-search-collection-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration for which the secret key restriction information are to be displayed.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-servlet-container-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-servlet-container-prop --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to view the Servlet statistics.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the node.
Specify the name of the virtual server.
Specify the name of the web application URI.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-session-replication-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--node|-n node-name ] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify the name of the configuration.
wadm get-session-replication-prop --user=admin --port=8989 --password-file=../admin.passwd --host=serverhost --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-single-signon-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (property-name)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-snmp-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-snmp-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-soap-auth-provider-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --provider|-o name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the SOAP authentication provider.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-soap-auth-provider(1), set-soap-auth-provider-prop(1), delete-soap-auth-provider(1), list-soap-auth-providers(1), create-soap-auth-provider-userprop(1), delete-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-ssl-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --http-listener|-l name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the HTTP listener.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-ssl-session-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-ssl-session-cache-prop --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-stats-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration
wadm get-stats-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
get-stats-xml <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --node|-n node-name
Use this command to view the XML statistics of a server configuration.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the node.
wadm get-stats-xml --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --node=node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-stats-xml-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm get-symlinks-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-thread-pool-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm get-thread-pool-prop --user=admin --port=8989 --password-file=../admin.passwd --host=serverhost --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-unix-homedir-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI prefix you want to redirect.
Specify the URL redirect condition.
The uri-prefix and condition options are mutually exclusive.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Enter a description of an organizational unit within your company to which this user belongs.
Specify the authentication database that stores the user information.
Enter the ID of the user.
Specify the realm that authenticates the user.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-virtual-server-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration on which the virtual server exists.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-virtual-server(1), set-virtual-server-prop(1), delete-virtual-server(1), list-virtual-servers(1), copy-virtual-server(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to view the virtual server statistics for a given configuration.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify the name of the configuration.
Specify the name of virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to view the the statistics for a given web application deployed on the given virtual server of the given instance.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify the name of the configuration.
Specify the name of web application URI.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-webdav-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]--config|-c config-name (propertyname)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Connect_Options | The wadm Variables | Exit Codes
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]
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 7 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
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]
Optional arguments (or options) are displayed within square brackets [], for example, [-user|-u].
Specify the user name of the authorized Web Server administrator.
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 |
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.
Specify the name of the machine where the Administration Server is running. The default host is localhost.
This option is required only if you are connecting to Administration Server remotely.
Specify the port number of the Administration Server. The default non-SSL port is 8800 and the default SSL port is 8989.
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.
Specify this option to use a plain text connection to communicate with the Administration Server. The default connection is SSL.
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 |
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|
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
Name | Synopsis | Description | Connect_Options | The wadm Variables | Exit Codes
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the token (cryptographic device), which contains the encrypted public key.
Specify the name of the configuration for which you are installing the certificate.
If you specify this option, the command replaces the existing certificate (if any).
--replace option of install-cert CLI is deprecated and currently using this option may not work as expected. For replacing a CA-signed certificate, users should delete the cert using delete-cert CLI and then install the new one using install-cert CLI.
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.
If you specify this option, the command stores a copy of the certificate file on the server where you install the certificate.
Specify the nick name or the short name of the certificate.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
install-crl <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--file-on-server|-f] --config|-c config-name crl-file
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration where you want to install the CRL.
If you specify this option, the CRL file is on the administration server machine.
wadm install-crl --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 ServerSign.crl |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-acls <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] [--vs|-s vs-name] --config|-c config-name
Use this command to list all Access Control Lists (ACL).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which you want to list the ACLs.
wadm list-acls --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-authdbs <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] [--vs|-s vs-name] --config|-c config-name
Use this command to list all authentication databases.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify the option, the command displays additional columns of information.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which you want to list the authentication databases.
wadm list-authdbs --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), set-authdb-prop(1), get-authdb-prop(1), delete-authdb(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list the authentication database user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which you want to list the authentication database user properties.
Specify the name of the authentication database that contains the user properties to be listed.
wadm list-authdb-userprops --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --authdb=LDAP1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-auth-realm(1), get-auth-realm-prop(1), set-auth-realm-prop(1),delete-authdb(1), list-auth-realms(1), create-authdb-userprop(1), delete-authdb-userprop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-auth-realms <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all authentication realms.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
wadm list-auth-realms --user=admin --port=8989 --password-file=../admin.passwd --host=serverhost --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-auth-realm(1), set-auth-realm-prop(1), get-auth-realm-prop(1), delete-auth-realm(1), create-auth-realm-userprop(1), delete-auth-realm-userprop(1), list-auth-realm-userprops(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-auth-realm-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --realm|-L name
Use this command to list all authentication realm properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the authentication realm.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-auth-realm-userprop(1), delete-auth-realm-userprop(1), create-auth-realm(1), delete-auth-realm(1), get-auth-realm-prop(1), set-auth-realm-prop(1), list-auth-realms(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all certificates.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the token (cryptographic device), which contains the encrypted public key.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the value as server to list the server certificates, or ca to list the certificate authority (CA) certificates.
Specify the name of the configuration for which you want to list the certificates.
wadm list-certs --user=admin --host=serverhost --port=8989 --ssl=true --prompt=false --rcfile=null --config=config1 --password-file=certdb.newpasswd |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-cgi-dirs <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
Use this command to list the CGI directories.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the CGI directories.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
wadm list-cgi-dirs --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-cgi-envvars <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list the CGI environment variables.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the CGI environment variables.
wadm list-cgi-envvars --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the type of cipher. The value can be ssl2 or ssl3tls ciphers.
Specify the name of the configuration for which you want to list the ciphers.
Specify the name of the HTTP listener.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-config-files <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list the configuration file information.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
wadm list-config-files --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-configs <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l]
Use this command to list all existing configurations.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
wadm list-configs --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-crls <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
Use this command to list the Certificate Revocation List (CRL) for a specified configuration.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to view the CRLs.
Specify the name of the virtual server.
wadm list-crls --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-custom-resources <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all custom resources.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the custom resources.
wadm list-custom-resources --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), delete-custom-resource-userprop(1), list-custom-resource-userprops(1), create-custom-resource(1), delete-custom-resource(1), set-custom-resource-prop(1), get-custom-resource-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-custom-resource-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --jndi-name|-j resourcename
Use this command to list all custom resource properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the Java Naming and Directory Interface.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), delete-custom-resource-userprop(1), create-custom-resource(1), set-custom-resource-prop(1), delete-custom-resource(1), list-custom-resources(1), get-custom-resource-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-dav-collections <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
Use this command to view a list of DAV collections.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the DAV collection.
Specify the name of the virtual server.
wadm list-dav-collections --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-dav-collection(1), get-dav-collection-prop(1), set-dav-collection-prop(1), delete-dav-collection(1), enable-dav-collection(1), disable-dav-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-document-dirs <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
Use this command to list all document directories.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the document directories.
Specify the name of the virtual server.
wadm list-document-dirs --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list the error pages.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the error pages.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-events <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all scheduled events.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the events.
wadm list-events --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-external-jndi-resources <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all external Java Naming and Directory Interface (JNDI) resources.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the external JNDI resources.
wadm list-external-jndi-resources --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource(1), get-external-jndi-resource-prop(1), delete-external-jndi-resource(1), get-external-jndi-resource-prop(1), create-external-jndi-resource-userprop(1), delete-external-jndi-resource-userprop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-external-jndi-resource-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --jndi-name|-j resourcename
Use this command to list the external JNDI (Java Naming and Directory Interface) resource properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the JNDI name of the resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource(1), get-external-jndi-resource-prop(1), delete-external-jndi-resource(1), get-external-jndi-resource-prop(1), create-external-jndi-resource-userprop(1), delete-external-jndi-resource-userprop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all FastCGI handlers.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the URI pattern.
Specify the name of the configuration for which you want to list the FastCGI handlers.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-fastcgi-handler(1), delete-fastcgi-handler(1), get-fastcgi-handler-prop(1), set-fastcgi-handler-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all group members.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the group members.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Enter a description of an organizational unit within your company to which this group member belongs.
Specify the name of the authentication database that stores the group information.
Specify the ID of the group member.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list user groups.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the user group that you want to list. Use wildcard character to list specific user groups.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which you want to list the group information.
Specify the name of the authentication database that stores the group information.
wadm list-groups --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --authdb=LDAP1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-http-listeners <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all existing HTTP listeners.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the HTTP listener sockets.
wadm list-http-listeners --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-http-listener(1), set-http-listener-prop(1), delete-http-listener(1), get-http-listener-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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)]
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration for which you want to list the nodes.
Specify the host name of the node for which you want to list the configurations.
If you specify this option, the command displays additional columns of information.
wadm list-instances --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), delete-instance(1), start-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-jdbc-resources <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all JDBC resources.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the JDBC resources.
wadm list-jdbc-resources --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), delete-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), create-jdbc-resource(1), delete-jdbc-resource(1), set-jdbc-resource-prop(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list the JDBC resource properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
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.
Specify the name of the configuration.
Specify the name of the Java Naming and Directory Interface (JNDI).
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), delete-jdbc-resource-userprop(1), create-jdbc-resource(1), set-jdbc-resource-prop(1), delete-jdbc-resource(1), list-jdbc-resources(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all Java Virtual Machine (JVM) options.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Indicates if these options belong to the JVM profiler.
Specify this option to list the JVM options of type debug.
Specify the name of the configuration for which you want to list the JVM options.
wadm list-jvm-options --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jvm-options(1), delete-jvm-options(1), create-jvm-profiler(1), set-jvm-profiler-prop(1), get-jvm-profiler-prop(1), delete-jvm-profiler(1), list-jvm-profilers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-jvm-profilers <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all Java Virtual Machine (JVM) profilers.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the JVM profilers.
wadm list-jvm-profilers --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jvm-profiler(1), set-jvm-profiler-prop(1), get-jvm-profiler-prop(1), delete-jvm-profiler(1), create-jvm-options(1), delete-jvm-options(1), list-jvm-options(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-lifecycle-modules <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all lifecycle modules.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the lifecycle modules.
wadm list-lifecycle-modules --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-lifecycle-module(1), set-lifecycle-module-prop(1), get-lifecycle-module-prop(1), delete-lifecycle-module(1), create-lifecycle-module-userprop(1), delete-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-lifecycle-module-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --module|-m name
Use this command to list the lifecycle module properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the life cycle module.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-lifecycle-module-userprop(1), delete-lifecycle-module-userprop(1), create-lifecycle-module(1), set-lifecycle-module-prop(1), delete-lifecycle-module(1), get-lifecycle-module-prop(1), list-lifecycle-modules(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to list the locks.
Specify the name of the virtual server.
Specify the name of the collection URI.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-mail-resources <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all mail resources.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration for which you want to view the mail resources.
wadm list-mail-resources --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), delete-mail-resource(1), set-mail-resource-prop(1), get-mail-resource-prop(1), create-mail-resource-userprop(1), delete-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-mail-resource-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --jndi-name|-j name
Use this command to list the mail resource user properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the JNDI name of the mail resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), delete-mail-resource(1), list-mail-resources(1), get-mail-resource-prop(1), create-mail-resource-userprop(1), delete-mail-resource-userprop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all MIME (Multi-purpose Internet Mail Extension) types.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the virtual server.
Specify the category of the MIME types. The value can be type, enc, or lang.
Specify the name of the configuration.
wadm list-mime-types --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-nodes <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l]
Use this command to lists all the nodes that are registered to the administration server. This command also lists the node status.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
wadm list-nodes --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), delete-instance(1), start-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), migrate-server(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all organization units.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which you want to list the organization units.
Specify the authentication database that stores the organization unit information.
wadm list-org-units --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --authdb=LDAP1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list the reverse proxy headers.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the URI of the reverse proxy.
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/ |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), block-reverse-proxy-header(1), forward-reverse-proxy-header(1), create-reverse-proxy(1), delete-reverse-proxy(1), get-reverse-proxy-prop(1), set-reverse-proxy-prop(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-reverse-proxy-uris <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
Use this command to list the reverse proxy Universal Resource Indicators (URI).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-reverse-proxy(1), delete-reverse-proxy(1), get-reverse-proxy-prop(1), set-reverse-proxy-prop(1), block-reverse-proxy-header(1), forward-reverse-proxy-header(1), list-reverse-proxy-headers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-search-collections <connect_options> [--echo|-e] [--no-prompt|-Q][--verbose|-v] [--all|-l] --vs|-s vs-name --config|-c config-name
Use this command to list the search collections.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm list-search-collections --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-collection(1), set-search-collection-prop(1), delete-search-collection(1), get-search-collection-prop(1), reindex-search-collection(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list search events.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the name of the collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-event(1), delete-search-event(1), , disable-search-event(1), enable-search-event(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-soap-auth-providers <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list the SOAP authentication providers.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
wadm list-soap-auth-providers --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-soap-auth-provider(1), set-soap-auth-provider-prop(1), delete-soap-auth-provider(1), get-soap-auth-provider-prop(1), create-soap-auth-provider-userprop(1), delete-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-soap-auth-provider-userprops <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --provider|-o name
Use this command to list the SOAP authentication provider properties.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of the SOAP authentication provider.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-soap-auth-provider-userprop(1), delete-soap-auth-provider-userprop(1), create-soap-auth-provider(1), set-soap-auth-provider-prop(1), get-soap-auth-provider-prop(1), delete-soap-auth-provider(1), list-soap-auth-providers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-tokens <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all PKCS#11 tokens.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
wadm list-tokens --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all Uniform Resource Indicator (URI) patterns.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the feature whose URI patterns should be listed.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm list-uri-patterns --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all forwarding URLs.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the type of the URL redirects.
Specify the name of the configuration.
Specify the name of the virtual server.
wadm list-url-redirects --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to list all users.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify a wildcard string for the user's first name.
Specify a wildcard string for the user's last name.
Specify a wildcard string for the user ID.
Specify the name of the virtual server.
Specify the name of the configuration.
Specify the name of the authentication database from which the list of users will being obtained.
wadm list-users --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --authdb=LDAP1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-variables <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] [--all|-l] --config|-c config-name
Use this command to list the server.xml variables.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the virtual server.
Specify the name of the configuration.
wadm list-variables --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-virtual-servers <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name
Use this command to list all virtual servers.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration where the virtual servers exist.
wadm list-virtual-servers --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-virtual-server(1), set-virtual-server-prop(1), get-virtual-server-prop(1), delete-virtual-server(1), copy-virtual-server(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
list-webapps <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--all|-l] --config|-c config-name --vs|-s vs-name
Use this command to list all web applications.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
If you specify this option, the command displays additional columns of information.
Specify the name of the configuration.
Specify the name of a virtual server.
wadm list-webapps --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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>
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the key password while migrating the JKS. You can also define the key-password in the password file.
Specify the key store password while migrating the JKS. You can also define the keystore-password in the password file.
Specify the token (cryptographic device), which contains the encrypted public key.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the name of the configuration.
Specify the path to the JKS path.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), delete-instance(1), start-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), list-nodes(1), migrate-server(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the directory for the search-collections of the old instance.
Specify the name of the new configuration that will be created after migration.
Specify the name of the instance to be migrated.
Specify this option to migrate all server instances.
Specify the directory for creating the migration log files, for example, server_root/admin-serv/logs.
Specify the installation location (directory) where previous versions of Web Server, that is, 6.0 or 6.1 is installed.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), delete-instance(1), start-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), list-nodes(1), migrate-jks-keycert(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
pull-config <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name nodehost
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the server configuration.
wadm pull-config --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
reconfig-instance <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (nodehost)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm reconfig-instance --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), delete-instance(1), start-instance(1), stop-instance(1), restart-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
register-node <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]
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
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm register-node --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
reindex-search-collection <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name collection-name
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to remove the search documents.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the wild card pattern of the documents that have to be deleted.
Specify the name of the configuration.
Specify the name of the collection.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
remove-node <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--force|-f] --node|-n node-name
Use this command to remove a node from the server farm.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify this option to enable a forced removal of a node.
Specify the name of the node that you want to remove.
wadm remove-node --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --node=node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
remove-webapp <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --vs|-s vs-name --uri|-r context-root --config|-c config-name
Use this command to remove a web application.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the root URI for the web application.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
renew-admin-certs <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--token-pin|-P name] [--validity|-d num of months]
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the validity period (in months) for the administration certificates. The default validity period is 120 months.
wadm renew-admin-certs --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --validity=120 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
restart-admin <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] nodehost
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm restart-admin --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
restart-instance <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (nodehost)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the configuration that the instance points to.
wadm restart-instance --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), delete-instance(1), start-instance(1), stop-instance(1), reconfig-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
rotate-log <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (nodehost)*
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.
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm rotate-log --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-access-log-buffer-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name and value of the access log buffer property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), get-access-log-buffer-prop(1), enable-access-log(1), disable-access-log(1), get-access-log(1), get-log(1), get-log-prop(1), set-log-prop(1), rotate-log(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
set-acl <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name --aclfile|-l file
Use this command to edit an Access Control List (ACL).
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of ACL file that you want to edit to add or remove an access control entry.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-acl-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-admin-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--node|-n node-name] [--set-password|-r] (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify this option to change the administration server user password.
Specify the name and value of the administration node property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration for which the authentication database properties are being edited.
Specify the name of the authentication database.
Specify the name and value of the authentication database property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-pam-authdb(1), create-ldap-authdb(1), create-file-authdb(1), create-authdb(1), get-authdb-prop(1), delete-authdb(1), list-authdbs(1), create-authdb-userprop(1), delete-authdb-userprop(1), list-authdb-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-auth-realm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --realm|-L name (propertyname=value)
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.)
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the authentication realm.
Specify the name and value of the authentication realm property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-auth-realm(1), delete-auth-realm(1), get-auth-realm-prop(1), list-auth-realms(1), create-auth-realm-userprop(1), delete-auth-realm-userprop(1), list-auth-realm-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the token (cryptographic device), which contains the encrypted public key.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the short name or the nick name of the certificate.
Specify the name of the configuration.
Specify the name and value of the certificate trust property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
(This option is deprecated.) Specify the URI wildcard pattern.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-config-file <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --upload-file|-o localfile (filename)
Use this command to edit any configuration file present in the config directory under server-root.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the local file to be uploaded to the configuration directory.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-config-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-custom-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the custom resource.
Specify the name and value of the custom resource property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-custom-resource-userprop(1), delete-custom-resource-userprop(1), list-custom-resource-userprops(1), create-custom-resource(1), delete-custom-resource(1), list-custom-resources(1), get-custom-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration where this DAV collection exists.
Specify the name of the virtual server.
Specify the URI through which the content is accessed.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-dav-collection(1), delete-dav-collection(1), list-dav-collections(1), get-dav-collection-prop(1), enable-dav-collection(1), disable-dav-collection(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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
Use this command to edit the default content type details.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the default character set to be used.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), get-directory-listing-prop(1), get-default-content-type(1), get-home-page(1), set-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-dns-cache-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-dns-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to edit the error page.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
If you specify this option, error page is treated as a file and not as an URI.
Specify the name of the virtual server.
Specify the name of the configuration.
Specify the page that will be displayed when an error occurs. This page can point either to a file or URI.
Enter the error code.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-external-jndi-resource-prop <connect_options> --echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the external JNDI resource.
Specify the name and value of the external JNDI resource property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-external-jndi-resource-userprop(1), delete-external-jndi-resource-userprop(1), list-external-jndi-resource-userprops(1), create-external-jndi-resource(1), delete-external-jndi-resource(1), get-external-jndi-resource-prop(1), list-external-jndi-resources(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the MIME type of the FastCGI handler.
Specify the URI pattern.
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.
Specify the name of the configuration for which you want to edit the FastCGI handler property.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-fastcgi-handler(1), delete-fastcgi-handler(1), get-fastcgi-handler-prop(1), list-fastcgi-handlers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-file-cache-prop <connect_options> [--echo|-e][--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-home-page <connect_options> [--echo|-e][--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name home-page-url
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), enable-directory-listing(1), disable-directory-listing(1), get-directory-listing-prop(1), set-default-content-type(1), get-default-content-type(1), get-home-page(1), delete-home-page(1), get-index-files(1), set-index-files(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-http-listener-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --http-listener|-l name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration on which the HTTP listener socket exists.
Specify the name of the HTTP listener.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-http-listener(1), delete-http-listener(1), list-http-listeners(1), get-http-listener-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-http-prop <connect_options> [--echo|-e][--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-index-files <connect_options> [--echo|-e][--no-prompt|-Q] [--verbose|-v]--config|-c config-name --vs|-s vs-name index-file-names
Use this command to edit the index files.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), enable-directory-listing(1), disable-directory-listing(1), get-directory-listing-prop(1), set-default-content-type(1), get-default-content-type(1), set-home-page(1), delete-home-page(1), get-home-page(1), get-index-files(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-jdbc-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-jname (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the JDBC resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jdbc-resource-userprop(1), delete-jdbc-resource-userprop(1), list-jdbc-resource-userprops(1), create-jdbc-resource(1), delete-jdbc-resource(1), list-jdbc-resources(1), get-jdbc-resource-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-jvm-profiler-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --profiler|-r name (propertyname=value)
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the JVM profiler.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-jvm-profiler(1), get-jvm-profiler-prop(1), delete-jvm-profiler(1), create-jvm-options(1), delete-jvm-options(1), list-jvm-options(1), get-jvm-prop(1), set-jvm-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-jvm-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-keep-alive-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name=value)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-lifecycle-module-prop <connect_options> --echo|-e] [--no-prompt|-Q] [--verbose|-v]--config|-c config-name --module|-m name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the life cycle module.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-lifecycle-module(1), delete-lifecycle-module(1), get-lifecycle-module-prop(1), list-lifecycle-modules(1), create-lifecycle-module-userprop(1), delete-lifecycle-module-userprop(1), list-lifecycle-module-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-localization-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (property-name=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-log-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-mail-resource-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --jndi-name|-j name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the JNDI name of the mail resource.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-mail-resource(1), delete-mail-resource(1), list-mail-resources(1), get-mail-resource-prop(1), create-mail-resource-userprop(1), delete-mail-resource-userprop(1), list-mail-resource-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-pkcs11-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
wadm set-pkcs11-prop --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 enabled=true |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-qos-limits-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--vs|-s vs-name] --config|-c config-name (property-name=value)
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the virtual server.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-qos-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)
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.
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the virtual server.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI prefix of the reverse proxy.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-reverse-proxy(1), delete-reverse-proxy(1), list-reverse-proxy-uris(1), get-reverse-proxy-prop(1), block-reverse-proxy-header(1), forward-reverse-proxy-header(1), list-reverse-proxy-headers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
Specify the name of the search collection.
Specify the name and value of the search collection property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-search-collection(1), delete-search-collection(1), list-search-collections(1), get-search-collection-prop(1), reindex-search-collection(1), get-search-prop(1), set-search-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-search-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --vs|-s vs-name --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), add-documents(1), remove-documents(1), get-search-prop(1), get-search-collection-prop(1), set-search-collection-prop(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-servlet-container-prop <connect_options> [--echo|-e] --no-prompt|-Q] [--verbose|-v] --config|-c config-name (property-name=value)+
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.
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name and value of the Servlet container property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-session-replication-prop <connect_options> --echo|-e] [--no-prompt|-Q] [--verbose|-v] [--node|-n node-name ] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the node.
Specify the name of the configuration.
Specify the name and value of the session replication property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-soap-auth-provider-prop <connect_options> --echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --provider|-o name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the SOAP authentication provider.
Specify the name and value of the SOAP authentication property that you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-soap-auth-provider(1), delete-soap-auth-provider(1), get-soap-auth-provider-prop(1), list-soap-auth-providers(1), create-soap-auth-provider-userprop(1), delete-soap-auth-provider-userprop(1), list-soap-auth-provider-userprops(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-ssl-prop <connect_options> [--echo|-e] --no-prompt|-Q] [--verbose|-v] --config|-c config-name --http-listener|-l name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the HTTP listener.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-ssl-session-cache-prop <connect_options> --echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-stats-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the URI wildcard pattern.
Specify the name of the configuration.
Specify the name of the virtual server.
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=../ |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-thread-pool-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
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
Use this command to set or reset the SSL token pin for the server.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify a new token pin when changing the token password. You can also define the new-token-pin in the password file.
If you specify this option, token element is added in configuration's server.xml file with the given pin (password).
Specify the name of the PKCS #11 token.
Specify the name of the configuration.
wadm set-token-pin --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 --token=internal |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
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.
Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.
Specify the name of the configuration.
Specify the name of the PKCS #11 token that contains the certificates.
wadm set-token-prop --user=admin --password-file=../admin.pwd --host=serverhost --port=8989 --config=config1 --token=internal |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
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)
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the realm that authenticates the user.
Specify the name of the virtual server that resides within the same physical location as the Sun Java System Web Server.
Enter a description of an organizational unit within your company to which this user belongs.
Specify this option to change the administration server user password.
Specify the user password. You can also define the user-password in the password file.
Specify the name of the configuration.
Specify the authentication database that stores the user information.
Specify the ID of the user whose property information you want to edit.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-virtual-server-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name --vs|-s vs-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
Specify the name of the virtual server.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-virtual-server(1), delete-virtual-server(1), get-virtual-server-prop(1), list-virtual-servers(1), copy-virtual-server(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
set-webdav-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (propertyname=value)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
start-instance <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] --config|-c config-name (nodehost)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration that the instance points to.
wadm start-instance --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), delete-instance(1), stop-instance(1), restart-instance(1), reconfig-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
start-snmp-master-agent <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--snmp-port|-m snmp-master-agent-port] (nodehost)
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.
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/.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the port number of the SNMP master agent.
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 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
start-snmp-subagent <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] (nodehost)+
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm start-snmp-subagent --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
stop-admin <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] nodehost
Use this command to stop the administration server or node. To restart the administration server, you can use the restart-admin command.
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm stop-admin --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
stop-instance <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v]--config|-c config-name (nodehost)*
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.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the name of the configuration that the instance points to.
wadm stop-instance --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null --config=config1 serverhost |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-instance(1), list-instances(1), start-instance(1), delete-instance(1), restart-instance(1), reconfig-instance(1), migrate-server(1), list-nodes(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
stop-snmp-master-agent <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] (nodehost)+
Use this command to stop the SNMP master agent.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm stop-snmp-master-agent --user=admin --password-file=../admin.passwd --host=serverhost --port=8989 --ssl=true --no-prompt --rcfile=null node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
stop-snmp-subagent <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] (nodehost)*
Use this command to stop the SNMP subagent.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
wadm stop-snmp-subagent --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null node1 |
The following exit values are returned:
command executed successfully
error in executing the command
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also