epadmin-cache

epadmin cache target — Manages named caches of managed objects.

SYNOPSIS

epadmin [globalparameters] command cache [commandparameters]

DESCRIPTION

Named caches provide a mechanism to control the amount of memory used to cache managed objects. Named caches are described in the Named Caches section of the Architecture Guide.

The cache target has five commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin add cache

Adds a new type to an existing named cache. 

epadmin [sn|ad] add cache --name=MyCache --type=managed.Type
Command Parameter Description Required
name Cache name. Yes.
type Fully scoped type name. Yes.

epadmin create cache

Creates a named cache, which are unique on a node. If the cache being created already exists, this command quietly does nothing. Newly created caches have an unlimited cache size. 

epadmin [sn|ad] create cache --name=MyCache
Command Parameter Description Required
name Cache name. Yes.

epadmin display cache

Displays information about named caches on a node. If name is not specified, information about all caches is displayed. 

epadmin [sn|ad] display cache
epadmin [sn|ad] display cache --name=MyCache
Command Parameter Description Required
name Cache name. No. No default value.

epadmin remove cache

Removes a named cache. All objects in the cache are restored to their default caching behavior. 

epadmin [sn|ad] remove cache --name=MyCache

remove command parameters

Command Parameter Description Required
name Cache name. Yes.

epadmin set cache

Sets or changes cache size. When changing a cache size, any required object flushing occurs asynchronously.

Cache sizes can be set as a percentage of total shared memory in the node, or as an absolute size. When setting the size using an absolute number, the following suffixes are supported:

  • None — size in bytes.

  • K — size in kilobytes.

  • M — size in megabytes.

  • G — size in gigabytes.

Percentage values are specified using the % suffix. 

epadmin [sn|ad] set cache --name=MyCache --size=0%    // Disables caching
epadmin [sn|ad] set cache --name=MyCache --size=100%  // Unlimited cache size
epadmin [sn|ad] set cache --name=MyCache --size=50%   // Size cache to 50% of node shared memory
epadmin [sn|ad] set cache --name=MyCache --size=0     // Disables caching
epadmin [sn|ad] set cache --name=MyCache --size=25000 // Set cache size to 25000 bytes
epadmin [sn|ad] set cache --name=MyCache --size=25K   // Set cache size to 25 kilobytes
epadmin [sn|ad] set cache --name=MyCache --size=2M    // Set cache size to 2 megabytes
epadmin [sn|ad] set cache --name=MyCache --size=1G    // Set cache size to 1 gigabyte
Command Parameter Description Required
name Cache name. Yes.
size Cache size — percentage of shared memory or an absolute value. Yes.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)