Payara Enterprise Documentation

Currently Viewing Skip version selector. Request Evaluation Support

Payara Platform
Edit this Page

Notification Service Command Reference

notification-configure

Usage

asadmin> notification-configure --enabled=true --dynamic=true

Aim

Enables or disables the service.

Command Options

Option Type Description Default Mandatory

--enabled=true

Boolean

Enables or disables the service

False

No

--dynamic=true

Boolean

When set to true, applies the changes without a restart. Otherwise a restart is required.

False

No
The argument --dynamic=true is necessary to turn on the service for a running server, otherwise the change would only be applied after a server restart.

Example

asadmin> notification-configure --enabled=true --dynamic=true

list-notifiers

Usage

asadmin> list-notifiers

Aim

Lists available notifiers to use with the service. These can then be configured individually or referenced by other service commands, for example the Request Tracing Configuration commands.

Command Options

There are no available options for this command.

Example

Running the command on release 4.1.1.164 would yield the following results:

Available Notifier Services:
    service-log

Command list-notifiers executed successfully.

get-notification-configuration

Usage

asadmin> get-notification-configuration

Aim

This command can be used to list the details of the Notification Service.

Command Options

There are no available options for this command.

Example

Running the command will give output similar to the following:

Enabled  Notifier Enabled  Notifier Name
false    false             service-log

Command get-notification-configuration executed successfully.

set-notification-configuration

Usage

asadmin> set-notification-configuration --enabled=true --dynamic=true --notifierEnabled=true --notifierDynamic=true --useseparatelogfile=true

Aim

This command can be used to set the the configuration of the Notification Service and the Log Notifier at the same time.

Command Options

Option Type Description Default Mandatory

--enabled=true

Boolean

Enables or disables the service

False

No

--dynamic=true

Boolean

When set to true, applies the changes without a restart. Otherwise a restart is required.

False

No

--notifierEnabled

Boolean

Enables or disables the log notifier

false

Yes

--notifierDynamic

Boolean

When set to true, applies the changes to the log notifier without a restart. Otherwise a restart is required.

false

No

--useseparatelogfile

Boolean

When set to true, prints notifications to the configured log file (see Notification Logging)

false

No

Example

asadmin> set-notification-configuration
    --enabled=true
    --dynamic=true
    --notifierEnabled=true
    --notifierDynamic=true
    --useseparatelogfile=false