LATEST VERSION: 8.2.5 - CHANGELOG
Pivotal GemFire® v8.2

alter

alter

Modify an existing GemFire resource.

alter disk-store

Modify configuration options for a specified region or remove a region from an offline disk-store.

You can also use the command to reset specific configuration attributes of the disk-store to their default values. For example, you could use alter disk-store command to set the region's LRU action to overflow-to-disk.

Availability: Offline.

Syntax:
alter disk-store --name=value --region=value --disk-dirs=value(,value)*
    [--lru-algorthm=value] [--lru-action=value] [--lru-limit=value]
    [--concurrency-level=value] [--initial-capacity=value] [--load-factor=value]
    [--compressor(=value)?] [--enable-statistics=value] [--remove(=value)?]
Name Description Default Value
--name Required. Name of the disk-store whose contents will be altered.  
--region Required. Name (including path) of the region using the disk store.  
--disk-dirs Required. Directories where the data for the disk store was previously written.  
--lru-algorthm Least recently used eviction algorithm. Valid types are:
  • none
  • lru-entry-count
  • lru-heap-percentage
  • lru-memory-size
 
--lru-action Action to take when evicting entries from the region. Valid values are:
  • none
  • overflow-to-disk
  • local-destroy
 
--lru-limit Number of entries allowed in the region before eviction occurs.  
--concurrency-level An estimate of the maximum number of application threads that will concurrently access a region entry. This attribute does not apply to partitioned regions.  
--initial-capacity Together with --load-factor, sets the parameters on the underlying java.util.ConcurrentHashMap used for storing region entries.  
--load-factor Together with --initial-capacity, sets the parameters on the underlying java.util.ConcurrentHashMap used for storing region entries. This must be a floating point number between 0 and 1, inclusive.  
--compressor The fully-qualifed class name of the compressor to use when compressing region entry values. A value of none removes the compressor. none
--enable-statistics Enables statistics for the region. Valid values are true or false. false
--remove Specifies whether to remove the region from the disk-store. If the parameter is specified without a value, the value of true is used. false
Example Commands:
alter disk-store --name=DiskStore1 --region=region1 --disk-dirs=/Disks/DiskStore1
alter disk-store --name=DiskStore1 --region=region1 --disk-dirs=/Disks/DiskStore1 --remove

alter region

Alters the configuration of a region.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:
alter region --name=value [--group=value(,value)*]
    [--entry-idle-time-expiration(=value)?]
    [--entry-idle-time-expiration-action(=value)?]
    [--entry-time-to-live-expiration(=value)?]
    [--entry-time-to-live-expiration-action(=value)?]
    [--region-idle-time-expiration(=value)?]
    [--region-idle-time-expiration-action(=value)?]
    [--region-time-to-live-expiration(=value)?]
    [--region-time-to-live-expiration-action(=value)?]
    [--cache-listener=value(,value)*] [--cache-loader(=value)?]
    [--cache-writer(=value)?] [--async-event-queue-id=value(,value)*]
    [--gateway-sender-id=value(,value)*] [--enable-cloning(=value)?]
    [--eviction-max(=value)?]
Table 1. Parameters
Name Description Default Value
--async-event-queue-id IDs of the Async Event Queues that will be used for write-behind operations.  
--cache-listener Fully qualified class name of a plug-in to be instantiated for receiving after-event notification of changes to the region and its entries. Any number of cache listeners can be configured.  
--cache-loader Fully qualified class name of a plug-in to be instantiated for receiving notification of cache misses in the region. At most, one cache loader can be defined in each member for the region. For distributed regions, a cache loader may be invoked remotely from other members that have the region defined. __DEFAULT__
--cache-writer Fully qualified class name of a plug-in to be instantiated for receiving before-event notification of changes to the region and its entries. The plug-in may cancel the event. At most, one cache writer can be defined in each member for the region __DEFAULT__
--enable-cloning

Determines how fromDelta applies deltas to the local cache for delta propagation. When true, the updates are applied to a clone of the value and then the clone is saved to the cache. When false, the value is modified in place in the cache.

