How to: Edit Cluster Configuration Settings (Velocity)

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

In Microsoft project code named "Velocity," there are several options available for specifying cluster configuration settings. The PowerShell-based cache administration tool provides cmdlets for directly editing the cache cluster configuration. You can also edit the cluster configuration settings in XML. This topic describes your options and provides an overview of the steps required to make those changes.

The cluster configuration settings specify how the cluster itself, the named caches, and the cache hosts will work. For more information about the cluster configuration settings that are available, see Cluster Configuration Settings (Velocity).

PowerShell offers the Export-CacheClusterConfig and Import-CacheClusterConfig commands for making cluster configuration changes in XML. You can also use the Set-CacheConfig command to directly edit the cluster configuration settings in PowerShell.

Using any of these commands requires that your cache cluster must be restarted for the changes to take effect. There are other ways of making named cache configuration changes. For more information, see How to: Edit Cache Configuration Settings with PowerShell (Velocity).

Note

When using the Export-CacheClusterConfig and Import-CacheClusterConfig commands to change cluster configuration settings, adding or removing named caches and cache hosts by inserting or removing XML elements is not supported. To add or remove named caches or cache hosts, use the PowerShell cache administration tool and the "Velocity" installer. For more information about the PowerShell cache administration commands, see Cache Administration with PowerShell (Velocity).

The following procedures assume that you have a running cache cluster.

Editing cluster configuration changes in XML

  1. From the PowerShell-based cache administration tool, export the cluster configuration settings with the Export-CacheClusterConfig command. For more information about using PowerShell, see Cache Administration with PowerShell (Velocity).

  2. Open the XML-based cluster configuration file that was exported in the previous step.

  3. Locate and edit the attributes of the cluster configuration settings that you would like to change. Adding or removing host or cache elements is not supported.

  4. Save the XML-based cluster configuration file that was edited.

  5. Stop the cache cluster if it is running with the Stop-CacheCluster. Note: this will flush all data out of the cache cluster.

  6. Use the Import-CacheClusterConfig command to import the XML-based cluster configuration file that was edited in step 3.

  7. Start the cache cluster with the Start-CacheCluster command for the new configuration settings to take effect.

Editing cluster configuration changes with PowerShell directly

  1. Use the Get-CacheConfig or Export-CacheClusterConfig commands to view the current cluster configuration settings.

  2. Determine which settings you would like to change for the cache host or named cache. To minimize downtime of the cache cluster, we suggest preparing the corresponding Set-CacheCluster command(s) before proceeding.

  3. Stop the cache cluster if it is running with the Stop-CacheCluster. Note: This will flush all data out of the cache cluster.

  4. Use the Set-CacheCluster command to make the desired cache host or named cache configuration changes.

  5. Start the cache cluster with the Start-CacheCluster command for the new configuration settings to take affect.

See Also

Tasks

How to: Set the Cluster Management Role and Lead Host Designations (Velocity)
How to: Edit Cache Configuration Settings with PowerShell (Velocity)

Concepts

Configuration (Velocity)

Other Resources

Cache Concepts (Velocity)
Configuring the Cache Cluster (Velocity)
Configuring the Cache Client with XML (Velocity)
Using Configuration Methods (Velocity)