Write-attribute

From NovaOrdis Knowledge Base
Revision as of 04:32, 16 November 2016 by Ovidiu (talk | contribs) (→‎Changing the Value of a Known Attribute)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Internal

Overview

Sets the value of an attribute for the selected resource. The value may be null if the underlying model supports null values.

If the attribute does not exist, but it is a known attribute to the management resource, it is created and assigned to the given value.

If the attribute does not exist and it is not a known attribute to the management resource, the operation fails with "outcome" => "failed" and description "JBAS014792: Unknown attribute ..."

If the attribute exists, the current value is overwritten.

Syntax

:write-attribute(name="..."[, value="..."])

Use Cases

Adding a Known Attribute

Add an "autoflush" configuration to a logging file handler:

/subsystem=logging/file-handler=TEST:write-attribute(name="autoflush", value="true")

Because it is a known attribute of the management node, the attribute will be added if it does not exist, or its value overwritten if it exists.

Changing the Value of a Known Attribute

Use the same syntax as in the above example.

There are situations where the an attribute added as such is expanded into a different layout. See the logging handler format case.

Removing an Attribute

Use the following syntax to remove an attribute:

:write-attribute(name="socket-binding")

socket-binding will be removed from the current node.

If the management resource is listed in CLI, the "removed" attribute shows as "undefined":

...  socket-binding=undefined ...