<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip
 laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen ne>
<?Pub Inc>
<refentry id="create-virtual-server-1">
<refmeta><refentrytitle>create-virtual-server</refentrytitle><manvolnum>1
</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="create-virtual-server">create-virtual-server &mdash;
creates the named virtual server</primary></indexterm><indexterm><primary
sortas="adds the named virtual server">creates the named virtual server &mdash;
create-virtual-server</primary></indexterm><refname>create-virtual-server
</refname><refpurpose>creates the named virtual server</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>create-virtual-server</command>&synopsis-common;
<arg>&Dash;&Dash;target <replaceable>server</replaceable></arg><arg choice="plain">&Dash;&Dash;hosts <replaceable>
hosts</replaceable></arg><arg>&Dash;&Dash;httplisteners <replaceable>http_listeners
</replaceable></arg><arg>&Dash;&Dash;defaultwebmodule <replaceable>default_web_module
</replaceable></arg><arg>&Dash;&Dash;state <replaceable>on</replaceable></arg>
<arg>&Dash;&Dash;logfile <replaceable>log_file</replaceable></arg><arg><option
role="nodash">&Dash;&Dash;property (<replaceable>name</replaceable>=<replaceable>
value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]*
</option></arg><arg choice="plain"><replaceable>virtual_server_id</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>The <filename>create-virtual-server</filename> 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.</para>
<para>This command is supported in remote mode only.</para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="nodash">&Dash;&Dash;target</option></term>
<listitem><para>This option specifies the target for which you are creating
the virtual server. Valid values are:<itemizedlist>
<listitem><para><literal>server</literal>, which creates the virtual server
for the default server instance. This is the default value.</para>
</listitem>
<listitem><para><replaceable>configuration_name</replaceable>, which creates
the virtual server for the named configuration</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>, which creates the
virtual server for every server instance in the cluster</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>, which creates the
virtual server for a particular server instance</para>
<para>&se-ee-only;</para>
</listitem>
</itemizedlist></para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&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="nodash">&Dash;&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="nodash">&Dash;&Dash;defaultwebmodule</option></term>
<listitem><para>The standalone web module associated with this virtual server
by default.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&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="nodash">&Dash;&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="nodash">&Dash;&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 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. 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><title>&oper-tt;</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><title>&exam-tt;</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><title>&exit-tt;</title>
<variablelist termlength="medium"><?Pub Caret>
<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><title>&also-tt;</title>
<para><link linkend="delete-virtual-server-1"><citerefentry><refentrytitle>
delete-virtual-server</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-virtual-server-1"><citerefentry><refentrytitle>list-virtual-servers
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend="create-http-listener-1"><citerefentry>
<refentrytitle>create-http-listener</refentrytitle><manvolnum>1</manvolnum>
</citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000012337>
