Asadmin Commands

The following is a list of the administration commands used to configure Hazelcast.

`set-hazelcast-configuration`

Since Payara Server 4.1.151

Usage: asadmin> set-hazelcast-configuration --disabled=true
Aim: Configures the underlying Hazelcast instance. See Data Grid Configuration for all the command line options for this command.

`get-hazelcast-configuration`

Since Payara Server 4.1.151

Aim: Return the current Hazelcast configuration.
Usage: asadmin> get-hazelcast-configuration

Command Options

Option Type Description Default Mandatory

Option	Type	Description	Default	Mandatory
`--target`	Instance or Cluster Name	Specifies a particular config	`server`	No

--target

Instance or Cluster Name

Specifies a particular config

server

Example

asadmin> get-hazelcast-configuration
Configuration File    Enabled  Start Port  MulticastGroup  MulticastPort  JNDIName            Lite Member  Cluster Name  Cluster Password  License Key          Host Aware Partitioning
hazelcast-config.xml  true     5900        224.2.2.3       54327          payara/Hazelcast    false        clustername   password          XXXX-XXXX-XXXX-XXXX  false

`list-hazelcast-cluster-members`

Since Payara Server 4.1.1.164

Aim: List the current members of the DAS' Hazelcast cluster in a formatted table, with extra properties.
Usage: asadmin> list-hazelcast-cluster-members

Command Options

Option Type Description Default Mandatory

Option	Type	Description	Default	Mandatory
`--type`	`server` or `micro`	Specifies the type of cluster to locate	Both	No

--type

server or micro

Specifies the type of cluster to locate

Both

Example

asadmin> list-hazelcast-cluster-members --type server
Instance Name  Instance Group  Instance Type  Host Name  HTTP Ports  HTTPS Ports  Admin Port  Hazelcast Port  Lite Member  Deployed Applications
server         server-config   DAS            127.0.1.1  8080        8181         4848        5901            false        __admingui

`list-hazelcast-members`

Since Payara Server 4.1.151

Aim: List the hazelcast members as a targetable array.
Usage: asadmin> list-hazelcast-members

Command Options

Option Type Description Default Mandatory

Option	Type	Description	Default	Mandatory
`--target`	Instance or cluster name	Specifies the targeted instance or cluster.	`server`	No

--target

Instance or cluster name

Specifies the targeted instance or cluster.

server

Example

asadmin> list-hazelcast-members
\{ server-/127.0.1.1:5901-this \}

`restart-hazelcast`

Since Payara Server 4.1.151

Aim: Restarts Hazelcast for the target.
Usage: asadmin> restart-hazelcast --target <instance-name>

Command Options

Option Type Description Default Mandatory

Option	Type	Description	Default	Mandatory
`--target`	Instance or cluster name	Specifies the targeted instance or cluster.	`server`	No

--target

Instance or cluster name

Specifies the targeted instance or cluster.

server

Example

asadmin> restart-hazelcast --target instance-name
instance-name:
Hazelcast Restarted

If multiple Payara Server instances are targeted for restart of the underlying Hazelcast instance then data loss can occur in the Data Grid

`list-cache-keys`

Since Payara Server 4.1.1.154

Aim: Lists all keys in a cache. If no cache is specified, keys from all caches will be returned.
Usage: asadmin> list-cache-keys

Command Options

Option	Type	Description	Default	Mandatory
name	String	Name of the cache to query		No

Option

Type

Description

Default

Mandatory

name

String

Name of the cache to query

`list-caches`

Since Payara Server 4.1.1.154

Aim: Lists the Hazelcast distributed caches in the cluster
Usage: asadmin list-caches

`clear-cache`

Since Payara Server 4.1.1.154

Aim: Clears a Hazelcast or JCache IMap
Usage: asadmin> clear-cache <cacheName>

Use of this commands removes all data from a cache and therefore can result in unexpected behaviour if a system cache is cleared. Clearing a cache containing web session data will result in all users losing their sessions.

`create-hazelcast-instance`

Since Payara Server 4.1.2.172

This is deprecated in 5.181 onwards as by default all instances are created as part of the Domain Data Grid

Usage: asadmin> create-hazelcast-instance new-instance
Aim: Creates a new Payara Server instance with Hazelcast and the persistence types.

Command Options

Option Type Description Default Mandatory

