## Attributes (16)

- collection-usage - The memory usage after the Java virtual machine most recently expended effort in recycling unused objects in this memory pool, or "undefined" if this attribute is not supported.

  Type | OBJECT
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "OBJECT"
          },
          "description" : "The memory usage after the Java virtual machine most recently expended effort in recycling unused objects in this memory pool, or \"undefined\" if this attribute is not supported.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "value-type" : {
              "init" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "used" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of used memory in bytes.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "committed" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of memory in bytes that is committed for the Java virtual machine to use.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "max" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The maximum amount of memory in bytes that can be used for memory management.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              }
          },
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- collection-usage-threshold - The collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | read-write
  Is restarted required? | no-services
  Min | 0
  Max | 2147483647
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If \"collection-usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "min" : 0,
          "max" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "runtime",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- collection-usage-threshold-count - The number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

  Type | LONG
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If \"collection-usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- collection-usage-threshold-exceeded - Whether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

  Type | BOOLEAN
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If \"collection-usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- collection-usage-threshold-supported - Whether this memory pool supports a collection usage threshold.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether this memory pool supports a collection usage threshold.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- memory-manager-names - The names of the memory managers that manage this memory pool.

  Type | LIST
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LIST"
          },
          "description" : "The names of the memory managers that manage this memory pool.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "min-length" : 0,
          "max-length" : 2147483647,
          "stability" : "default",
          "value-type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- name - The name representing this memory pool.

  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" : "The name representing this memory pool.",
          "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
      }

- 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
      }

- peak-usage - The peak memory usage of this memory pool since the Java virtual machine was started or since the peak was reset. May be "undefined" if attribute "valid" is "false".

  Type | OBJECT
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "OBJECT"
          },
          "description" : "The peak memory usage of this memory pool since the Java virtual machine was started or since the peak was reset. May be \"undefined\" if attribute \"valid\" is \"false\".",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "value-type" : {
              "init" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "used" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of used memory in bytes.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "committed" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of memory in bytes that is committed for the Java virtual machine to use.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "max" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The maximum amount of memory in bytes that can be used for memory management.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              }
          },
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- type - The type of this memory pool.

  Type | STRING
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The type of this memory pool.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- usage - An estimate of the memory usage of this memory pool. May be "undefined" if attribute "valid" is "false".

  Type | OBJECT
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "OBJECT"
          },
          "description" : "An estimate of the memory usage of this memory pool. May be \"undefined\" if attribute \"valid\" is \"false\".",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "value-type" : {
              "init" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "used" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of used memory in bytes.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "committed" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The amount of memory in bytes that is committed for the Java virtual machine to use.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              },
              "max" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The maximum amount of memory in bytes that can be used for memory management.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "BYTES",
                  "stability" : "default"
              }
          },
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- usage-threshold - The usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | read-write
  Is restarted required? | no-services
  Min | 0
  Max | 2147483647
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If \"usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "min" : 0,
          "max" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "runtime",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- usage-threshold-count - The number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

  Type | LONG
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If \"usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- usage-threshold-exceeded - Whether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

  Type | BOOLEAN
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether the memory usage of this memory pool reaches or exceeds its usage threshold value.  A memory pool may not support a usage threshold. If \"usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- usage-threshold-supported - Whether this memory pool supports usage threshold.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether this memory pool supports usage threshold.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- valid - Whether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

## Operations (2)

- 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
      }

- reset-peak-usage - Resets the peak memory usage statistic of this memory pool to the current memory usage.

  Raw DMR model |
      {
          "operation-name" : "reset-peak-usage",
          "description" : "Resets the peak memory usage statistic of this memory pool to the current memory usage.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }