---
title: "PowerShell"
slug: "powershell"
updated: 2025-05-05T15:15:23Z
published: 2025-05-05T15:15:23Z
canonical: "support.nectarcorp.com/powershell"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PowerShell

## Introduction

The Nectar DXP PowerShell module allows administators greater control over their Nectar DXP environment. Nearly every element available in the UI is available in PowerShell.

## Installation

The Nectar DXP PowerShell module is available via the standard Microsoft [PowerShell Gallery](https://www.powershellgallery.com/packages/Nectar10/). It can be installed either manually or using [**Install-Module**](https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-5.1). If you've previously installed an older version of the Nectar DXP PowerShell module manually, it is recommended to remove the old module before proceeding:

### PowerShell-Based installation

1. Open a PowerShell session
2. Run the following command, accepting any warnings about installing from an untrusted repository:

```powershell
# If you have admin permissions to your workstation
Install-Module Nectar10

# If you do not have admin permissions to your workstation
Install-Module Nectar10 -Scope CurrentUser
```

### Setting the Execution Policy

By default, PowerShell does not allow the execution of 3rd party modules. To allow the Nectar PS module to function, you may have to modify the PowerShell execution policy to allow scripts.

```powershell
# If you have admin permissions
Set-ExecutionPolicy AllSigned

# If you do not have admin permissions
Set-ExecutionPolicy AllSigned -Scope CurrentUser
```

### Manual Installation

If you do not have access to the PowerShell Gallery, you can still install the Nectar DXP module manually.

1. Download the latest version of the Nectar DXP PowerShell module below.

[Nectar10.zip](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/Nectar10.zip?sv=2026-02-06&spr=https&st=2026-11-10T18%3A29%3A19Z&se=2026-11-10T19%3A29%3A19Z&sr=c&sp=r&sig=b2FEDuukdF1QFFhJ%2BeuwbDUs1JzTtDyVVptkmrYmziE%3D)

1. Unblock the file if necessary, by right-clicking the zip file, clicking on **Properties** then clicking **Unblock**.

![image.png](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/image.png?sv=2026-02-06&spr=https&st=2026-11-10T18%3A29%3A19Z&se=2026-11-10T19%3A29%3A19Z&sr=c&sp=r&sig=b2FEDuukdF1QFFhJ%2BeuwbDUs1JzTtDyVVptkmrYmziE%3D) 3. Unzip the contents into a folder called **Nectar10** in the following location:

```powershell
%ProgramFiles%\WindowsPowerShell\Modules
```

## Initial Start-Up

1. Open a PowerShell window.
2. Connect to a Nectar DXP environment by typing:

```powershell
Connect-NectarCloud -CloudFQDN nectarcloud.contoso.com
```

WarningOnly Nectar DXP local credentials are supported for user/password PowerShell access. If you are using SSO, you must use [token-based authentication](/v1/docs/token-authentication).Note

If you receive the error "**The 'Connect-NectarCloud' command was found in the module 'Nectar10', but the module could not be loaded**", you may have to set your PowerShell execution policy to allow remotely signed scripts. To do so, run the following command:

**Set-ExecutionPolicy RemoteSigned**

1. To see a list of available commands, type the following to get started:

```powershell
Get-Command -Module Nectar10
```

1. For help with a specific command, such as **Connect-NectarCloud** type:

```powershell
Get-Help Connect-NectarCloud -Full
```

## Updating

If the Nectar DXP PowerShell module was installed via **Install-Module**, it can be updated by running the following command:

```powershell
Update-Module -Name Nectar10
```

If the module was installed manually, download the latest .ZIP file and overwrite the existing files in **%****ProgramFiles%\WindowsPowerShell\Modules** with the updated versions.

## Removal

If you installed the Nectar DXP PowerShell module via the PowerShell Gallery, uninstall the module by opening a PowerShell session in Administrative mode and type the following:

```powershell
Uninstall-Module Nectar10
```

If you installed the Nectar DXP PowerShell module manually, simply remove the **Nectar10** folder from the following location:

```powershell
%ProgramFiles%\WindowsPowerShell\Modules
```