Export-CacheConfiguration
This PowerShell cmdlet enables the user to copy and archive the configuration of the specified cache. It is a critical tool for environment replication, disaster recovery planning, and migrating cache settings across servers. Additionally, it exports the deployed server-side modules to a target directory.
Note
This feature is also available in the NCache Open Source edition, please keep in mind that NCache Open Source has different parameters in some cmdlet instances.
Export-CacheConfiguration -Name -Path -Server [-Port] [-DoNotExportModule] [-NoLogo] [-Credentials]
Examples
- This command generates the configuration file and exports the deployed server-side modules for the demoCache in the specified directory for full environment replication.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config.xml
- This command uses port to generate the configuration file and exports the deployed server-side modules for the demoCache in the specified directory.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config.xml -Port 8250
- This command generates the complete configuration file for demoCache in only the specified directory.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config.xml -DoNotExportModule
- This command generates the configuration file and exports the deployed server-side modules for the demoCache in the specified directory, using the provided security credentials for authentication.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config.xml -Credentials(Get-Credential john_smith)
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
| Parameters | Data Types | Description | Default Value |
|---|---|---|---|
-Name* |
<String> |
Specifies the name of the cache for which the configuration file is to be generated. Note: The cache must already exist on the source server. |
- |
-Path* |
<String> |
Specifies the path where the user wants the configuration file to be placed after generation. In case of no path provided, the user will be prompted to provide one. | - |
-Server* |
<String> |
Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. | - |
-Port |
<Integer> |
Specifies the server port where the NCache Service is listening. | 8250 |
-DoNotExportModule |
<SwitchParameter> |
This switch omits the export of server-side modules, allowing users to customize cache configuration exports based on specific requirements. | False |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user who has appropriate permissions at the node. | - |
