What does Remove-Cache do?

Remove-Cache removes an already registered cache from an NCache server or cluster.

Which parameter is required for Remove-Cache?

The Name parameter is required and specifies the registered cache that needs to be removed.

What is the default port for Remove-Cache?

The default value of the Port parameter is 9803.

Which server does Remove-Cache use by default?

If the Server parameter is not specified, the IP address of the local machine is used.

Remove-Cache

This PowerShell cmdlet enables the user to remove an already registered cache from an NCache server or cluster by unregistering it from the NCache service and permanently deleting its associated data. The Remove-Cache cmdlet requires the cache name and optionally supports specifying the target server, port, and credentials for secure clusters. Since the operation results in permanent data removal, backing up data beforehand is recommended if needed.

Remove-Cache -Name [-Port] `
             [-Server] [-Credentials] `
             [-TlsCertPath] [-TlsCertPassword] `
             [-NoLogo]

Examples

This command removes the cache named defaultCache from the local server.

Remove-Cache -Name defaultCache

This command removes the cache named defaultCache from the server node 20.200.20.11.

Remove-Cache -Name defaultCache -Server 20.200.20.11

This command uses a specific port and removes the defaultCache from server 20.200.20.11.

Remove-Cache -Name defaultCache -Server 20.200.20.11 -Port 9803

This command removes defaultCache from the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

Remove-Cache -Name defaultCache -Server 20.200.20.11 `
             -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

This command removes the cache named defaultCache from the local server using security credentials.

Remove-Cache -Name defaultCache -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 already registered cache which needs to 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 server port where the NCache Service is listening.	9803
`-Server`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered.	IP of local machine
`-TlsCertPath`	`<string>`	Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using `New-NCacheTlsCertificate`. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use `-CustomCertificatePath`.	-
`-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.	-
`-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.	-

Remove-Cache

Examples

Properties

Note

Contact Us