Administering Named Configurations

Each named configuration is one of the following types of configuration:

The type of un-clustered instances is determined by the type of the configuration that the instance references.

For more information, see Types of Payara Server Instances.

The default-config configuration is a special configuration that acts as a template for creating new named configurations. Clusters and instances cannot refer to the default-config configuration. The default-config configuration can only be copied to create configurations.

When you create a cluster or an instance, you can choose whether to specify an existing configuration that the new cluster or instance will reference. If you choose to create a cluster or an instance without specifying an existing configuration, Payara Server automatically creates a configuration for the cluster or instance.

For more information, see the following sections:

Payara Server automatically creates a configuration by copying the default-config configuration. If you require an instance or cluster to reference a copy of a different configuration, copy the configuration and specify the copy when you create the instance or cluster.

For information about how to copy a configuration, see To Create a Named Configuration.

Payara Server assigns the name <cluster-or-instance>-config to an automatically created configuration. <cluster-or-instance> is the name of the cluster or instance for which the configuration is created.

The server-config configuration is automatically created for the domain administration server (DAS) when the domain is created.

When a named configuration is created, Payara Server creates a configuration directory on the domain administration server (DAS) at domain-dir/config/config-name.

This contents of this directory are synchronized to all instances that inherit or reference the configuration.

Use the copy-config subcommand in remote mode to create a named configuration by copying an existing configuration. Payara Server requires you to create a configuration by copying a configuration because a configuration contains many required settings.

The newly created configuration is identical to the configuration that you copy until you change its configuration settings.

Otherwise, create clusters and instances without specifying an existing configuration. If no configuration is specified, Payara Server creates a copy of the default configuration for the cluster or instance.

The following example creates the named configuration cluster-presets-config by copying the default configuration.

See Also

You can also view the full syntax and options of the subcommand by typing asadmin help copy-config at the command line.

Use the list-configs subcommand in remote mode to list existing named configurations in a domain.

The following example lists all named configurations in the current domain.

See Also

list-configs

You can also view the full syntax and options of the subcommand by typing asadmin help list-configs at the command line.

Use the list-clusters subcommand and the list-instances subcommand in remote mode to list the targets of a named configuration.

The targets of a named configuration are the clusters and Payara Server instances that reference the configuration.

The following example shows that the cluster ymlcluster and the instances yml-i1 and yml-i2 reference the named configuration ymlcluster-config.

See Also

You can also view the full syntax and options of the subcommands by typing the following commands at the command line:

Use the delete-config subcommand in remote mode to delete an existing named configuration from the configuration of the DAS.

You cannot delete the default-config configuration.

Before You Begin

Ensure that no clusters or instances refer to the configuration. If a cluster or instance refers to the configuration and is no longer required, delete the cluster or instance.

The following example confirms that no clusters or instances refer to the configuration cluster-presets-config and then deletes the configuration.

See Also

You can also view the full syntax and options of the subcommands by typing the following commands at the command line:

The default configuration default-config contains properties that define the initial values of port numbers in a configuration that is copied from default-config. When an instance or a cluster that references the configuration is created, these properties are set for the instance.

You can create additional system properties for a configuration either by specifying the --systemproperties option of the copy-config subcommand or by using the create-system-properties subcommand.

To reference a system property from the configuration, use the ${property-name} notation, where prop-name is the name of the system property.

For example, if a configuration defines additional HTTP listeners, use system properties to define the ports for those listeners. However, these properties are not set automatically when an instance or a cluster that references the configuration is created.

The properties in a named configuration that define port numbers are as follows:

Use the get subcommand and the set subcommand in remote mode to modify a named configuration’s properties.

You might copy a configuration for use by instances that reside on the same host as instances that refer to the original configuration. In this situation, edit the properties of one of the configurations to ensure that instances that will refer to the configuration have the correct initial settings.

If you change the port number in a configuration, the port number is changed for any instance that references or inherits the configuration.

The following example changes the value of the JMS_PROVIDER_PORT property in the cluster-presets-config configuration from 27676 to 27678.

See Also

You can also view the full syntax and options of the subcommands by typing the following commands at the command line:

Use the get subcommand and the set subcommand in remote mode to modify the port numbers of an instance.

The port numbers of an instance are initially set in the configuration that the instance references or inherits from its parent cluster. Multiple instances that reside on the same host must each listen on a unique port number.

Therefore, if multiple instances that reference or inherit the same configuration reside on the same host, a port conflict prevents all except one of the instances from starting. To avoid port conflicts, modify the port numbers on which individual instances listen.

If you modify an instance’s port number and later modify the port number in the instance’s configuration, the instance’s port number remains unchanged.

The port numbers of an instance are stored as Java system properties. When Payara Server is started, it treats these properties in the same way as properties that are passed through the -D option of the Java application launcher.

The following example changes the port number of the HTTP port or the HTTPS port for administration of the pmdsainst instance from 24849 to 24859.

See Also

You can also view the full syntax and options of the subcommands by typing the following commands at the command line: