Connect-NectarCloud
    • 15 May 2023
    • 1 Minute to read
    • Contributors
    • Dark
      Light
    • PDF

    Connect-NectarCloud

    • Dark
      Light
    • PDF

    Article Summary

    Connects to Nectar DXP cloud and store the credentials for later use.

    Syntax

    Connect-NectarCloud 
      -CloudFQDN <String>
      [-TenantName <String>]
      [-Credential <PSCredential>]
      [-StoredCredentialTarget <String>]
      [<CommonParameters>]
    Connect-NectarCloud 
      -CloudFQDN <String>
      [-TenantName <String>]
      -Credential <PSCredential>
      [-StoredCredentialTarget <String>]
      [<CommonParameters>]
    Connect-NectarCloud 
      -CloudFQDN <String>
      [-TenantName <String>]
      [-Credential <PSCredential>]
      -StoredCredentialTarget <String>
      [<CommonParameters>]
    Connect-NectarCloud 
      -EnvFromFile <String>
      [<CommonParameters>]

    Examples

    Example 1

    $Cred = Get-Credential
    Connect-NectarCloud -Credential $cred -CloudFQDN contoso.nectar.services

    Connects to the contoso.nectar.services Nectar DXP cloud using the credentials supplied to the Get-Credential command

    Example 2

    Connect-NectarCloud -CloudFQDN contoso.nectar.services -StoredCredentialTarget MyN10Creds

    Connects to contoso.nectar.services Nectar DXP cloud using previously stored credentials called MyN10Creds

    Parameters

    -CloudFQDN <String>

    The FQDN of the Nectar DXP cloud.

    RequiredFalse
    Position1
    Default valueNone
    Accept pipeline input?True (ByValue)
    Accept wildcard characters?False

       

    -TenantName <String>

    The name of a Nectar DXP cloud tenant to connect to and use for subsequent commands. Only useful for multi-tenant deployments

    RequiredFalse
    Position2
    Default valueNone
    Accept pipeline input?True (ByPropertyName)
    Accept wildcard characters?False


    -Credential <PSCredential>

    The credentials used to access the Nectar DXP UI. Normally in username@domain.com format

    RequiredFalse
    Position3
    Default valueNone
    Accept pipeline input?True (ByPropertyName)
    Accept wildcard characters?False


    -StoredCredentialTarget <String>

    Use stored credentials saved via New-StoredCredential. Requires prior installation of CredentialManager module via Install-Module CredentialManager, and running:        

    Get-Credential | New-StoredCredential -Target MyN10Creds -Persist LocalMachine
    RequiredFalse
    Position4
    Default valueNone
    Accept pipeline input?True (ByPropertyName)
    Accept wildcard characters?False


    -EnvFromFile <String>

    Use a CSV file called N10EnvList.csv located in the user's default Documents folder to show a list of environments to select from. Run the PowerShell command [Environment]::GetFolderPath("MyDocuments") to find your default document folder.

    This parameter is only available if N10EnvList.csv is found in the user's default Documents folder (ie: C:\Users\username\Documents)

    Also sets the default stored credential target to use for the selected environment. Requires prior installation and configuration of CredentialManager PS add-in.

    N10EnvList.csv must have a header with three columns defined as "Environment, DefaultTenant, StoredCredentialTarget"

    Each environment should be on their own separate lines

    RequiredFalse
    Position5
    Default valueNone
    Accept pipeline input?False
    Accept wildcard characters?False

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses