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

# CacheManagerService

## Realm Operations

Resource path:

```
/realm-config/services/cache-manager
```

Resource version: `0.0`

### create

**Usage**

```
am> create CacheManagerService --realm Realm --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "enabled" : {
        "title" : "Enabled",
        "description" : "Enable or disable the Cache Manager Service, if disabled all cache sizes will be set to zero so that each entry will be reloaded each time it is requested.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete CacheManagerService --realm Realm
```

### getAllTypes

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

**Usage**

```
am> action CacheManagerService --realm Realm --actionName getAllTypes
```

### getCreatableTypes

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

**Usage**

```
am> action CacheManagerService --realm Realm --actionName getCreatableTypes
```

### nextdescendents

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

**Usage**

```
am> action CacheManagerService --realm Realm --actionName nextdescendents
```

### read

**Usage**

```
am> read CacheManagerService --realm Realm
```

### update

**Usage**

```
am> update CacheManagerService --realm Realm --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "enabled" : {
        "title" : "Enabled",
        "description" : "Enable or disable the Cache Manager Service, if disabled all cache sizes will be set to zero so that each entry will be reloaded each time it is requested.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/services/cache-manager
```

Resource version: `1.0`

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read CacheManagerService --global
```

### update

**Usage**

```
am> update CacheManagerService --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "maxMemoryPerEntry" : {
        "title" : "Maximum memory per entry (KB)",
        "description" : "Defines the maximum amount of memory (in kilobytes) that each cache entry is allowed to consume.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "maxMemoryPerRealm" : {
        "title" : "Maximum memory per realm (MB)",
        "description" : "Defines the maximum amount of memory (in megabytes) that each realm is allowed to consume.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "secureRemovalEnabled" : {
        "title" : "Securely remove entries",
        "description" : "Enables or disables zeroisation of memory relating to entries upon their removal. This ensures that entries are securely removed.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "defaults" : {
        "properties" : {
          "enabled" : {
            "title" : "Enabled",
            "description" : "Enable or disable the Cache Manager Service, if disabled all cache sizes will be set to zero so that each entry will be reloaded each time it is requested.",
            "propertyOrder" : 100,
            "required" : true,
            "type" : "boolean",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```