## Attributes (16)

- arch - The operating system architecture. If a security manager is installed and it does not allow access to system property "os.arch", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

  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 operating system architecture. If a security manager is installed and it does not allow access to system property \"os.arch\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".",
          "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
      }

- available-processors - The number of processors available to the Java virtual machine.

  Type | INT
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The number of processors available to the Java virtual machine.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 committed-virtual-memory-size - The amount of virtual memory that is guaranteed to be available to the running process in bytes, or -1 if this operation is not supported.

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The amount of virtual memory that is guaranteed to be available to the running process in bytes, or -1 if this operation is not supported.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 cpu-load - Returns the "recent cpu usage" for the operating environment.

  Type | DOUBLE
  Unit | PERCENTAGE
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "DOUBLE"
          },
          "description" : "Returns the \"recent cpu usage\" for the operating environment.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "PERCENTAGE",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 free-memory-size - The amount of free memory in bytes.

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The amount of free memory in bytes.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 free-swap-space-size - The amount of free swap space in bytes.

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The amount of free swap space in bytes.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 max-file-descriptor-count - The maximum number of file descriptors.

  Type | LONG
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The maximum number of file descriptors.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- name - The operating system name. If a security manager is installed and it does not allow access to system property "os.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

  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 operating system name. If a security manager is installed and it does not allow access to system property \"os.name\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".",
          "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
      }

- 🅲 open-file-descriptor-count - The number of open file descriptors.

  Type | LONG
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The number of open file descriptors.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 process-cpu-load - The "recent cpu usage" for the Java Virtual Machine process.

  Type | DOUBLE
  Unit | PERCENTAGE
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "DOUBLE"
          },
          "description" : "The \"recent cpu usage\" for the Java Virtual Machine process.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "PERCENTAGE",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 process-cpu-time - The CPU time used by the process on which the Java virtual machine is running in nanoseconds.

  Type | LONG
  Unit | NANOSECONDS
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The CPU time used by the process on which the Java virtual machine is running in nanoseconds.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "NANOSECONDS",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- system-load-average - The system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.

  Type | DOUBLE
  Unit | PERCENTAGE
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "DOUBLE"
          },
          "description" : "The system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "unit" : "PERCENTAGE",
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 total-memory-size - The total amount of memory in bytes.

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The total amount of memory in bytes.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- 🅲 total-swap-space-size - The total amount of swap space in bytes.

  Type | LONG
  Unit | BYTES
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | community
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The total amount of swap space in bytes.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "unit" : "BYTES",
          "stability" : "community",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- version - The operating system version. If a security manager is installed and it does not allow access to system property "os.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

  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 operating system version. If a security manager is installed and it does not allow access to system property \"os.version\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".",
          "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
      }