Visit Azul.com Support

Delete-Config-Property

Table of Contents
Need help?
Schedule a consultation with an Azul performance expert.
Contact Us

Provides a way to delete a MicroProfile Configuration property in one of the built-in configuration sources.

Synopsis

 
asadmin [asadmin-options] delete-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 delete-config-property deletes the record of a MicroProfile Configuration property in one of the built-in config 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 instance where the property is stored.

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.

--propertyName: The name of the configuration property to delete. --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 or module --moduleName: The name of the module when the source is of type module.

+ When this is specified, the sourceName 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 Setting the configuration property value

This example deletes the JMSBrokerURL property from the configuration source named myApplication, belonging to the module myModule, and targeting the myAppCluster cluster.

 
asadmin delete-config-property --propertyName=JMSBrokerURL --source=module --sourceName=myApplication --moduleName=myModule --target=myAppCluster

Exit Status

0: subcommand executed successfully 1: error in executing the subcommand

See Also