<!--Arbortext, Inc., 1988-2008, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="create-virtual-server-1"><?Pub Tag atict:info tracking="off"
ref="2"><?Pub Tag atict:user user="hl34125" fullname=""><?Pub Tag atict:user
user="pmdavies" fullname=""><?Pub Tag atict:user user="ah95648" fullname="">
<!-- @(#)create-virtual-server.1 1.10 07/07/03 SMI; -->
<refmeta><refentrytitle>create-virtual-server</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">30 Jan 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary>create-virtual-server</primary></indexterm>
<indexterm><primary>creates the named virtual server</primary></indexterm>
<refname>create-virtual-server</refname><refpurpose>creates the named virtual
server</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>create-virtual-server</command> &synopsis-common; [<option
role="double-dash">target</option> <replaceable>server</replaceable>]
 <option role="double-dash">hosts</option> <replaceable>hosts</replaceable> [<option
role="double-dash">httplisteners</option> <replaceable>http_listeners</replaceable>]
 [<option role="double-dash">defaultwebmodule</option> <replaceable>default_web_module
</replaceable>]
 [<option role="double-dash">state</option> <replaceable>on</replaceable>] [<option
role="double-dash">logfile</option> <replaceable>log_file</replaceable>]
 [<option role="double-dash">property</option> (<replaceable>name</replaceable>=<replaceable>
value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]*]
 <replaceable>virtual_server_id</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <filename>create-virtual-server</filename> command creates the named
virtual server. Virtualization 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.</para>
<para>This command is supported in remote mode only.</para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="double-dash">target</option></term>
<listitem><para>This option specifies the target for which you are creating
the virtual server. Valid values are:</para>
<itemizedlist>
<listitem><para><literal>server</literal>&hyphen; Specifies the default server
instance as the target for creating the virtual server. <literal>server</literal> is
the name of the default server instance and is the default value.</para>
</listitem>
<listitem><para><replaceable>configuration_name</replaceable>&hyphen; Specifies
a particular configuration as the target for creating the virtual server.</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>&hyphen; Specifies
a particular cluster as the target for creating the virtual server.</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>&hyphen; Specifies
a particular server instance as the target for creating the virtual server.</para>
<para>&se-ee-only;</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">hosts</option></term>
<listitem><para>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 host for that group.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">httplisteners</option></term>
<listitem><para>A comma-separated (,) list of HTTP listener IDs. Required
only for a virtual server that is not the default virtual server.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">defaultwebmodule</option></term>
<listitem><para>The standalone web module associated with this virtual server
by default.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">state</option></term>
<listitem><para>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.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">logfile</option></term>
<listitem><para>Name of the file where log entries for this virtual server
are to be written. By default, this is the server log.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">property</option></term>
<listitem><para>Optional attribute name/value pairs for configuring the virtual
server. The following properties are available:</para>
<informaltable frame="all" orient="port">
<tgroup cols="2">
<?PubTbl tgroup dispwid="9.17in">
<colspec colname="col1" colwidth="0.68*"><colspec colname="col2" colwidth="1.32*">
<thead>
<row>
<entry align="center" valign="top">
<para> Property</para>
</entry>
<entry align="center" valign="top">
<para>Definition</para>
</entry>
</row>
</thead>
<tbody>
<row>
<entry colname="col1">
<para>docroot</para>
</entry>
<entry colname="col2">
<para>Absolute path to root document directory for server.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>accesslog</para>
</entry>
<entry colname="col2">
<para>Absolute path to server access logs.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>sso-enabled</para>
</entry>
<entry colname="col2">
<para>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<?Pub Caret> 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. The default value is true.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>sso-max-inactive-seconds</para>
</entry>
<entry colname="col2">
<para>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.
 The default value is 300 seconds (5 minutes). Higher values provide longer
single sign-on persistence for users, but at the expense of more memory use
on the server.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>sso-reap-interval-seconds</para>
</entry>
<entry colname="col2">
<para>Specifies the number of seconds between purges of expired single sign-on
records.  The default value is 60.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>default-web-xml</para>
</entry>
<entry colname="col2">
<para>Indicates the location of the file default-web.xml. The default location
is $[S1AS_HOME]/domains/domain1/config/default&mdash;web.xml </para>
</entry>
</row>
<row>
<entry colname="col1">
<para>allowLinking</para>
</entry>
<entry colname="col2">
<para>If the value of this property is true, resources that are symbolic links
will be served for all web applications deployed on this virtual server. Individual
web applications may override this setting by using the property allowLinking
under the sun-web-app element in the sun-web.xml file: </para>
<para>&lt;sun-web-app></para>
<para> &lt;property name=&rdquo;allowLinking&rdquo; value=&rdquo;[true|false]&rdquo;/>
</para>
<para>&lt;/sun-web-app></para>
<para>The default value is true.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>accessLogWriteInterval</para>
</entry>
<entry colname="col2">
<para>Indicates the number of seconds before the log will be written to the
disk. The access log is written when the buffer is full or when the interval
expires. If the value is 0 (zero), then the buffer is always written even
if it is not full. This means that each time the server is accessed, the log
message is stored directly to the file.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>accessLogBufferSize</para>
</entry>
<entry colname="col2">
<para>Specifies the size, in bytes, of the buffer where access log calls are
stored.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>allowRemoteAddress</para>
</entry>
<entry colname="col2">
<para>This is a comma-separated list of regular expression patterns to which
the remote client's IP address is compared. If this property is specified,
the remote address must match for this request to be accepted. If this property
is not specified, all requests will be accepted unless the remote address
matches a denyRemoteAddress pattern. The default value for this property is
null.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>denyRemoteAddress</para>
</entry>
<entry colname="col2">
<para>This is a comma-separated list of regular expression patterns to which
the remote client's IP address is compared. If this property is specified,
the remote address must not match for this request to be accepted. If this
property is not specified, request acceptance is governed solely by the allowRemoteAddress
property. The default value for this property is null.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>allowRemoteHost</para>
</entry>
<entry colname="col2">
<para>This is a comma-separated list of regular expression patterns to which
the remote client's host name (as returned by java.net.Socket.getInetAddress().getHostName())
is compared. If this property is specified, the remote host name must match
for this request to be accepted. If this property is not specified, all requests
will be accepted unless the remote host name matches a denyRemoteHost pattern.
The default value for this property is null.</para>
</entry>
</row>
<row>
<entry colname="col1">
<para>denyRemoteHost</para>
</entry>
<entry colname="col2">
<para>This is a comma-separated list of regular expression patterns to which
the remote client's host name (as returned by java.net.Socket.getInetAddress().getHostName())
is compared. If this property is specified, the remote host name must not
match for this request to be accepted. If this property is not specified,
request acceptance is governed solely by the allowRemoteHost property. The
default value for this property is null.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>virtual_server_id</replaceable></term>
<listitem><para>Identifies the unique ID for the virtual server to be created.
This ID cannot begin with a number.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using the create-virtual-server command</title>
<para>The following command creates a virtual server named <filename>sampleServer
</filename>:</para>
<screen>asadmin> <userinput>create-virtual-server --user admin1 
--passwordfile passwords.txt --hosts pigeon,localhost sampleServer</userinput>
Command create-virtual-server executed successfully.</screen>
</example>
</refsect1>
<refsect1 role="exit-status"><title></title>
<variablelist termlength="medium">
<varlistentry><term>0</term>
<listitem><para>command executed successfully</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem><para>error in executing the command</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="delete-virtual-server-1">delete-virtual-server(1)
</olink>, <olink targetdoc="asrefman" targetptr="list-virtual-servers-1">list-virtual-servers(1)
</olink>, <olink targetdoc="asrefman" targetptr="create-http-listener-1">create-http-listener(1)
</olink></para>
</refsect1>
</refentry>
