pub.cache.admin:disableCache
WmPublic. Disables a cache.
Input Parameters
cacheManagerName | String Name of the cache manager that manages the cache. This parameter is case sensitive. |
cacheName | String Name of the cache to disable. This parameter is case sensitive. |
Output Parameters
status | String The status indicating either Error or Success. |
message | String The status message. |
Usage Notes
Note:
Only users with administrator privileges can execute this service.
When you disable a cache, the cached elements are unavailable for cache operations but still present in the cache. Use the
pub.cache.admin:enableCache service to make the disabled cached elements available again.
You cannot disable caches managed by system cache managers.
After the pub.cache.admin:disableCache service disables a cache, other services cannot add, modify, delete, or retrieve its contents. For example, calls to the pub.cache:get service will return null.
The disabled state of a cache lasts only for the lifetime of its cache manager. When the cache manager is restarted, either by restarting Integration Server or clicking the reload icon on the Settings > Caching page in Integration Server Administrator, the cache is enabled.
When you disable a cache, Integration Server:
Integration Server returns a status of Error in the following cases:
If the cache is managed by a system cache manager.
If you do not specify all required input parameters.
If
Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.