2.6.5 create-instance

Synopsis

asadmin [asadmin-options] create-instance [--help] --node node-name
    [--config config-name | --cluster cluster-name]
    [--portbase=port-number] [--checkports={true|false}]
    [--systemproperties name=value[:name=value]...]
    [--prf prf-name] instance-name

Storage location

Application Server installation directory/javaee/glassfish/bin

Function

The create-instance subcommand creates a server instance.

This command requires the secure shell (SSH) protocol to be configured on the host where the Domain Administration Server (DAS) is running and on the host that is represented by the node where the instance must reside.

A server instance is a single Java VM on a single node in which Java EE Server is running. A node defines the host where the server instance resides. Java VM must be compatible with the Java Platform, Enterprise Edition (Java EE).

This subcommand is supported in remote mode only.

SSH is not required if the instance must reside on a node, of the type CONFIG, which represents the local host. A node of type CONFIG is not enabled for remote communication over SSH.

Execution permission

The information given below is for --systemproperties:

On UNIX, creating sockets that listen on ports in the range of 1-1024 requires superuser privileges.

Precondition

DAS has to be in a running state.

Arguments

--help | -?

Displays the help text for the subcommand.

--node node-name

Specifies the name of the node that defines the host where the instance is to be created.

Type: String

The following values can be specified:

• Name of the node

Default value: localhost-domain

--config config-name

Specifies the named configuration that the instance references. The configuration must exist and must not be named default-config or server-config.

Type: String

The following values can be specified:

• Name of the configuration

Default value: N/A

--cluster cluster-name

Specifies the cluster from which the instance inherits its configuration.

Type: String

The following values can be specified:

• Name of cluster

Default value: N/A

--portbase=port-number

Confirms the number with which the port assignment should start.

Type: Integer

The following values can be specified:

• -8 to 65449

Default value: N/A

--checkports={true|false}

Specifies whether to check for the availability of the administration, HTTP, JMS, JMX, and IIOP ports.

Type: Boolean

The following values can be specified:

• true

• false

Default value: true

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

Defines system properties for the instance. These properties override property definitions for port settings in the instance's 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.

Predefined port settings must be overridden if two clustered instances reside on the same host. In this situation, port settings for one instance must be overridden because both instances share the same configuration.

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 to 65535.

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• HTTP_LISTENER_PORT=value

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

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• HTTP_SSL_LISTENER_PORT=value

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

  Type: Integer

  Default value: N/A

  Range Value: 1 to 65535

• IIOP_LISTENER_PORT=value

  Specifies the port number of the port 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 of the port 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 of the port 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 of the port 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

--prf prf-name

Specifies the server name of the PRF used by the Java EE server. Specify the PRF server that exists in the node specified in the --node option.

Type: String

The following values can be specified:

• PRF name

Default value: N/A

instance-name

Specifies the name of the instance that is being created.

Type: String

The following values can be specified:

• Name of the instance

Default value: N/A

asadmin create-instance --node localhost-domain1 pmdsainst

Exit Status

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