Set-AFCacheConfiguration

Article
09/12/2012

Set-AFCacheConfiguration

Updates the configuration settings for a cache.

Syntax

Parameter Set: Default
Set-AFCacheConfiguration [-CacheName] <String> [-Eviction <String> ] [-Expirable <String> ] [-Force] [-MinSecondaries <Int32> ] [-NotificationsEnabled <String> ] [-ReadThroughEnabled <String> ] [-RefreshNow] [-RtwbProviderSettings <Hashtable> ] [-RtwbProviderType <String> ] [-Secondaries <Int32> ] [-TimeToLiveMins <Int64> ] [-WriteBehindEnabled <String> ] [-WriteBehindIntervalSec <Int32> ] [-WriteBehindRetryCount <Int32> ] [-WriteBehindRetryIntervalSec <Int32> ] [ <CommonParameters>]

Parameters

-CacheName<String>

The name of the cache.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Eviction<String>

The value of LRU enables Least Recently Used eviction. A value of None disables eviction. Warning: a value of None may cause a cache host to run out of memory.

LRU

None

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Expirable<String>

Specifies whether items in the cache are expirable.

true

false

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

The Force parameter prevents the user from being prompted for confirmation. This only applies if the Secondaries option has been changed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MinSecondaries<Int32>

The minimum number of secondary copies of an item required for write operations on that item to succeed. This setting can be 0 or 1. A value of 1 indicates that the secondary copy of the item must also be persisted for the write operation to succeed, and it requires high availability to be enabled (Secondaries = 1). Read operations are not affected by this setting and never require the existence of the secondary replica. The default value is 0. Applies to AppFabric 1.1 for Windows Server only.

Aliases	none
Required?	false
Position?	named
Default Value	0
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NotificationsEnabled<String>

Use this parameter to enable notifications on the cache.

true

false

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ReadThroughEnabled<String>

Use this parameter to enable the read-through feature. By default this is set to false. Applies to AppFabric 1.1 for Windows Server only.

true

false

Aliases	none
Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RefreshNow

Allows the update of specific cache configuration settings to succeed while the cache cluster is running. Currently, the write-behind and read-through settings are the only ones that can be changed on a running cache cluster. All other updates require stopping the cache cluster or recreating the cache. Applies to AppFabric 1.1 for Windows Server only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RtwbProviderSettings<Hashtable>

One or more key/value pairs that specify connection information for the provider. For example: @{"setting1"="value1";"setting2"="value2"}. Applies to Microsoft AppFabric 1.1 for Windows Server only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RtwbProviderType<String>

The fully qualified name of the provider assembly type. This provider implements the write-behind and read-through features. The name is case-sensitive. For example: “RTProvider.Provider, RTProvider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=80e2cb5f6ba933f0”. Applies to Microsoft AppFabric 1.1 for Windows Server only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Secondaries<Int32>

A value of 1 enables the high availability feature. A value of 0 disables the high availability feature. The default value is 0.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TimeToLiveMins<Int64>

The expiration timeout minutes for items in the cache.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WriteBehindEnabled<String>

Use this parameter to enable the write behind feature. By default, this is set to false. Applies to AppFabric 1.1 for Windows Server only.

true

false

Aliases	none
Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WriteBehindIntervalSec<Int32>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WriteBehindRetryCount<Int32>

The maximum number of connection retries to the write-behind provider. The default is -1, which means inifinite retries. Applies to AppFabric 1.1 for Windows Server only.

Aliases	none
Required?	false
Position?	named
Default Value	-1
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WriteBehindRetryIntervalSec<Int32>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Outputs

The output type is the type of the objects that the cmdlet emits.

Microsoft.Data.Caching.Commands.CacheConfig

Examples

PS C:\>

Get-AFCacheConfiguration

Set-AFCacheConfiguration