Management API Reference for type=platform-logging

Attributes (2)

• 🅲  logger-names - The list of the currently registered logger names.

  Type	LIST
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	community
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The list of the currently registered logger names.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "community", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• object-name - String representation the object name of this platform managed object.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "String representation the object name of this platform managed object.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (1)

• read-resource - Reads a model resource's attribute values along with either basic or complete information about any child resources

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  recursive	BOOLEAN	false	false		Whether to include complete information about child resources, recursively. If absent, false is the default
  recursive-depth	INT	false	false		The depth to which information about child resources should be included.
  proxies	BOOLEAN	false	false	false	Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.
  include-runtime	BOOLEAN	false	false	false	Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.
  include-defaults	BOOLEAN	false	false	true	Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.
  attributes-only	BOOLEAN	false	false	false	Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.
  include-aliases	BOOLEAN	false	false	false	If 'true' and recursive, include children which are aliases.
  include-undefined-metric-values	BOOLEAN	false	false	false	Whether to include undefined metric values. If the underlying metric value can not be computed, this flag ensures that the value will remain undefined (without being replaced by a possible 'undefined metric value' from the attribute definition.

  Reply properties

  The resource's attribute values along with information about any child resources

  Type

  OBJECT

  Raw DMR model

  { "operation-name" : "read-resource", "description" : "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" : { "recursive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "recursive-depth" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The depth to which information about child resources should be included.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min" : 0, "max" : 2147483647, "stability" : "default" }, "proxies" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-runtime" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-defaults" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "attributes-only" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-aliases" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' and recursive, include children which are aliases.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-undefined-metric-values" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include undefined metric values. If the underlying metric value can not be computed, this flag ensures that the value will remain undefined (without being replaced by a possible 'undefined metric value' from the attribute definition.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The resource's attribute values along with information about any child resources" }, "stability" : "default", "read-only" : true, "runtime-only" : false }