delete-instance

Deletes a Payara Server instance.

Synopsis

asadmin [asadmin-options] delete-instance [--help]
instance-name

Description

The delete-instance subcommand deletes a Payara Server instance. This subcommand requires the Distributed Component Object Model (DCOM) remote protocol or secure shell (SSH) 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 resides.

DCOM or SSH is not required if the instance resides on a node of type CONFIG that represents the local host. A node of type CONFIG is not enabled for remote communication over DCOM or SSH.

You may run this subcommand from any host that can contact the DAS.

The subcommand can delete any Payara Server instance, regardless of how the instance was created. For example, this subcommand can delete an instance that was created by using the create-local-instance subcommand.

The instance that is being deleted must not be running. Otherwise, an error occurs.

The subcommand deletes an instance by performing the following actions:

  • Removing the instance from the configuration of the domain administration server (DAS)

  • Deleting the instance’s files from file system

If the instance that is being deleted is the only instance that is using the node directory, that directory is also removed.

If a standalone instance is deleted, the instance’s standalone configuration is also deleted. A standalone instance refers to a configuration that is named instance-name`-config` to which no other clusters or unclustered instances refer.

This subcommand is supported in remote mode only.

Options

asadmin-options

Options for the asadmin utility. For information about these options, see the asadmin help page.

--help
-?

Displays the help text for the subcommand.

Operands

instance-name

The name of the instance to delete.

Examples

Example 1 Deleting a Payara Server Instance

This example deletes the Payara Server instance pmdsainst.

asadmin> delete-instance pmdsainst

Command delete-instance executed successfully.