2.6.4 create-cluster

Synopsis

asadmin [asadmin-options] create-cluster [--help]
    [--config config-name]
    [--systemproperties name=value[:name=value]...]
    [--properties name=value[:name=value]...]
    [--gmsenabled={true|false}] [--multicastport multicast-port]
    [--multicastaddress multicast-address]
    [--bindaddress bind-address] cluster-name

Storage location

Application Server installation directory/javaee/glassfish/bin

Function

The create-cluster subcommand creates Java EE Server cluster. A cluster requires a reference to the named configuration that defines the configuration of all instances that are added to that cluster.

The cluster that is created is a standalone cluster because the cluster's configuration is not shared with any other clusters or standalone instances.

This command is supported in remote mode only.

Execution permission

On UNIX, creating sockets that listen on ports 1 to 1024 requires superuser privileges.

Precondition

Domain Administration Server (DAS) is running.

Arguments

--help | -?

Displays the help text for the subcommand.

--config config-name

Specifies the named configuration that the cluster references. Specifying the --config option creates a shared cluster. If this option is omitted, a standalone cluster is created.

Type: String

The following values can be specified:

• Specify the configuration name

Default value: N/A

--systemproperties name=value[:name=value]...

Defines system properties for the configuration that is created for the cluster. These properties override the property values in the default-config configuration. The specification format is name=value. Use a colon (:) to separate property names. If you specify the same property name more than once, the property value specified last is valid.

On UNIX, creating sockets that listen on ports 1 to 1024 requires superuser privileges.

Type: String

The following values can be specified:

