PingAM

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:

{
  "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:

{
  "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:

{
  "type" : "object",
  "properties" : {
    "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" : ""
    },
    "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" : ""
    },
    "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"
    }
  }
}