What does Disable-AutoStartCache do?

Disable-AutoStartCache disables Auto Start for a specified cache so that the cache does not start automatically when the machine hosting the NCache Service starts.

Can Disable-AutoStartCache disable Auto Start for multiple caches?

Yes. Multiple cache names can be specified as a comma-separated value using the CacheName parameter.

What server does Disable-AutoStartCache use by default?

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

Disable-AutoStartCache

The Disable-AutoStartCache PowerShell cmdlet disables Auto Start for a specified cache. When Auto Start is disabled, the cache does not start automatically when the machine hosting the NCache Service starts.

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

Examples

This command disables Auto Start for the cache named defaultCache on the local server. The cache no longer starts automatically when the machine hosting the NCache Service starts.

Disable-AutoStartCache -CacheName defaultCache

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

Disable-AutoStartCache -CacheName "ClusteredCache,defaultCache"

This command disables 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.

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

This command disables Auto Start for the cache named defaultCache on the remote server 20.200.20.11 using the specified credentials for authentication.

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

Properties

Note

The parameters with asterisk (*) on their names are 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 disabled.	-
`-Server`	`<String>`	Specifies the IP address of the server where the target cache is hosted.	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 disabling Auto Start on the specified server.	-

Disable-AutoStartCache

Examples

Properties

Note

Contact Us