What configuration types can Import-Configuration import?

Import-Configuration supports NCacheService, Security, Bridge, Cache, TLS, and All configuration types.

Can Import-Configuration register a cache with its server-side modules?

Yes. When importing a cache configuration, Import-Configuration can register the exported cache along with its deployed server-side modules.

Can I import a cache without deploying its exported server-side modules?

Yes. Use the DoNotImportModules switch to register the cache without deploying the server-side modules included in the exported configuration.

What is the default port for Import-Configuration?

The default value of the Port parameter is 9800.

Import-Configuration

Q: What does the Import-Configuration cmdlet do?

Import-Configuration applies configurations previously exported using Export-Configuration to an NCache server.

Q: What path should be specified for Import-Configuration?

The Path parameter must point to the export folder generated by the Export-Configuration cmdlet.

The Import-Configuration cmdlet applies configurations previously exported using Export-Configuration to an NCache server. Depending on the specified configuration type, it can register exported caches along with their deployed server-side modules and apply node security, NCache service, TLS, or bridge configurations.

The specified path must point to the export folder generated by the Export-Configuration cmdlet.

Import-Configuration -Path -Type `
                    [-Name] [-Server] `
                    [-Port] [-DoNotImportModules] `
                    [-TlsCertPath] [-TlsCertPassword] `
                    [-Credentials ] [-NoLogo]

Examples

The specified path must point to the export folder generated by the Export-Configuration cmdlet.

This command imports the complete configuration exported from the server 20.200.20.11 on the server 20.200.20.12.

Import-Configuration -Type All -Server 20.200.20.12 `
                     -Path C:\Desktop\config\ncexport-20.200.20.11

This command registers defaultCache along with its deployed server-side modules on the server 20.200.20.12.

Import-Configuration -Type Cache -Name defaultCache `
                     -Server 20.200.20.12 -Path C:\Desktop\config\ncexport-20.200.20.11-defaultCache

This command registers defaultCache on the server 20.200.20.12 without deploying the server-side modules exported with it.

Import-Configuration -Type Cache -Name defaultCache `
                     -Server 20.200.20.12 -Path C:\Desktop\config\ncexport-20.200.20.11-defaultCache `
                     -DoNotImportModules

This command imports all NCache configurations from C:\Desktop\config\ncexport-20.200.20.11 into 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.

Import-Configuration -Type All -Server 20.200.20.12 `
                     -Path C:\Desktop\config\ncexport-20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
                     -TlsCertPassword "clientKeyPassword"

This command applies the exported TLS configuration on the server listening at the specified port.

Import-Configuration -Type TLS -Server 20.200.20.12 `
                     -Port 9802  -Path `C:\Desktop\config\ncexport-20.200.20.11

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters	Data Types	Description	Default Value
`-Path*`	`<String>`	Specifies the path of the directory that holds the configuration exported through Export-Configuration.	-
`-Type*`	`<ConfigurationType>`	Specifies the type of configuration to be imported. Possible values: <br - NCacheService, - Security - Bridge - Cache - TLS - All	All
`-Name`	`<String>`	Specifies the name of the item within the specified type i.e., the name of the cache when the type is Cache and the name of the bridge when the type is Bridge. This parameter is ignored when the type is All.	-
`-Server`	`<String>`	Specifies a server name where the NCache Service is running.	-
`-Port`	`<Integer>`	Specifies the port on which NCache server is listening.	9803
`-DoNotExportModules`	`<SwitchParameter>`	This switch omits the export of the deployed server-side modules, allowing users to export only the configuration files.	False
`-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`.	False
`-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.	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 with the appropriate permissions at the node.	-

Import-Configuration

Examples

Properties

Note

Contact Us