get-config-property
Provides a way to get the value of a MicroProfile configuration property stored in a specific configuration source.
Synopsis
asadmin [asadmin-options] get-config-property [--help]
[--propertyName=<property.name>]
[--source={domain|config|server|application|module|cluster}]
[--sourceName=<source.name>]
[--moduleName=<module.name>]
[--target=<target[default:server]>]
Description
The get-config-property
gets the value for the given Eclipse MicroProfile configuration property name in one of the built-in configuration sources.
The source is specified with --source
and, where there is ambiguity, the --sourceName
and --moduleName
options can be used.
For example, where the source is server
, the --sourceName
can be used to specify the name of the server where the property is to be stored.
Options
- asadmin-options
-
Options for the
asadmin
utility. For information about these options, see theasadmin
help page. --help
-?
-
Displays the help text for the subcommand.
--propertyName
-
The name of the configuration property to get.
--source
-
The configuration source where the property is stored.
--sourceName
-
The name of the source when there may be ambiguity, for example a source of type
application
must specify the name of the application.This property is required for sources of type:
config
,server
,application
ormodule
--moduleName
-
The name of the module when the source is of type
module
. When this is specified, thesourceName
parameter must be provided and must have the name of the application where the module is deployed. --target
-
Specifies the target where the configuration source resides.
Valid values are as follows:server
-
Specifies the DAS (default).
- instance-name
-
Specifies a Payara Server instance.
- cluster-name
-
Specifies a cluster.
- configuration-name
-
Specifies a named configuration.
Example
Example 1 Getting the configuration property value
This example gets the JMSBrokerURL
property value within the configuration source named myApplication
, belonging to the module myModule
, and targeting the myAppCluster
cluster.
asadmin get-config-property --propertyName=JMSBrokerURL --source=module --sourceName=myApplication --moduleName=myModule --target=myAppCluster