false
--entry-idle-time-expiration Number of seconds before a region or an entry expires. Specify -1 to indicate that there is no expiration of this type -1
--entry-idle-time-expiration-action Action that should take place when a region or an entry expires.
Select one of the following expiration actions:
local-destroy Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.
destroy Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.
invalidate Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.
local-invalidate Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.
__DEFAULT__
--entry-time-to-live-expiration Number of seconds before a region or an entry expires. Specify -1 to indicate that there is no expiration of this type. -1
--entry-time-to-live-expiration-action Action that should take place when a region or an entry expires.
Select one of the following expiration actions:
local-destroy Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.
destroy Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.
invalidate Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.
local-invalidate Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.
__DEFAULT__
--eviction-max Maximum value for the Eviction Attributes that the eviction algorithm uses to determine when to perform its eviction action. The unit of the maximum value is determined by the Eviction Algorithm. 0
--gateway-sender-id IDs of the Gateway Senders where data is routed.  
--group Group(s) of members where the region will be altered.  
--name Required. Name (including path) of the region.  
--region-idle-time-expiration Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration). -1
--region-idle-time-expiration-action Action that should take place when a region or an entry expires.
Select one of the following expiration actions:
local-destroy Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.
destroy Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.
invalidate Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.
local-invalidate Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.
__DEFAULT__
--region-time-to-live-expiration Number of seconds before a region or an entry expires. If timeout is not specified, it defaults to zero (which means no expiration). -1
--region-time-to-live-expiration-action Action that should take place when a region or an entry expires.
Select one of the following expiration actions:
local-destroy Removes the region or entry from the local cache, but does not distribute the removal operation to remote members. You cannot use this action on partitioned region entries.
destroy Removes the region or entry completely from the cache. Destroy actions are distributed according to the region's distribution settings. Use this option when the region or entry is no longer needed for any application in the distributed system.
invalidate Default expiration action. Marks an entry or all entries in the region as invalid. Distributes the invalidation according to the region's scope. This is the proper choice when the region or the entry is no longer valid for any application in the distributed system.
local-invalidate Marks an entry or all entries in the region as invalid but does not distribute the operation. You cannot use this action on partitioned region entries. Local region invalidation is only supported for regions that are not configured as replicated regions.
__DEFAULT__
Example Commands:
alter region --name=region1 --eviction-max=5000 [-group=all]

Sample Output:

gfsh>alter region --name=customer --eviction-max=5000
Member  | Status
------- | ----------------------------------
server1 | Region "/customer" altered on "server1"

alter runtime

Alters configuration properties for all members or a subset of members while the member or members are running.

For more information on these configuration properties, see gemfire.properties and gfsecurity.properties (GemFire Properties) and cache.xml.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:
alter runtime [--member=value] [--group=value] [--archive-disk-space-limit=value]
    [--archive-file-size-limit=value] [--log-disk-space-limit=value]
    [--log-file-size-limit=value] [--log-level=value]
    [--statistic-archive-file=value] [--statistic-sample-rate=value]
    [--enable-statistics=value] [--copy-on-read(=value)?] [--lock-lease=value]
    [--lock-timeout=value] [--message-sync-interval=value] [--search-timeout=value]
Table 2. Parameters
Name Description Default Value
--member Name or ID of the member whose configuration is to be altered at runtime. If you do not specify this parameter, the configuration properties are modified for all cluster members using the cluster configuration service. If not specified, all members using the cluster configuration service
--group Name of the group whose members's runtime configuration is to be altered. If you do not specify this parameter, the configuration properties are modified for all cluster members using the cluster configuration service. If not specified, all members using the cluster configuration service
--archive-disk-space-limit Archive disk space limit. Maximum size (in megabytes) of all inactive statistic archive files combined. If this limit is exceeded, inactive archive files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. Valid values are (in megabytes): 0 - 1000000. 0
--archive-file-size-limit Archive file size limit. The maximum size (in megabytes) of a single statistic archive file. Once this limit is exceeded, a new statistic archive file is created, and the current archive file becomes inactive. If set to zero, file size is unlimited. Valid values are (in megabytes): 0 - 1000000. 0
--log-disk-space-limit Log disk space limit. Maximum size in megabytes of all inactive log files combined. If this limit is exceeded, inactive log files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. Valid values are (in megabytes): 0 - 1000000. 0
--log-file-size-limit Log file size limit. Maximum size in megabytes of a log file before it is closed and logging rolls on to a new (child) log file. If set to zero, log rolling is disabled. Valid values are (in megabytes): 0 - 1000000. 0
--log-level Log level. Valid values are:
  • none
  • error
  • info
  • config
  • warning
  • severe
  • fine
  • finer
  • finest
config
--statistic-archive-file The file to which the running system member writes statistic samples. For example: "StatisticsArchiveFile.gfs". An empty string disables archiving. Adding .gz suffix to the file name causes it to be compressed. See Statistics. not set
--statistic-sample-rate Statistic sampling rate. Valid values are (in milliseconds): 100 - 60000. See Statistics. 1000
--enable-statistics Whether statistic sampling should be enabled. Valid values are: true and false. See Statistics. false
--copy-on-read True or false. Sets the "copy on read" feature for cache read operations. See Safe Entry Modification. false
--lock-lease Sets the length, in seconds, of distributed lock leases obtained by this cache. See Setting Cache Timeouts. 120
--lock-timeout Sets the number of seconds a cache operation may wait to obtain a distributed lock lease before timing out. See Setting Cache Timeouts. 60
--message-sync-interval Sets the frequency (in seconds) at which a message will be sent by the primary cache-server node to all the secondary cache-server nodes to remove the events which have already been dispatched from the queue. See Change Server Queue Synchronization Frequency. 1
--search-timeout Sets the number of seconds a cache get operation can spend searching for a value. See Setting Cache Timeouts. 300
Example Commands:
alter runtime --member=server1 --log-level=finest --enable-statistics=true
Sample Output:
gfsh>alter runtime --member=server1 --log-level=finest --enable-statistics=true
Runtime configuration altered successfully for the following member(s)
192.168.129.129(server1:240)<v1>:64871