---
title: Monitoring
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-monitoring
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-monitoring.html
section_ids:
  sec-amster-entity-monitoring-global-ops: Global Operations
  sec-amster-entity-monitoring-global-ops-getalltypes: getAllTypes
  sec-amster-entity-monitoring-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-monitoring-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-monitoring-global-ops-read: read
  sec-amster-entity-monitoring-global-ops-update: update
---

# Monitoring

## Global Operations

Resource path:

```
/global-config/services/monitoring
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action Monitoring --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action Monitoring --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action Monitoring --global --actionName nextdescendents
```

### read

**Usage**

```
am> read Monitoring --global
```

### update

**Usage**

```
am> update Monitoring --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "enabled" : {
        "title" : "Monitoring Status",
        "description" : "Enable / Disable the monitoring system",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "policyHistoryWindowSize" : {
        "title" : "Policy evaluation monitoring history size",
        "description" : "Size of the window of most recent policy evaluations to record to expose via monitoring system. Valid range is 100 - 1000000.",
        "propertyOrder" : 900,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "rmiEnabled" : {
        "title" : "Monitoring RMI interface status",
        "description" : "Enable / Disable the JMX access to the monitoring system",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "httpEnabled" : {
        "title" : "Monitoring HTTP interface status",
        "description" : "Enable / Disable the HTTP access to the monitoring system ",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "rmiPort" : {
        "title" : "Monitoring RMI Port",
        "description" : "Port number for the JMX monitoring interface",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "httpPort" : {
        "title" : "Monitoring HTTP Port",
        "description" : "Port number for the HTTP monitoring interface",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "sessionHistoryWindowSize" : {
        "title" : "Session monitoring history size",
        "description" : "Size of the window of most recent session operations to record to expose via monitoring system. Valid range is 100 - 1000000.",
        "propertyOrder" : 1000,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "authfilePath" : {
        "title" : "Monitoring HTTP interface authentication file path",
        "description" : "Path to the monitoring system authentication file<br><br>The <code>openam_mon_auth</code> file contains the username and password of the account used to protect the monitoring interfaces. The default username is <code>demo</code> with a password of <code>changeit</code>. Use the <code>ampassword</code> command to encrypt a new password.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```