<!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="install-jbi-component-1">
<refmeta><refentrytitle>install-jbi-component</refentrytitle><manvolnum>1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="install-jbi-component">install-jbi-component &mdash; installs a service engine or binding component into the JBI environment</primary></indexterm><indexterm><primary sortas="installs a service engine or binding component into the JBI environment">installs a service
engine or binding component into the JBI environment &mdash; install-jbi-component</primary></indexterm><refname>install-jbi-component</refname><refpurpose>installs a service engine or binding component into the JBI environment</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>install-jbi-component</command>&synopsis-common;
<arg choice="opt">&Dash;&Dash;enabled=<replaceable>true</replaceable></arg><arg choice="opt">--properties : <group><arg choice="plain" rep="repeat">(name=<replaceable>value</replaceable>)<arg choice="opt">:name=<replaceable>value</replaceable></arg></arg><arg choice="plain"><replaceable>file</replaceable></arg>
</group></arg><arg choice="opt">&Dash;&Dash;upload=<replaceable>true</replaceable></arg><arg choice="opt">&Dash;&Dash;target <replaceable>target</replaceable></arg><arg choice="plain"><replaceable>filepath or component_name</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>T<?Pub Caret1>he <command>install-jbi-component</command> command installs a service engine or binding component into the JBI environment. </para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="nodash">&Dash;&Dash;enabled</option></term><listitem><para>If this option is set to true, the component is started automatically when the system starts up. Users are allowed to access the component. If this option is set to false, the component is not started automatically
when the system starts up. Users are not able to access the component. For EE, this option enables the component on the specified target instance or cluster. This option is ignored when the component is being deployed on the target domain.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">--properties</option></term><listitem><para>Property values that are to be set for the component. The option can be specified as a string of keyword-value pairs, or the name of a property file can be provided.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;upload</option></term><listitem><para>When this option is set to true, the command uploads the file to the administration server. The file is uploaded to the <systemitem class="environvar">$JBI_HOME</systemitem><filename>/tmp</filename> directory on
the Domain Administration Server (DAS), for example, <systemitem class="environvar">$AS_INSTALL_DIR</systemitem><filename>/domains/</filename><replaceable>domain_name</replaceable><filename>/jbi/tmp</filename>. If the filepath of the installable file is mounted to the server machine, or if the administration
server is running locally, set this option to false.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;target</option></term><listitem><para>Specifies the target on which you are installing the JBI component. Specify this option only if you are installing the JBI component in a multiserver environment with a DAS. If you are not installing the JBI component
in a multiserver environment with a DAS, this option is ignored. Valid values are:<itemizedlist>
<listitem><para><literal>server</literal>, which installs the JBI component on the embedded DAS instance. This is the default value.</para>
</listitem>
<listitem><para><literal>domain</literal>, which installs the JBI component on the administrative domain itself. Specify <literal>domain</literal> only if you are using the cluster profile.</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>, which installs the JBI component on every server instance in the cluster.</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>, which installs the JBI component on the named unclustered server instance.</para>
</listitem>
</itemizedlist></para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="wholeline">
<varlistentry><term><replaceable>filepath or component_name</replaceable></term><listitem><para>The path to the archive file that contains the attributes of the JBI component or the name of the JBI component or service assembly that has previously been installed.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>Using the install-jbi-component command</title>
<para>The following command installs a JBI component.</para>
<screen>asadmin> <userinput>install-jbi-component --user admin2
--passwordfile passwords.txt --target server1 filepath</userinput>
Command install-jbi-component executed successfully.</screen>
</example>
</refsect1>
<refsect1><title>&exit-tt;</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><title>&also-tt;</title>
<para><link linkend="start-jbi-component-1"><citerefentry><refentrytitle>start-jbi-component</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend="list-jbi-binding-components-1"><citerefentry><refentrytitle>list-jbi-binding-components</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-jbi-service-engines-1"><citerefentry><refentrytitle>list-jbi-service-engines</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend="stop-jbi-component-1"><citerefentry><refentrytitle>stop-jbi-component</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="shut-down-jbi-component-1"><citerefentry><refentrytitle>shut-down-jbi-component</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend="uninstall-jbi-component-1"><citerefentry><refentrytitle>uninstall-jbi-component</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="upgrade-jbi-component-1"><citerefentry><refentrytitle>upgrade-jbi-component</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000007304>
