Connect-NCXCloud
- 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Connect-NCXCloud
- Updated on 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Connects to Nectar CX cloud and store the credentials for later use.
Syntax
Connect-NCXCloud
-CloudFQDN <String>
-TenantName <String>
-Credential <PSCredential>
-StoredCredentialTarget <String>
Examples
Example 1
$Cred = Get-Credential
Connect-NCX -Credential $cred -CloudFQDN contoso.nectar.services
Connects to the contoso.nectar.services Nectar CX cloud using the credentials supplied to the Get-Credential command
Example 2
Connect-NCX-CloudFQDN contoso.nectar.services -StoredCredentialTarget MyCXCreds
Connects to contoso.nectar.services Nectar CX cloud using previously stored credentials called MyCXCreds
Parameters
-CloudFQDN <String>
The FQDN of the Nectar CX cloud.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| 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
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| 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
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| 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 MyCXCreds -Persist LocalMachine
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?