Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs of the set command #24973

Merged
merged 2 commits into from
May 30, 2024
Merged

Update docs of the set command #24973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07b7ee7
Update docs of the set command
OndroMih May 27, 2024
0032e4d
Set command docs: Removed misleading comma, improved wording
OndroMih May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/reference-manual/src/main/asciidoc/set.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,18 @@ set
set
---

Sets the values of configurable attributes
Sets or deletes the values of configurable attributes

=== Synopsis

[source]
----
asadmin [asadmin-options] set [--help]
attribute-name=value
asadmin [asadmin-options] set [--help] attribute-name=value [attribute-name=value]
----

=== Description

The `set` subcommand uses dotted names to modify the values of one or
The `set` subcommand uses dotted names to modify or delete the values of one or
more configurable attributes.

Attributes from the monitoring hierarchy are read-only, but
Expand Down Expand Up @@ -70,8 +69,10 @@ asadmin-options::

=== Operands

attribute-name=value::
Identifies the full dotted name of the attribute name and its value.
attribute-name=value [attribute-name=value]::
Identifies the full dotted name of the attribute name and its value.
Multiple attribute=value pairs can be provided as multiple arguments, separated by a space.
To delete a value, set the value to an empty value, e.g. `attribute-name=`

=== Examples

Expand All @@ -92,11 +93,11 @@ Command set executed successfully.

==== Example 2   Enabling the Monitoring Service for a Monitorable Object

This example enables monitoring for the JVM.
This example enables monitoring for the JVM and Thread-Pool modules.

[source]
----
asadmin> set server.monitoring-service.module-monitoring-levels.jvm=HIGH
asadmin> set server.monitoring-service.module-monitoring-levels.jvm=HIGH server.monitoring-service.module-monitoring-levels.thread-pool=HIGH
Command set executed successfully.
----

Expand Down
15 changes: 8 additions & 7 deletions nucleus/core/kernel/src/main/manpages/com/sun/enterprise/v3/admin/set.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
set(1) asadmin Utility Subcommands set(1)

NAME
set - sets the values of configurable attributes
set - sets or deletes the values of configurable attributes

SYNOPSIS
set [--help] attribute-name=value
set [--help] attribute-name=value [attribute-name=value]

DESCRIPTION
The set subcommand uses dotted names to modify the values of one or
The set subcommand uses dotted names to modify or delete the values of one or
more configurable attributes.

Attributes from the monitoring hierarchy are read-only, but
Expand Down Expand Up @@ -52,9 +52,10 @@ OPTIONS
Displays the help text for the subcommand.

OPERANDS
attribute-name=value
attribute-name=value [attribute-name=value]
Identifies the full dotted name of the attribute name and its
value.
value. Multiple attribute=value pairs can be provided as multiple arguments, separated by a space.
To delete a value, set the value to an empty value, e.g. attribute-name=

EXAMPLES
Example 1, Setting a JDBC Connection Pool Attribute
Expand All @@ -65,9 +66,9 @@ EXAMPLES
Command set executed successfully.

Example 2, Enabling the Monitoring Service for a Monitorable Object
This example enables monitoring for the JVM.
This example enables monitoring for the JVM and Thread-Pool modules.

asadmin> set server.monitoring-service.module-monitoring-levels.jvm=HIGH
asadmin> set server.monitoring-service.module-monitoring-levels.jvm=HIGH server.monitoring-service.module-monitoring-levels.thread-pool=HIGH
Command set executed successfully.

Example 3, Turning on Automatic Recovery for the Transaction Service
Expand Down