## Attributes (18)

- boot-class-path - The boot class path that is used by the bootstrap class loader to search for class files. If attribute "boot-class-path-supported" is "false" or if a security manager is installed and the caller does not have ManagementPermission("monitor"), 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 boot class path that is used by the bootstrap class loader to search for class files. If attribute \"boot-class-path-supported\" is \"false\" or if a security manager is installed and the caller does not have ManagementPermission(\"monitor\"), 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-constraints" : {"sensitive" : {"jvm" : {"type" : "core"}}},
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- boot-class-path-supported - Whether the Java virtual machine supports the boot class path mechanism used by the bootstrap class loader to search for class files.

  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 the Java virtual machine supports the boot class path mechanism used by the bootstrap class loader to search for class files.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"jvm" : {"type" : "core"}}},
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- class-path - The Java class path that is used by the system class loader to search for class files. If a security manager is installed and it does not allow access to system property "java.class.path", 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 Java class path that is used by the system class loader to search for class files. If a security manager is installed and it does not allow access to system property \"java.class.path\", 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-constraints" : {"sensitive" : {"jvm" : {"type" : "core"}}},
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- input-arguments - The input arguments passed to the Java virtual machine which does not include the arguments to the main method. If a security manager is installed and the caller does not have ManagementPermission("monitor"), 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 | LIST
  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" : "LIST"
          },
          "description" : "The input arguments passed to the Java virtual machine which does not include the arguments to the main method. If a security manager is installed and the caller does not have ManagementPermission(\"monitor\"), 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" : 0,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"jvm" : {"type" : "core"}}},
          "value-type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- library-path - The Java library path. If a security manager is installed and it does not allow access to system property "java.library.path", 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 Java library path. If a security manager is installed and it does not allow access to system property \"java.library.path\", 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-constraints" : {"sensitive" : {"jvm" : {"type" : "core"}}},
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- management-spec-version - The version of the specification for the management interface implemented by the running Java virtual machine.

  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 version of the specification for the management interface implemented by the running Java virtual machine.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- name - The name representing the running Java virtual machine.

  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 the running Java virtual machine.",
          "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
      }

- pid - The process ID representing the running Java virtual machine.

  Type | LONG
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The process ID representing the running Java virtual machine.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- spec-name - The Java virtual machine specification name. If a security manager is installed and it does not allow access to system property "java.vm.specification.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 Java virtual machine specification name. If a security manager is installed and it does not allow access to system property \"java.vm.specification.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
      }

- spec-vendor - The Java virtual machine specification vendor. If a security manager is installed and it does not allow access to system property "java.vm.specification.vendor", 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 Java virtual machine specification vendor. If a security manager is installed and it does not allow access to system property \"java.vm.specification.vendor\", 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
      }

- spec-version - The Java virtual machine specification version. If a security manager is installed and it does not allow access to system property "java.vm.specification.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 Java virtual machine specification version. If a security manager is installed and it does not allow access to system property \"java.vm.specification.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
      }

- start-time - The start time of the Java virtual machine in milliseconds.

  Type | LONG
  Unit | MILLISECONDS
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The start time of the Java virtual machine in milliseconds.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "unit" : "MILLISECONDS",
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- system-properties - A map of names and values of all system properties. If a security manager is installed and its "checkPropertiesAccess" method does not allow access to system properties, 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 | OBJECT
  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" : "OBJECT"
          },
          "description" : "A map of names and values of all system properties. If a security manager is installed and its \"checkPropertiesAccess\" method does not allow access to system properties, 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,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"system-property" : {"type" : "core"}}},
          "value-type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- uptime - The uptime of the Java virtual machine in milliseconds.

  Type | LONG
  Unit | MILLISECONDS
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The uptime of the Java virtual machine in milliseconds.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "unit" : "MILLISECONDS",
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- vm-name - The Java virtual machine implementation name. If a security manager is installed and it does not allow access to system property "java.vm.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 Java virtual machine implementation name. If a security manager is installed and it does not allow access to system property \"java.vm.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
      }

- vm-vendor - The Java virtual machine implementation vendor. If a security manager is installed and it does not allow access to system property "java.vm.vendor", 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 Java virtual machine implementation vendor. If a security manager is installed and it does not allow access to system property \"java.vm.vendor\", 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
      }

- vm-version - The Java virtual machine implementation version. If a security manager is installed and it does not allow access to system property "java.vm.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 Java virtual machine implementation version. If a security manager is installed and it does not allow access to system property \"java.vm.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
      }