appserver/admingui/cluster/src/main/help/en/help/ref-clustergeneral.html

<!--

    Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->

<p><a id="ref-clustergeneral" name="ref-clustergeneral"></a><a id="GHCLU00003" name="GHCLU00003"></a></p>

<h4><a id="sthref251" name="sthref251"></a><a id="sthref252" name="sthref252"></a><a id="sthref253" name="sthref253"></a><a id="sthref254" name="sthref254"></a>General Information</h4>
<a name="BEGIN" id="BEGIN"></a>
<p>The General Information page contains the following options.</p>
<dl>
<dt>Start Cluster</dt>
<dd>
<p>Button to start the cluster. If all instance in the cluster are running, this button is deactivated.</p>
</dd>
<dt>Stop Cluster</dt>
<dd>
<p>Button to stop the cluster. If all instances in the cluster are stopped, this button is deactivated.</p>
</dd>
<dt>Migrate EJB Timers</dt>
<dd>
<p>Button to migrate Enterprise JavaBeans (EJB) technology timers to from a stopped GlassFish Server instance to a running instance in the cluster. Clicking this button opens the <a href="ref-migrateejbtimers.html">Migrate EJB Timers</a> page. If all instances in the cluster are running, this button is deactivated.</p>
</dd>
<dt>Rotate Log</dt>
<dd>
<p>Button to rotate the log file for the cluster. When the log file is rotated, the file is renamed with a timestamp name in the format <code>server.log_</code><i>date-and-time</i>, and an empty log file is created for new log messages. The changes are applied dynamically. Server restart is not required.</p>
</dd>
<dt>Cluster Name</dt>
<dd>
<p>The name that was assigned to the cluster when the cluster was created. This field is read only.</p>
</dd>
<dt>JVM</dt>
<dd>
<p>If you click JVM Report, a separate window opens and displays reports on the Java Virtual Machine, including a summary report, memory management and garbage collection report, class loading report, and a current thread dump.</p>
</dd>
<dt>Configuration</dt>
<dd>
<p>The configuration that was selected for the cluster when the cluster was created. Clicking the configuration opens the <a href="../../../common/en/help/ref-configuration.html">Configurations</a> page for the cluster. This field is read only.</p>
</dd>
<dt>GMS</dt>
<dd>
<p>If this option is enabled, the Group Management Service (GMS) is started in each GlassFish Server instance in the cluster and in the domain administration server (DAS). The DAS participates in each cluster for which GMS is enabled. GMS provides cluster monitoring, cluster membership, and group communication services. This option is enabled by default.</p>
</dd>
<dt>Multicast Port</dt>
<dd>
<p>The port number of communication port on which GMS listens for group events. This option must specify a valid port number in the range 2048-49151. The default is an automatically generated value in this range.</p>
</dd>
<dt>Multicast Address</dt>
<dd>
<p>The address on which GMS listens for group events. This option must specify a multicast address in the range 224.0.0.0 through 239.255.255.255. The default is 228.9.<i>XX</i>.<i>YY</i>, where <i>XX</i> and <i>YY</i> are automatically generated independent values between 0 and 255.</p>
</dd>
<dt>Bind Interface Address</dt>
<dd>
<p>The Internet Protocol (IP) address of the network interface to which GMS binds. This option must specify the IP address of a local network interface. The default is all public network interface addresses.</p>
<p>On a multihome machine, this option configures the network interface that used for the GMS. A multihome machine possesses two or more network interfaces.</p>
<p>To specify an address that is valid for all GlassFish Server instances in the cluster, use a system property to set the address individually for each instance.</p>
<p>For example, use the <a href="ref-clustersystemproperties.html">Cluster System Properties</a> page to create the system property <code>GMS-BIND-INTERFACE-ADDRESS-</code><i>cluster-name</i>. Then set the Bind Address option in this page to <code>${GMS-BIND-INTERFACE-ADDRESS-</code><i>cluster-name</i><code>}</code> to specify the system property. Finally, for each instance in the cluster, set the <code>GMS-BIND-INTERFACE-ADDRESS-</code><i>cluster-name</i> system property to the required network interface address on the instance's machine.</p>
</dd>
<dt>Status</dt>
<dd>
<p>An indication of the number of instances in the cluster that are running and are not running. This field is read only.</p>
</dd>
</dl>
<a id="sthref255" name="sthref255"></a>
<h5>Related Tasks</h5>
<ul>
<li>
<p><a href="task-gmscluster.html">To Configure Group Management Service Settings for a Cluster</a></p>
</li>
<li>
<p><a href="task-migrate-ejb-timers.html">To Migrate EJB Timers</a></p>
</li>
</ul>
<a id="sthref256" name="sthref256"></a>
<h5>Equivalent asadmin Subcommands</h5>
<ul>
<li>
<p><a href="https://eclipse-ee4j.github.io/glassfish/docs/latest/reference-manual/generate-jvm-report.html#GSRFM00138"><code>generate-jvm-report</code>(1)</a></p>
</li>
<li>
<p><a href="https://eclipse-ee4j.github.io/glassfish/docs/latest/reference-manual/migrate-timers.html#GSRFM00211"><code>migrate-timers</code>(1)</a></p>
</li>
<li>
<p><a href="https://eclipse-ee4j.github.io/glassfish/docs/latest/reference-manual/rotate-log.html#GSRFM00224"><code>rotate-log</code>(1)</a></p>
</li>
</ul>


<small>Copyright &#169; 2005, 2020, Oracle and/or its affiliates. All rights reserved. <a href="docinfo.html">Legal Notices</a></small>