Remove-BackingSource
This PowerShell cmdlet removes the pre-configured backing source providers (Read-through or Write-through) from the cache. Once the provider is removed, the cache will no longer perform read or write operations through the specified provider.
Remove-BackingSource -CacheName [-NoLogo] `
[-Port] -ProviderName `
[-ReadThru] [-Server] `
[-TlsCertPath] [-TlsCertPassword] `
[-Credentials] [-WriteThru]
Examples
Important
Please note that either the ReadThru or WriteThru parameter must be specified when using this cmdlet.
- This command removes the pre-configured Read-through provider named MyReader from defaultCache.
Remove-BackingSource -CacheName defaultCache -ProviderName MyReader -ReadThru
- This command removes the pre-configured Write-through provider named MyWriter from defaultCache.
Remove-BackingSource -CacheName defaultCache -ProviderName MyWriter -WriteThru
- This command removes the pre-configured Write-through provider named MyWriter from defaultCache existing on server 20.200.20.11.
Remove-BackingSource -CacheName defaultCache -ProviderName MyWriter `
-WriteThru -Server 20.200.20.11
- This command removes the write-through provider MyWriter from defaultCache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses
C:\certs\client.pemto authenticate the machine running the cmdlet. The-TlsCertPasswordparameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Remove-BackingSource -CacheName defaultCache -ProviderName MyWriter `
-WriteThru -Server 20.200.20.11 `
-TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
- This command removes the pre-configured Read-through provider named MyReader from defaultCache using security credentials.
Remove-BackingSource -CacheName defaultCache -ProviderName MyReader `
-ReadThru -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 |
|---|---|---|---|
-CacheName* |
<String> |
Specifies the name of the cache for which backing source will be removed. NOTE: The cache must already exist on the source server. |
- |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
-Port |
<Integer> |
Specifies the port on which NCache Service is running. | 9803 |
-ProviderName* |
<String> |
Specifies the provider name. | - |
-ReadThru* |
<SwitchParameter> |
Specifies if provided backing source is configured for ReadThru. | False |
-Server |
<String> |
Specifies a server name where the NCache Service is running and a cache with a specified cache-name is registered. | IP of local machine |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. | - |
-TlsCertPath |
<string> |
Specifies the path to the client PEM certificate used to authenticate this cmdlet when the target NCache server requires Mutual TLS. This parameter is required for Mutual TLS connections even when the cmdlet runs on an NCache server. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. Relative paths are resolved against the current PowerShell location, and the file must exist. You can generate a client certificate using New-NCacheTlsCertificate. | - |
-TlsCertPassword |
<string> |
Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. |
- |
-WriteThru* |
<SwitchParameter> |
Specifies if provided backing source is configured for WriteThru. | False |