• ASADMIN_LISTENER_PORT=value

  Specifies the port number of the HTTP port or HTTPS port through which the DAS connects to the instance to manage the instance. The valid values are in the range of 1-65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• HTTP_LISTENER_PORT=value

  Specifies the port number that is used to listen HTTP requests. The valid values are in the range of 1-65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• HTTP_SSL_LISTENER_PORT=value

  Specifies the port number that is used to listen HTTPS requests. The valid values are in the range of 1-65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• IIOP_LISTENER_PORT=value

  Specifies the port number that is used for IIOP connections. The valid values are in the range of 1 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• IIOP_SSL_LISTENER_PORT=value

  Specifies the port number that is used for secure IIOP connections. The valid values are in the range of 1 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• IIOP_SSL_MUTUALAUTH_PORT=value

  Specifies the port number that is used for secure IIOP connections with client authentication. The valid values are in the range of 1 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• JAVA_DEBUGGER_PORT=value

  Specifies the port number that is used for connections to the Java Platform Debugger Architecture (JPDA) (http://java.sun.com/javase/technologies/core/toolsapis/jpda/) debugger. The valid values are in the range of 1 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• JMS_PROVIDER_PORT=value

  Specifies the port number for the Java Message Service provider. The valid values are in the range of 1 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• JMX_SYSTEM_CONNECTOR_PORT=value

  Specifies the port number on which the JMX connector listens. The valid values are in the range of 1 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

Default value: N/A

--properties name=value[:name=value]...

Defines properties for the cluster. The specification format is name=value. Use a colon (:) to separate property names. If you specify the same property name more than once, the property value specified last is valid.

Type: String

The following values can be specified:

• GMS_DISCOVERY_URI_LIST=value

  Lists the locations of server instances in the cluster to be used for discovering the cluster. This property is required only if the Group Management Service (GMS) is not using multicast for broadcasting messages.

  The following values are valid for this property:

  A comma-separated list of Uniform Resource Identifiers (URIs). Each URL must locate a server instance or the DAS. This format is required if multiple server instances are running on the same host.

  The format of each URL in the list is as follows:

  scheme://host-name-or -IP-address:port

  scheme is the URI scheme, which is tcp.

  host-name-or -IP-address is the host name or IP address of the host on which the instance is running.

  port is the port number of the port on which the instance listens for messages from GMS. The system property GMS_LISTENER_PORT-cluster-name must be set for the instance.

  A comma-separated list of IP addresses or host names on which the DAS or the instances are running. The list can contain a mixture of IP addresses and host names. This format can be used only if one clustered instance is running on each host. The value of the GMS_LISTENER_PORT property must be unique for each cluster in a domain.

  The keyword generate. This format can be used only if one instance in a cluster is running on each host and the DAS is running on a separate host. Multiple instances on the same host cannot be members of the same cluster. The GMS_LISTENER_PORT value property must be unique for each cluster in a domain.

  The following values are valid for this property:

  Type: String

  Default Value: N/A

  Range: N/A

• GMS_LISTENER_PORT=value

  Specifies the port number of the port on which the cluster listens for messages from GMS. The default value is a reference to the GMS_LISTENER_PORT-cluster-name system property. By default, this system property is not set. In this situation, GMS selects a free port from the range that is defined by the properties GMS_TCPSTARTPORT and GMS_TCPENDPORT. By default, this range is 9090-9200. In most situations, the default behavior should suffice. However, if GMS is not using multicast for broadcasting messages, the GMS_LISTENER_PORT property must specify a port number that is valid for all server instances in the cluster. To use the default value to meet this requirement, use a system property to set the port number individually for each instance.

  For example, use the create-system-properties subcommand to create the system property GMS_LISTENER_PORT-cluster-name for the DAS. Then, for each instance in the cluster, set the GMS_LISTENER_PORT-cluster-name system property to the port number on which the instance listens for messages from GMS. The default value of the GMS_LISTENER_PORT property for the cluster references this system property.

  Type: Integer

  Default Value: N/A

  Range: 1 to 65535

• GMS_LOOPBACK=value

  Specifies whether an instance may receive from itself application-level messages that the instance broadcasts to the cluster.

  The possible values are as follows:

  true

  The instance may receive messages from itself. Use this setting for testing an instance when the instance is the only instance in a cluster.

  false

  The instance may not receive messages from itself. This is the default value.

  Type: Boolean

  Default Value: false

  Range:

  true

  false

• GMS_MULTICAST_TIME_TO_LIVE=value

  Specifies the maximum number of iterations or transmissions that a multicast message for the following types of events can experience before the message is discarded:

  Group discovery

  Member heartbeats

  Membership changes

  To match the configuration of the network on which the DAS and clustered instances are deployed, set this value as low as possible. To determine the lowest possible value for your system, use the validate-multicast subcommand. A value of 0 ensures that multicast messages never leave the host from which they are broadcast.

  A value of 1 might prevent the broadcast of messages between hosts on same subnet that are connected by a switch or a router. The default value is 4, which ensures that messages are successfully broadcasted to all cluster members in networks where hosts are connected by switches or routers.

  Type: Integer

  Default Value: 4

  Range: 0 to 255

• GMS_TCPENDPORT=value

  Specifies the highest port number in the range from which GMS selects a free port if the GMS_LISTENER_PORT-cluster-name system property is not set. The default value is 9200.

  Type: Integer

  Default Value: 9200

  Range: 1 to 65535

• GMS_TCPSTARTPORT=value

  Specifies the lowest port number in the range from which GMS selects a free port if the GMS_LISTENER_PORT-cluster-name system property is not set. The default value is 9090.

  Type: Integer

  Default Value: 9090

  Range: 1 to 65535

--gmsenabled={true|false}

Specifies whether GMS is enabled for the cluster.

Type: Boolean

The following values can be specified:

• true

  GMS is enabled for the cluster (default). When GMS is enabled for a cluster, GMS is started on each server instance in the cluster and in the DAS. The DAS participates in each cluster for which this option is set to true.

• false

  GMS is disabled for the cluster.

Default value: true

--multicastaddress multicast-address

Specifies the address on which GMS listens for group events.

Type: String

The following values can be specified:

• 224.0.0.0 to 239.255.255.255

Default value: 228.9.XX.YY where XX and YY are automatically-generated independent values between 0 and 255.

--multicastport multicast-port

Specifies the port number of the communication port on which GMS listens for group events.

Type: Integer

The following values can be specified:

• 2048 to 49151

Default value: The default value is an automatically generated value in the given range.

--bindaddress bind-address

Specifies the Internet Protocol (IP) address of the network interface to which GMS binds.

Default value: The default value is all the public network interface addresses.

cluster-name

Specifies the name of the cluster.

Type: String

The following values can be specified:

• Specify the cluster name

Default value: N/A

asadmin create-cluster --systemproperties IIOP_SSL_LISTENER_PORT=1169 ltscluster

Exit Status

Exit Status	Explanation
0	command executed successfully.
1	error in executing the command.