Option	Type	Description	Default	Mandatory
`--node`	Node Name	Specifies the node to create the instance on.		Yes
`--config`	Config Name	Specifies the config to use for the instance	`server-config`	No
`--lbenabled`	Boolean	Specifies whether the instance is enabled for load balancing, meaning that the load balancer directs requests to the instance.	true	No
`--checkports`	Boolean	Specifies whether the check that the administration, HTTP, JMS, JMX, and IIOP ports are free.	true	No
`--terse`	Boolean	Specifies whether output data should be returned in a concise format, suited for scripts, with descriptive text omitted.	false	No
`--portbase`	Port Number	Specifies the port to start assigning ports from. This will always output the assigned ports, even when omitted.		No
`--systemproperties`	Options	Specifies additional system properties which will override other settings, such as the assigned port. Examples include `ASADMIN_LISTENER_PORT` and `OSGI_SHELL_TELNET_PORT`.		No
`--target`	Config Name	Specifies the instance or cluster to configure.	`server-config`	No
`--enabled`	Boolean	Enables Hazelcast. If no target is specified, this will enable Hazelcast on the domain configuration (server-config). If no arguments are specified, defaults to true.	true	No
`--dynamic`	Boolean	Enable or disable dynamic stopping and starting of the embedded Hazelcast member.	false	No
`--hazelcastconfigurationfile`/ `-f`	File Path	The Hazelcast configuration file to use. This path is relative to the domain config directory, <Payara Installation Directory>/glassfish/domains/<Domain Name>/config/. Using this option to point to a valid Hazelcast configuration file will cause all other options set to be ignored. Any options unset within the Hazelcast configuration file will be set to the Hazelcast defaults	`hazelcast-config.xml`	No
`--startport`	Port Number	The port to run Hazelcast on. If this port is busy, the port specified will be incremented until a valid port is found.	5900	No
`--multicastgroup` `-g`	Multicast Address	The multicast group for communications in the Hazelcast instance.	224.2.2.3	No
`--multicastport`	Port Number	The multicast port for communications in the instance.		No
`--clustername`	Group Name	Specifies the Hazelcase group name, to be optionally used to help divide clusters into logical, segregated groups (i.e. dev-group, prod_grop).		No
`--clusterpassword`	Password	Specifies the password used to access the Hazelcast group.		No
`--jndiname` `-j`	JNDI Name	Specifies the JNDI name to bind the Hazelcast instance to.
`--licensekey` `-lk`	Hazelcast License	Enables Hazelcast Enterprise features.		No
`--lite`	Boolean	Sets the cluster to lite mode, where it will cluster but not store any data.	false	No
`--hostawarepartitioning`	Boolean	Whether or not to enable host-aware partitioning for the cluster. Host aware partitioning must be enabled on all members of the cluster (including Payara Micro instances) for this feature to work correctly.	false	No
`--webpersistence`	Boolean	Specifies whether Hazelcast will be used for web persistence.	True	No
`--ejbpersistence`	Boolean	Specifies whether Hazelcast will be used for web persistence.	True	No
`--help` `-?`		Displays the help menu	false	No

--node

Node Name

Specifies the node to create the instance on.

Yes

--config

Config Name

Specifies the config to use for the instance

server-config

--lbenabled

Boolean

Specifies whether the instance is enabled for load balancing, meaning that the load balancer directs requests to the instance.

true

--checkports

Boolean

Specifies whether the check that the administration, HTTP, JMS, JMX, and IIOP ports are free.

true

--terse

Boolean

Specifies whether output data should be returned in a concise format, suited for scripts, with descriptive text omitted.

false

--portbase

Port Number

Specifies the port to start assigning ports from. This will always output the assigned ports, even when omitted.

--systemproperties

Options

Specifies additional system properties which will override other settings, such as the assigned port. Examples include ASADMIN_LISTENER_PORT and OSGI_SHELL_TELNET_PORT.

--target

Config Name

Specifies the instance or cluster to configure.

server-config

--enabled

Boolean

Enables Hazelcast. If no target is specified, this will enable Hazelcast on the domain configuration (server-config).

If no arguments are specified, defaults to true.

true

--dynamic

Boolean

Enable or disable dynamic stopping and starting of the embedded Hazelcast member.

false

--hazelcastconfigurationfile/

-f

File Path

The Hazelcast configuration file to use. This path is relative to the domain config directory, <Payara Installation Directory>/glassfish/domains/<Domain Name>/config/.

Using this option to point to a valid Hazelcast configuration file will cause all other options set to be ignored. Any options unset within the Hazelcast configuration file will be set to the Hazelcast defaults

hazelcast-config.xml

--startport

Port Number

The port to run Hazelcast on. If this port is busy, the port specified will be incremented until a valid port is found.

5900

--multicastgroup

-g

Multicast Address

The multicast group for communications in the Hazelcast instance.

224.2.2.3

--multicastport

Port Number

The multicast port for communications in the instance.

--clustername

Group Name

Specifies the Hazelcase group name, to be optionally used to help divide clusters into logical, segregated groups (i.e. dev-group, prod_grop).

--clusterpassword

Password

Specifies the password used to access the Hazelcast group.

--jndiname

-j

JNDI Name

Specifies the JNDI name to bind the Hazelcast instance to.

--licensekey

-lk

Hazelcast License

Enables Hazelcast Enterprise features.

--lite

Boolean

Sets the cluster to lite mode, where it will cluster but not store any data.

false

--hostawarepartitioning

Boolean

Whether or not to enable host-aware partitioning for the cluster. Host aware partitioning must be enabled on all members of the cluster (including Payara Micro instances) for this feature to work correctly.

false

--webpersistence

Boolean

Specifies whether Hazelcast will be used for web persistence.

True

--ejbpersistence

Boolean

Specifies whether Hazelcast will be used for web persistence.

True

--help

-?

Displays the help menu

false

Example

asadmin> create-hazelcast-instance --webpersistence=false --lite instance2