<!--Arbortext, Inc., 1988-2007, 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 CX solbook(>
<refentry id="create-http-listener-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-http-listener.1 1.16 07/07/13 SMI; -->
<refmeta><refentrytitle>create-http-listener</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">15 May 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-http-listener</primary></indexterm>
<indexterm><primary>adds a new HTTP listener socket</primary></indexterm>
<refname>create-http-listener</refname><refpurpose>adds a new HTTP listener
socket</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>create-http-listener</command> &synopsis-common;<option
role="double-dash">listeneraddress</option> <replaceable>address</replaceable> <option
role="double-dash">listenerport</option> <replaceable>listener_port </replaceable> 
<option role="double-dash">defaultvs</option> <replaceable>virtual_server</replaceable> [<option
role="double-dash">servername</option> <replaceable>server_name</replaceable>] 
[<option role="double-dash">acceptorthreads</option> <replaceable>acceptor-threads
</replaceable>] [<option role="double-dash">xpowered</option>={true|false}] 
[<option role="double-dash">redirectport</option> <replaceable>redirect_port</replaceable>] [<option
role="double-dash">securityenabled</option>={true|false}] 
[<option role="double-dash">enabled</option>={true|false}] [<option
role="double-dash">target</option> <replaceable>server</replaceable>] <replaceable>
listener_id</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <command>create-http-listener</command> command creates an HTTP
listener. This command is supported in remote mode only.</para>
<note><para>If you edit the special HTTP listener named <literal>admin-listener</literal>,
you must restart the server for the changes to take effect. The Administration
Console does not tell you that a restart is required in this case.</para></note>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="wholeline">&options-common;
<varlistentry><term><option role="double-dash">listeneraddress</option></term>
<listitem><para>The IP address or the hostname (resolvable by DNS).</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">listenerport</option></term>
<listitem><para>The port number to create the listen socket on. Legal values
are 1&ndash;65535. On UNIX, creating sockets that listen on ports 1&ndash;1024
requires superuser privileges. Configuring an SSL listen socket to listen
on port 443 is recommended.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">defaultvs</option></term>
<listitem><para>The ID attribute of the default virtual server for this listener.
</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">servername</option></term>
<listitem><para>Tells the server what to put in the host name section of any
URLs it sends to the client. This affects URLs the server automatically generates;
it doesn't affect the URLs for directories and files stored in the server.
This name should be the alias name if your server uses an alias. If a colon
and port number are appended, that port will be used in URLs that the server
sends to the client.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">acceptorthreads</option></term>
<listitem><para>The number of acceptor threads for the listen socket. The
recommended value is the number of processors in the machine. The default
value is 1.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">xpowered</option></term>
<listitem><para>If set to <literal>true</literal>, adds the <literal>X-Powered-By:
Servlet/2.4</literal> and <literal>X-Powered-By: JSP/2.0</literal> headers
to the appropriate responses. The Servlet 2.4 specification defines the <literal>
X-Powered-By: Servlet/2.4</literal> header, which containers may add to servlet-generated
responses. Similarly, the JSP 2.0 specification defines the <literal>X-Powered-By:
JSP/2.0</literal> header, which containers may add to responses that use JSP
technology.  The goal of these headers is to aid in gathering statistical
data  about the use of Servlet and JSP technology.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">redirectport</option></term>
<listitem><para>&se-ee-only; Port number for redirects. If the HTTP listener
is supporting non-SSL requests, and a request is received for which a matching
security-constraint requires SSL transport, the Communications Server<?Pub
Caret> will automatically redirect the request to this port number. </para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">securityenabled</option></term>
<listitem><para>If set to true, the HTTP listener runs SSL. You can turn SSL2
or SSL3 ON or OFF and set ciphers using an SSL element. The security setting
globally enables or disables SSL by making certificates available to the server
instance. The default value is false.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">enabled</option></term>
<listitem><para>If set to true, the listener is enabled at runtime.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">target</option></term>
<listitem><para>&se-ee-only; Specifies the target for which you are creating
the HTTP listener. Valid values are</para>
<itemizedlist>
<listitem><para><literal>server</literal>&hyphen; Specifies the default server
instance as the target for creating the listener. <literal>server</literal> is
the name of the default server instance and is the default value for this
option.</para></listitem>
<listitem><para><replaceable>configuration_name</replaceable>&hyphen; Specifies
a particular configuration as the target for creating the listener.</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>&hyphen; Specifies
all the server instances in a particular cluster as the targets for creating
the listener.</para></listitem>
<listitem><para><replaceable>stand-alone_instance_name</replaceable>&hyphen;
Specifies a particular server instance as the target for creating the listener.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>listener_id</replaceable></term>
<listitem><para>The listener ID of the HTTP listener.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using the <command>create-http-listener</command> command</title>
<para>The following command creates an HTTP listener named <filename>sampleListener
</filename> that uses a nondefault number of acceptor threads and is not enabled
at runtime:</para>
<screen>asadmin> <userinput>create-http-listener --user admin1 
--passwordfile passwords.txt --host host1 --port 4848 
--listeneraddress 0.0.0.0 --listenerport 7272 
--defaultvs server --servername host1.sun.com 
--acceptorthreads 100 --securityenabled=false 
--enabled=false sampleListener</userinput>
Command create-http-listener 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-http-listener-1">delete-http-listener(1)
</olink>, <olink targetdoc="asrefman" targetptr="list-http-listeners-1">list-http-listeners(1)
</olink>, <olink targetdoc="asrefman" targetptr="create-virtual-server-1">create-virtual-server(1)
</olink>, <olink targetdoc="asrefman" targetptr="create-ssl-1">create-ssl(1)</olink></para>
</refsect1>
</refentry>
<?Pub *0000008561 0>
