Set up PowerShell Environment

NCache provides integration with Windows PowerShell to easily automate its administrative processes. Moreover, NCache remote tasks can also be managed over the network through a single machine using PowerShell cmdlets.

Windows Environment
Linux Environment

Pre-Requisites

Make sure that you have installed NCache Version 4.8 or above.
NCache PowerShell Provider is only compatible with PowerShell version 4.0 and above.
For Windows Server 2016, make sure that the environment variable PSModulePath has been refreshed before using NCache PowerShell commands.

For more detail on Windows PowerShell please see the Microsoft Windows PowerShell section.

NCache PowerShell Management

Go to Start menu on the Taskbar and type NCache PowerShell Management.
Click on the search result. This will open an instance of PowerShell with ncacheps imported, and display a list of all NCache PowerShell cmdlets.

Standard PowerShell

You must launch a new/fresh instance of Windows PowerShell so %NCHOME%environment variable setup by NCache installation is visible. PowerShell cmdlets make use of this environment variable.

Go to Start menu on the Taskbar and type Windows PowerShell.
Right-click on the Windows PowerShell result and select Run as Administrator. This launches PowerShell with Administrator privileges.
Verify that environment variable $Env:NCHOME is pointing to NCache installation directory.

PS C:\WINDOWS\system32> $Env:NCHOME
C:\Program Files\NCache

Import NCache PowerShell Module

You may be unable to run NCache PowerShell cmdlets if the environment variable PSModulePath has not been refreshed after the installation. Import the NCache PowerShell module (ncacheps.dll) found in the location %NCHOME%\bin\tools\ncacheps.

Execute the following command on Windows PowerShell to import the module:

Import-Module 'C:\Program Files\NCache\bin\tools\ncacheps\ncacheps.dll'

In order to verify if the environment variable PSModulePath has been refreshed successfully, run the following command using Command Prompt (Run as Administrator).

echo %PSModulePath%

On running the following command, the path for ncacheps gets displayed. If the output displays %NCHOME%\bin\tools it means that the environment variables are refreshed.

When to Run PowerShell as Administrator

You need to run PowerShell as Administrator while performing the following operations:

Restarting NCache Service,
Running any custom scripts which use NCache cmdlets.

Run Custom Scripts

If you wish to create and execute PowerShell scripts using cmdlets:

Search for Windows PowerShell and Run as Administrator
Set script execution policy to RemoteSigned to allow remote execution:

Set-ExecutionPolicy RemoteSigned

List NCache PowerShell Cmdlets

In order to get a list of all the supported functionalities of NCache for PowerShell, execute the following command on Windows PowerShell:

Get-Command –Module ncacheps

Get Help for PowerShell cmdlets

In order to get complete help for any particular cmdlet, execute the following command on Windows PowerShell.

Get-Help <CmdletName> –Full

Following example shows how to get complete help for Get-Caches.

Get-Help Get-Caches –Full

Pre-Requisites

Make sure that you have installed NCache Core Version 4.9 or above.
NCache PowerShell Core Provider is only compatible with PowerShell Core version 6.2 and above.

For more detail on Windows PowerShell please see the Microsoft PowerShell for Linux section.

Launch PowerShell

From a terminal of your choice, launch PowerShell by typing the following command:

> pwsh

A PS at the start of the new line in your terminal will indicate PowerShell has been launched.

Import NCache PowerShell Module

Linux requires to import the NCache module so that NCache tools can be executed.

Note

NCache is installed by default in /opt/ncache/ in Linux.

PS > Import-Module /opt/ncache/bin/tools/ncacheps/

Troubleshooting

Unable to Run NCache PowerShell Cmdlets (For Windows Environment)

This occurs if the environment variable PSModulePath has not been refreshed after the installation. Import the NCache PowerShell module (ncacheps.dll) found in the location %NCHOME%\bin\tools\ncacheps.

Execute the following command on Windows PowerShell to import the module:

Import-Module 'C:\Program Files\NCache\bin\tools\ncacheps\ncacheps.dll'

In order to verify if the environment variable PSModulePath has been refreshed successfully, run the following command using Command Prompt (Run as Administrator).

echo %PSModulePath%

On running the following command, the path for ncacheps gets displayed. If the output displays %NCHOME%\bin\tools it means that the environment variables are refreshed.