Enable-AutoStartCache

The Enable-AutoStartCache PowerShell cmdlet enables Auto Start for one or more caches. When Auto Start is enabled, the cache starts automatically whenever the machine hosting the NCache Service is started. If credentials are provided, they are stored in encrypted form in the NCache service configuration. These stored credentials are used to start secured caches automatically with the NCache Service.

Enable-AutoStartCache [-CacheName] `
                      [-Server] [-TlsCertPath] `
                      [-TlsCertPassword] [-Credentials]

Examples

• This command enables Auto Start for defaultCache on the local server.

Enable-AutoStartCache -CacheName defaultCache

• This command enables Auto Start for defaultCache and ClusteredCache by specifying both cache names as a comma-separated value.

Enable-AutoStartCache -CacheName "ClusteredCache,defaultCache"

• This command enables automatic startup for defaultCache on the specified server with mutual TLS (mTLS) enabled, using the provided security credentials.. 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.

Enable-AutoStartCache -CacheName defaultCache -Server 20.200.20.11 `
                      -Credentials(Get-Credential john_smith) -TlsCertPath "C:\certs\client.pem" `
                      -TlsCertPassword "clientKeyPassword" 

• This command enables Auto Start for defaultCache on the server 20.200.20.11 using security credentials.

Enable-AutoStartCache -CacheName defaultCache -Server 20.200.20.11 `
                      -Credentials(Get-Credential john_smith)

The specified credentials are used for authentication and stored in encrypted form in the NCache service configuration. These stored credentials are used to start the secured cache automatically when the NCache Service starts.

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 Auto Start should be configured. To enable Auto Start for multiple caches, specify comma-separated cache names.	-
-Server	<String>	Specifies the IP address of the server where the target cache is hosted.	IP of local machine
-Credentials	<pscredential>	Specifies the user credentials required to authorize the operation. When provided, these credentials are stored in encrypted form in the NCache service configuration and used to start the configured caches automatically.	-
-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.	-