Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Reference Manual

## create-virtual-server(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO

#### NAME

create-virtual-server– creates the named virtual server

#### SYNOPSIS

`create-virtual-server` ––user admin_user [––passwordfile filename] [––host host_name] [––port port_number] [––secure|`–s`] [––terse=false] [––echo=false] [––interactive=true] [––help] [––target server] ––hosts hosts [––httplisteners http_listeners] [––defaultwebmodule default_web_module] [––state on] [––logfile log_file] [`––property (name=value)[:name=value]*`] virtual_server_id

#### DESCRIPTION

The `create-virtual-server` command creates the named virtual server. Virtualization in the Application Server allows multiple URL domains to be served by a single HTTP server process that is listening on multiple host addresses. If the application is available at two virtual servers, they still share the same physical resource pools.

This command is supported in remote mode only.

#### OPTIONS

`–u` `––user`

  The authorized domain application server administrative username.

`–w` `––password`

  The `––password` option is deprecated. Use `––passwordfile` instead.

`––passwordfile`

  This option replaces the `–– password` option. Using the `––password` option on the command line or through the environment is deprecated. The `––passwordfile` option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain application server password, use an entry with the following format: `AS_ADMIN_PASSWORD`=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_SAVEDMASTERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.

`–H` `––host`

  The machine name where the domain application server is running. The default value is localhost.

`–p` `––port`

  The port number of the domain application server listening for administration requests. The default port number for Enterprise Edition is 4849.

`–s` `––secure`

  If set to true, uses SSL/TLS to communicate with the domain application server.

`–t` `––terse`

  Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

`–e` `––echo`

  Setting to true will echo the command line statement on the standard output. Default is false.

`–I` `––interactive`

  If set to true (default), only the required password options are prompted.

`–h` `––help`

  Displays the help text for the command.

`––target`

  In Enterprise Edition, specifies the target for which you are creating the virtual server. Valid values are

  - `server`, which creates the virtual server for the default server instance `server` and is the default value

  - configuration_name, which creates the virtual server for the named configuration

  - cluster_name, which creates the virtual server for every server instance in the cluster

  - instance_name, which creates the virtual server for a particular server instance

`––hosts`

  A comma-separated (,) list of values allowed in the host request header to select the current virtual server. Each virtual server that is configured to the same connection group must have a unique hosts value for that group.

`––httplisteners`

  A comma-separated (,) list of HTTP listener IDs. Required only for a virtual server that is not the default virtual server.

`––defaultwebmodule`

  The standalone web module associated with this virtual server by default.

`––state`

  Determines whether a virtual server is active (on) or inactive (off or disabled). Default is active (on). When inactive, the virtual server does not service requests.

`––logfile`

  Name of the file where log entries for this virtual server are to be written. By default, this is the server log.

`––property`

  Optional attribute name/value pairs for configuring the virtual server. The following properties are available:

  Property | Definition
  --- | ---
  docroot | Absolute path to root document directory for server.
  accesslog | Absolute path to server access logs.
  sso-enabled | If false, single sign-on is disabled for this virtual server, and users must authenticate separately to every application on the virtual server. Single sign-on across applications on the Application Server is supported by servlets and JSP pages. This feature allows multiple applications that require the same user sign-on information to share this information, rather than have the user sign on separately for each application. Default is true.
  sso-max-inactive-seconds | Specifies the number of seconds after which a user's single sign-on record becomes eligible for purging if no client activity is received. Since single sign-on applies across several applications on the same virtual server, access to any of the applications keeps the single sign-on record active. Default is 300 seconds (5 minutes). Higher values provide longer single sign-on persistence for users at the expense of more memory use on the server.
  sso-reap-interval-seconds | Specifies the number of seconds between purges of expired single sign-on records. Default is 60.

#### OPERANDS

virtual_server_id

  Identifies the unique ID for the virtual server to be created. This ID cannot begin with a number.

#### EXAMPLES

##### Example 1 Using the create-virtual-server command

The following command creates a virtual server named `sampleServer`:

    asadmin> create-virtual-server --user admin1
    --passwordfile passwords.txt --hosts pigeon,localhost sampleServer
    Command create-virtual-server executed successfully.

#### EXIT STATUS

0

  command executed successfully

1

  error in executing the command

#### SEE ALSO

delete-virtual-server(1), list-virtual-servers(1), create-http-listener(1)

J2EE SDK 1.4 Last Revised 31 Jan 2005

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO

- © 2010, Oracle Corporation and/or its affiliates